From 08c7da4446109a440e0263266cc173db4a6d85cb Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Thu, 21 Nov 2019 13:22:09 +0100 Subject: [PATCH 001/125] Implementing file import and export scripts --- .../org/dspace/app/bulkedit/DSpaceCSV.java | 11 + .../dspace/app/bulkedit/MetadataExport.java | 290 +-- .../dspace/app/bulkedit/MetadataImport.java | 1862 ++++++++++------- .../content/MetadataExportServiceImpl.java | 130 ++ .../service/MetadataExportService.java | 26 + .../org/dspace/scripts/DSpaceRunnable.java | 16 + .../dspace/scripts/ProcessServiceImpl.java | 59 + .../handler/DSpaceRunnableHandler.java | 9 + .../CommandLineDSpaceRunnableHandler.java | 22 + .../scripts/service/ProcessService.java | 11 + .../app/rest/ScriptProcessesController.java | 9 +- .../DSpaceApiExceptionControllerAdvice.java | 5 +- .../rest/repository/ScriptRestRepository.java | 41 +- .../impl/RestDSpaceRunnableHandler.java | 37 +- dspace/config/spring/rest/scripts.xml | 9 + 15 files changed, 1501 insertions(+), 1036 deletions(-) create mode 100644 dspace-api/src/main/java/org/dspace/content/MetadataExportServiceImpl.java create mode 100644 dspace-api/src/main/java/org/dspace/content/service/MetadataExportService.java create mode 100644 dspace/config/spring/rest/scripts.xml diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/DSpaceCSV.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/DSpaceCSV.java index ea95be7e72..98f343c96f 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/DSpaceCSV.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/DSpaceCSV.java @@ -13,6 +13,7 @@ import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.IOException; +import java.io.InputStream; import java.io.InputStreamReader; import java.io.OutputStreamWriter; import java.io.Serializable; @@ -27,7 +28,9 @@ import java.util.UUID; import java.util.regex.Matcher; import java.util.regex.Pattern; +import org.apache.commons.io.IOUtils; import org.apache.commons.lang3.StringUtils; +import org.apache.pdfbox.util.Charsets; import org.dspace.authority.AuthorityValue; import org.dspace.authority.factory.AuthorityServiceFactory; import org.dspace.authority.service.AuthorityValueService; @@ -637,6 +640,14 @@ public class DSpaceCSV implements Serializable { out.close(); } + public InputStream getInputStream() { + StringBuilder stringBuilder = new StringBuilder(); + for (String csvLine : getCSVLinesAsStringArray()) { + stringBuilder.append(csvLine + "\n"); + } + return IOUtils.toInputStream(stringBuilder.toString(), Charsets.UTF_8); + } + /** * Is it Ok to export this value? When exportAll is set to false, we don't export * some of the metadata elements. diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java index bc015ef5e0..f47e79d0ee 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java @@ -7,272 +7,84 @@ */ package org.dspace.app.bulkedit; -import java.sql.SQLException; -import java.util.ArrayList; -import java.util.Iterator; -import java.util.List; - -import com.google.common.collect.Iterators; -import org.apache.commons.cli.CommandLine; -import org.apache.commons.cli.CommandLineParser; -import org.apache.commons.cli.HelpFormatter; import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; -import org.apache.commons.cli.PosixParser; -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.ItemService; -import org.dspace.core.Constants; +import org.dspace.app.bulkedit.DSpaceCSV; +import org.dspace.content.service.MetadataExportService; import org.dspace.core.Context; -import org.dspace.handle.factory.HandleServiceFactory; +import org.dspace.scripts.DSpaceRunnable; +import org.springframework.beans.factory.annotation.Autowired; /** * Metadata exporter to allow the batch export of metadata into a file * * @author Stuart Lewis */ -public class MetadataExport { - /** - * The items to export - */ - protected Iterator toExport; +public class MetadataExport extends DSpaceRunnable { - protected ItemService itemService; + private Context c = null; + private boolean help = false; + private String filename = null; + private String handle = null; + private boolean exportAllMetadata = false; + private boolean exportAllItems = false; + + @Autowired + private MetadataExportService metadataExportService; protected Context context; - /** - * Whether to export all metadata, or just normally edited metadata - */ - protected boolean exportAll; - - protected MetadataExport() { - itemService = ContentServiceFactory.getInstance().getItemService(); + private MetadataExport() { + Options options = constructOptions(); + this.options = options; } - /** - * Set up a new metadata export - * - * @param c The Context - * @param toExport The ItemIterator of items to export - * @param exportAll whether to export all metadata or not (include handle, provenance etc) - */ - public MetadataExport(Context c, Iterator toExport, boolean exportAll) { - itemService = ContentServiceFactory.getInstance().getItemService(); - - // Store the export settings - this.toExport = toExport; - this.exportAll = exportAll; - this.context = c; - } - - /** - * Method to export a community (and sub-communities and collections) - * - * @param c The Context - * @param toExport The Community to export - * @param exportAll whether to export all metadata or not (include handle, provenance etc) - */ - public MetadataExport(Context c, Community toExport, boolean exportAll) { - itemService = ContentServiceFactory.getInstance().getItemService(); - - try { - // Try to export the community - this.toExport = buildFromCommunity(c, toExport, 0); - this.exportAll = exportAll; - this.context = c; - } catch (SQLException sqle) { - // Something went wrong... - System.err.println("Error running exporter:"); - sqle.printStackTrace(System.err); - System.exit(1); - } - } - - /** - * Build an array list of item ids that are in a community (include sub-communities and collections) - * - * @param context DSpace context - * @param community The community to build from - * @param indent How many spaces to use when writing out the names of items added - * @return The list of item ids - * @throws SQLException if database error - */ - protected Iterator buildFromCommunity(Context context, Community community, int indent) - throws SQLException { - // Add all the collections - List collections = community.getCollections(); - Iterator result = null; - for (Collection collection : collections) { - for (int i = 0; i < indent; i++) { - System.out.print(" "); - } - - Iterator items = itemService.findByCollection(context, collection); - result = addItemsToResult(result, items); - - } - // Add all the sub-communities - List communities = community.getSubcommunities(); - for (Community subCommunity : communities) { - for (int i = 0; i < indent; i++) { - System.out.print(" "); - } - Iterator items = buildFromCommunity(context, subCommunity, indent + 1); - result = addItemsToResult(result, items); - } - - return result; - } - - private Iterator addItemsToResult(Iterator result, Iterator items) { - if (result == null) { - result = items; - } else { - result = Iterators.concat(result, items); - } - - return result; - } - - /** - * Run the export - * - * @return the exported CSV lines - */ - public DSpaceCSV export() { - try { - Context.Mode originalMode = context.getCurrentMode(); - context.setMode(Context.Mode.READ_ONLY); - - // Process each item - DSpaceCSV csv = new DSpaceCSV(exportAll); - while (toExport.hasNext()) { - Item item = toExport.next(); - csv.addItem(item); - context.uncacheEntity(item); - } - - context.setMode(originalMode); - // Return the results - return csv; - } catch (Exception e) { - // Something went wrong... - System.err.println("Error exporting to CSV:"); - e.printStackTrace(); - return null; - } - } - - /** - * Print the help message - * - * @param options The command line options the user gave - * @param exitCode the system exit code to use - */ - private static void printHelp(Options options, int exitCode) { - // print the help message - HelpFormatter myhelp = new HelpFormatter(); - myhelp.printHelp("MetadataExport\n", options); - System.out.println("\nfull export: metadataexport -f filename"); - System.out.println("partial export: metadataexport -i handle -f filename"); - System.exit(exitCode); - } - - /** - * main method to run the metadata exporter - * - * @param argv the command line arguments given - * @throws Exception if error occurs - */ - public static void main(String[] argv) throws Exception { - // Create an options object and populate it - CommandLineParser parser = new PosixParser(); - + private Options constructOptions() { Options options = new Options(); options.addOption("i", "id", true, "ID or handle of thing to export (item, collection, or community)"); options.addOption("f", "file", true, "destination where you want file written"); + options.getOption("f").setRequired(true); options.addOption("a", "all", false, "include all metadata fields that are not normally changed (e.g. provenance)"); options.addOption("h", "help", false, "help"); - CommandLine line = null; + return options; + } - try { - line = parser.parse(options, argv); - } catch (ParseException pe) { - System.err.println("Error with commands."); - printHelp(options, 1); - System.exit(0); + public void internalRun() throws Exception { + if (help) { + handler.logInfo("\nfull export: metadataexport -f filename"); + handler.logInfo("partial export: metadataexport -i handle -f filename"); + printHelp(); + return; } - if (line.hasOption('h')) { - printHelp(options, 0); - } - - // Check a filename is given - if (!line.hasOption('f')) { - System.err.println("Required parameter -f missing!"); - printHelp(options, 1); - } - String filename = line.getOptionValue('f'); - - // Create a context - Context c = new Context(Context.Mode.READ_ONLY); - c.turnOffAuthorisationSystem(); - - // The things we'll export - Iterator toExport = null; - MetadataExport exporter = null; - - // Export everything? - boolean exportAll = line.hasOption('a'); - - ContentServiceFactory contentServiceFactory = ContentServiceFactory.getInstance(); - // Check we have an item OK - ItemService itemService = contentServiceFactory.getItemService(); - if (!line.hasOption('i')) { - System.out.println("Exporting whole repository WARNING: May take some time!"); - exporter = new MetadataExport(c, itemService.findAll(c), exportAll); - } else { - String handle = line.getOptionValue('i'); - DSpaceObject dso = HandleServiceFactory.getInstance().getHandleService().resolveToObject(c, handle); - if (dso == null) { - System.err.println("Item '" + handle + "' does not resolve to an item in your repository!"); - printHelp(options, 1); - } - - if (dso.getType() == Constants.ITEM) { - System.out.println("Exporting item '" + dso.getName() + "' (" + handle + ")"); - List item = new ArrayList<>(); - item.add((Item) dso); - exporter = new MetadataExport(c, item.iterator(), exportAll); - } else if (dso.getType() == Constants.COLLECTION) { - System.out.println("Exporting collection '" + dso.getName() + "' (" + handle + ")"); - Collection collection = (Collection) dso; - toExport = itemService.findByCollection(c, collection); - exporter = new MetadataExport(c, toExport, exportAll); - } else if (dso.getType() == Constants.COMMUNITY) { - System.out.println("Exporting community '" + dso.getName() + "' (" + handle + ")"); - exporter = new MetadataExport(c, (Community) dso, exportAll); - } else { - System.err.println("Error identifying '" + handle + "'"); - System.exit(1); - } - } - - // Perform the export - DSpaceCSV csv = exporter.export(); - - // Save the files to the file - csv.save(filename); - - // Finish off and tidy up + DSpaceCSV dSpaceCSV = metadataExportService.handleExport(c, exportAllItems, exportAllMetadata, handle); + handler.writeFilestream(c, filename, dSpaceCSV.getInputStream(), "exportCSV"); c.restoreAuthSystemState(); c.complete(); } + + public void setup() throws ParseException { + c = new Context(); + c.turnOffAuthorisationSystem(); + + if (commandLine.hasOption('h')) { + help = true; + } + + // Check a filename is given + if (!commandLine.hasOption('f')) { + throw new ParseException("Required parameter -f missing!"); + } + filename = commandLine.getOptionValue('f'); + + exportAllMetadata = commandLine.hasOption('a'); + + if (commandLine.hasOption('i')) { + exportAllItems = true; + } + handle = commandLine.getOptionValue('i'); + } } diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java index e1b1224809..02db493be2 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java @@ -7,36 +7,32 @@ */ package org.dspace.app.bulkedit; -import java.io.BufferedReader; -import java.io.File; import java.io.IOException; -import java.io.InputStreamReader; +import java.io.InputStream; import java.sql.SQLException; import java.util.ArrayList; import java.util.Enumeration; +import java.util.HashMap; import java.util.HashSet; -import java.util.LinkedList; +import java.util.Iterator; import java.util.List; +import java.util.Map; import java.util.Set; import java.util.UUID; +import javax.annotation.Nullable; -import org.apache.commons.cli.CommandLine; -import org.apache.commons.cli.CommandLineParser; -import org.apache.commons.cli.HelpFormatter; import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; -import org.apache.commons.cli.PosixParser; import org.apache.commons.lang3.StringUtils; import org.apache.logging.log4j.Logger; import org.dspace.authority.AuthorityValue; -import org.dspace.authority.factory.AuthorityServiceFactory; import org.dspace.authority.service.AuthorityValueService; import org.dspace.authorize.AuthorizeException; import org.dspace.content.Collection; import org.dspace.content.DSpaceObject; import org.dspace.content.Entity; -import org.dspace.content.EntityType; import org.dspace.content.Item; +import org.dspace.content.MetadataField; import org.dspace.content.MetadataSchemaEnum; import org.dspace.content.MetadataValue; import org.dspace.content.Relationship; @@ -49,6 +45,8 @@ import org.dspace.content.service.EntityService; import org.dspace.content.service.EntityTypeService; import org.dspace.content.service.InstallItemService; import org.dspace.content.service.ItemService; +import org.dspace.content.service.MetadataFieldService; +import org.dspace.content.service.MetadataValueService; import org.dspace.content.service.RelationshipService; import org.dspace.content.service.RelationshipTypeService; import org.dspace.content.service.WorkspaceItemService; @@ -58,64 +56,115 @@ import org.dspace.core.Context; import org.dspace.core.LogManager; import org.dspace.eperson.EPerson; import org.dspace.eperson.factory.EPersonServiceFactory; -import org.dspace.handle.factory.HandleServiceFactory; import org.dspace.handle.service.HandleService; -import org.dspace.util.UUIDUtils; +import org.dspace.scripts.DSpaceRunnable; +import org.dspace.workflow.WorkflowException; import org.dspace.workflow.WorkflowItem; import org.dspace.workflow.WorkflowService; import org.dspace.workflow.factory.WorkflowServiceFactory; +import org.springframework.beans.factory.InitializingBean; +import org.springframework.beans.factory.annotation.Autowired; -/** - * Metadata importer to allow the batch import of metadata from a file - * - * @author Stuart Lewis - */ -public class MetadataImport { - /** - * The Context - */ - Context c; +public class MetadataImport extends DSpaceRunnable implements InitializingBean { - /** - * The DSpaceCSV object we're processing - */ - DSpaceCSV csv; + private static final Logger log = org.apache.logging.log4j.LogManager.getLogger(MetadataImport.class); - /** - * The lines to import - */ - List toImport; /** * The authority controlled fields */ - protected static Set authorityControlled; + protected Set authorityControlled; - static { - setAuthorizedMetadataFields(); - } + @Autowired + protected ItemService itemService; + @Autowired + protected InstallItemService installItemService; + @Autowired + protected CollectionService collectionService; + @Autowired + protected HandleService handleService; + @Autowired + protected WorkspaceItemService workspaceItemService; + @Autowired + protected RelationshipTypeService relationshipTypeService; + @Autowired + protected RelationshipService relationshipService; + @Autowired + protected EntityTypeService entityTypeService; + @Autowired + protected EntityService entityService; + @Autowired + protected AuthorityValueService authorityValueService; /** * The prefix of the authority controlled field */ - protected static final String AC_PREFIX = "authority.controlled."; + protected final String AC_PREFIX = "authority.controlled."; + + + private boolean useTemplate = false; + private String filename = null; + private boolean useWorkflow = false; + private boolean workflowNotify = false; + private boolean change = false; /** - * Logger + * The Context */ - protected static final Logger log = org.apache.logging.log4j.LogManager.getLogger(MetadataImport.class); + private Context c; - protected final AuthorityValueService authorityValueService; + /** + * The DSpaceCSV object we're processing + */ + private DSpaceCSV csv; - protected final ItemService itemService; - protected final InstallItemService installItemService; - protected final CollectionService collectionService; - protected final HandleService handleService; - protected final WorkspaceItemService workspaceItemService; - protected final RelationshipTypeService relationshipTypeService; - protected final RelationshipService relationshipService; - protected final EntityTypeService entityTypeService; - protected final EntityService entityService; + /** + * The lines to import + */ + private List toImport; + + private boolean help = false; + + /** + * Map of field:value to csv row number, used to resolve indirect entity target references. + * + * @see #populateRefAndRowMap(DSpaceCSVLine, UUID) + */ + protected Map> csvRefMap = new HashMap<>(); + + /** + * Map of csv row number to UUID, used to resolve indirect entity target references. + * + * @see #populateRefAndRowMap(DSpaceCSVLine, UUID) + */ + protected HashMap csvRowMap = new HashMap<>(); + + /** + * Map of UUIDs to their entity types. + * + * @see #populateRefAndRowMap(DSpaceCSVLine, UUID) + */ + protected static HashMap entityTypeMap = new HashMap<>(); + + /** + * Map of UUIDs to their relations that are referenced within any import with their referers. + * + * @see #populateEntityRelationMap(String, String, String) + */ + protected static HashMap>> entityRelationMap = new HashMap<>(); + + + /** + * Collection of errors generated during relation validation process. + */ + protected ArrayList relationValidationErrors = new ArrayList<>(); + + /** + * Counter of rows proccssed in a CSV. + */ + protected Integer rowCount = 1; + + protected boolean validateOnly; /** * Create an instance of the metadata importer. Requires a context and an array of CSV lines @@ -124,21 +173,368 @@ public class MetadataImport { * @param c The context * @param toImport An array of CSV lines to examine */ - public MetadataImport(Context c, DSpaceCSV toImport) { + public void initMetadataImport(Context c, DSpaceCSV toImport) { // Store the import settings this.c = c; csv = toImport; this.toImport = toImport.getCSVLines(); - installItemService = ContentServiceFactory.getInstance().getInstallItemService(); - itemService = ContentServiceFactory.getInstance().getItemService(); - collectionService = ContentServiceFactory.getInstance().getCollectionService(); - handleService = HandleServiceFactory.getInstance().getHandleService(); - authorityValueService = AuthorityServiceFactory.getInstance().getAuthorityValueService(); - workspaceItemService = ContentServiceFactory.getInstance().getWorkspaceItemService(); - relationshipService = ContentServiceFactory.getInstance().getRelationshipService(); - relationshipTypeService = ContentServiceFactory.getInstance().getRelationshipTypeService(); - entityTypeService = ContentServiceFactory.getInstance().getEntityTypeService(); - entityService = ContentServiceFactory.getInstance().getEntityService(); + } + + @Override + public void internalRun() throws Exception { + if (help) { + printHelp(); + return; + } + // Read commandLines from the CSV file + try { + + csv = new DSpaceCSV(handler.getFileStream(c, filename), c); + } catch (MetadataImportInvalidHeadingException miihe) { + throw miihe; + } catch (Exception e) { + throw new Exception("Error reading file: " + e.getMessage(), e); + } + + // Perform the first import - just highlight differences + initMetadataImport(c, csv); + List changes; + + if (!commandLine.hasOption('s') || validateOnly) { + // See what has changed + try { + changes = runImport(false, useWorkflow, workflowNotify, useTemplate); + } catch (MetadataImportException mie) { + throw mie; + } + + // Display the changes + int changeCounter = displayChanges(changes, false); + + // If there were changes, ask if we should execute them + if (!validateOnly && changeCounter > 0) { + try { + // Ask the user if they want to make the changes + handler.logInfo("\n" + changeCounter + " item(s) will be changed\n"); + change = handler.getUserValidation(); + + } catch (IOException ioe) { + throw new IOException("Error: " + ioe.getMessage() + ", No changes have been made", ioe); + } + } else { + handler.logInfo("There were no changes detected"); + } + } else { + change = true; + } + + try { + // If required, make the change + if (change && !validateOnly) { + try { + // Make the changes + changes = runImport(true, useWorkflow, workflowNotify, useTemplate); + } catch (MetadataImportException mie) { + throw mie; + } + + // Display the changes + displayChanges(changes, true); + } + + // Finsh off and tidy up + c.restoreAuthSystemState(); + c.complete(); + } catch (Exception e) { + c.abort(); + throw new Exception( + "Error committing changes to database: " + e.getMessage() + ", aborting most recent changes", e); + } + + } + + public void setup() throws ParseException { + useTemplate = false; + filename = null; + useWorkflow = false; + workflowNotify = false; + + if (commandLine.hasOption('h')) { + help = true; + } + + // Check a filename is given + if (!commandLine.hasOption('f')) { + throw new ParseException("Required parameter -f missing!"); + } + filename = commandLine.getOptionValue('f'); + + // Option to apply template to new items + if (commandLine.hasOption('t')) { + useTemplate = true; + } + + // Options for workflows, and workflow notifications for new items + if (commandLine.hasOption('w')) { + useWorkflow = true; + if (commandLine.hasOption('n')) { + workflowNotify = true; + } + } else if (commandLine.hasOption('n')) { + throw new ParseException( + "Invalid option 'n': (notify) can only be specified with the 'w' (workflow) option."); + } + validateOnly = commandLine.hasOption('v'); + + + // Create a context + try { + c = new Context(); + c.turnOffAuthorisationSystem(); + } catch (Exception e) { + throw new ParseException("Unable to create a new DSpace Context: " + e.getMessage()); + } + + // Find the EPerson, assign to context + try { + if (commandLine.hasOption('e')) { + EPerson eperson; + String e = commandLine.getOptionValue('e'); + if (e.indexOf('@') != -1) { + eperson = EPersonServiceFactory.getInstance().getEPersonService().findByEmail(c, e); + } else { + eperson = EPersonServiceFactory.getInstance().getEPersonService().find(c, UUID.fromString(e)); + } + + if (eperson == null) { + throw new ParseException("Error, eperson cannot be found: " + e); + } + c.setCurrentUser(eperson); + } + } catch (Exception e) { + throw new ParseException("Unable to find DSpace user: " + e.getMessage()); + } + + // Is this a silent run? + change = false; + } + + private MetadataImport() { + Options options = constructOptions(); + this.options = options; + } + + private Options constructOptions() { + Options options = new Options(); + + options.addOption("f", "file", true, "source file"); + options.getOption("f").setType(InputStream.class); + options.getOption("f").setRequired(true); + options.addOption("e", "email", true, "email address or user id of user (required if adding new items)"); + options.getOption("e").setType(String.class); + options.getOption("e").setRequired(true); + options.addOption("s", "silent", false, + "silent operation - doesn't request confirmation of changes USE WITH CAUTION"); + options.getOption("s").setType(boolean.class); + options.addOption("w", "workflow", false, "workflow - when adding new items, use collection workflow"); + options.getOption("w").setType(boolean.class); + options.addOption("n", "notify", false, + "notify - when adding new items using a workflow, send notification emails"); + options.getOption("n").setType(boolean.class); + options.addOption("v", "validate-only", false, + "validate - just validate the csv, don't run the import"); + options.getOption("v").setType(boolean.class); + options.addOption("t", "template", false, + "template - when adding new items, use the collection template (if it exists)"); + options.getOption("t").setType(boolean.class); + options.addOption("h", "help", false, "help"); + options.getOption("h").setType(boolean.class); + + return options; + } + + /** + * Display the changes that have been detected, or that have been made + * + * @param changes The changes detected + * @param changed Whether or not the changes have been made + * @return The number of items that have changed + */ + private int displayChanges(List changes, boolean changed) { + // Display the changes + int changeCounter = 0; + for (BulkEditChange change : changes) { + // Get the changes + List adds = change.getAdds(); + List removes = change.getRemoves(); + List newCollections = change.getNewMappedCollections(); + List oldCollections = change.getOldMappedCollections(); + if ((adds.size() > 0) || (removes.size() > 0) || + (newCollections.size() > 0) || (oldCollections.size() > 0) || + (change.getNewOwningCollection() != null) || (change.getOldOwningCollection() != null) || + (change.isDeleted()) || (change.isWithdrawn()) || (change.isReinstated())) { + // Show the item + Item i = change.getItem(); + + handler.logInfo("-----------------------------------------------------------"); + if (!change.isNewItem()) { + handler.logInfo("Changes for item: " + i.getID() + " (" + i.getHandle() + ")"); + } else { + handler.logInfo("New item: "); + if (i != null) { + if (i.getHandle() != null) { + handler.logInfo(i.getID() + " (" + i.getHandle() + ")"); + } else { + handler.logInfo(i.getID() + " (in workflow)"); + } + } + } + changeCounter++; + } + + // Show actions + if (change.isDeleted()) { + if (changed) { + handler.logInfo(" - EXPUNGED!"); + } else { + handler.logInfo(" - EXPUNGE!"); + } + } + if (change.isWithdrawn()) { + if (changed) { + handler.logInfo(" - WITHDRAWN!"); + } else { + handler.logInfo(" - WITHDRAW!"); + } + } + if (change.isReinstated()) { + if (changed) { + handler.logInfo(" - REINSTATED!"); + } else { + handler.logInfo(" - REINSTATE!"); + } + } + + if (change.getNewOwningCollection() != null) { + Collection c = change.getNewOwningCollection(); + if (c != null) { + String cHandle = c.getHandle(); + String cName = c.getName(); + if (!changed) { + handler.logInfo(" + New owning collection (" + cHandle + "): "); + } else { + handler.logInfo(" + New owning collection (" + cHandle + "): "); + } + handler.logInfo(cName); + } + + c = change.getOldOwningCollection(); + if (c != null) { + String cHandle = c.getHandle(); + String cName = c.getName(); + if (!changed) { + handler.logInfo(" + Old owning collection (" + cHandle + "): "); + } else { + handler.logInfo(" + Old owning collection (" + cHandle + "): "); + } + handler.logInfo(cName); + } + } + + // Show new mapped collections + for (Collection c : newCollections) { + String cHandle = c.getHandle(); + String cName = c.getName(); + if (!changed) { + handler.logInfo(" + Map to collection (" + cHandle + "): "); + } else { + handler.logInfo(" + Mapped to collection (" + cHandle + "): "); + } + handler.logInfo(cName); + } + + // Show old mapped collections + for (Collection c : oldCollections) { + String cHandle = c.getHandle(); + String cName = c.getName(); + if (!changed) { + handler.logInfo(" + Un-map from collection (" + cHandle + "): "); + } else { + handler.logInfo(" + Un-mapped from collection (" + cHandle + "): "); + } + handler.logInfo(cName); + } + + // Show additions + for (BulkEditMetadataValue metadataValue : adds) { + String md = metadataValue.getSchema() + "." + metadataValue.getElement(); + if (metadataValue.getQualifier() != null) { + md += "." + metadataValue.getQualifier(); + } + if (metadataValue.getLanguage() != null) { + md += "[" + metadataValue.getLanguage() + "]"; + } + if (!changed) { + handler.logInfo(" + Add (" + md + "): "); + } else { + handler.logInfo(" + Added (" + md + "): "); + } + handler.logInfo(metadataValue.getValue()); + if (isAuthorityControlledField(md)) { + handler.logInfo(", authority = " + metadataValue.getAuthority()); + handler.logInfo(", confidence = " + metadataValue.getConfidence()); + } + handler.logInfo(""); + } + + // Show removals + for (BulkEditMetadataValue metadataValue : removes) { + String md = metadataValue.getSchema() + "." + metadataValue.getElement(); + if (metadataValue.getQualifier() != null) { + md += "." + metadataValue.getQualifier(); + } + if (metadataValue.getLanguage() != null) { + md += "[" + metadataValue.getLanguage() + "]"; + } + if (!changed) { + handler.logInfo(" - Remove (" + md + "): "); + } else { + handler.logInfo(" - Removed (" + md + "): "); + } + handler.logInfo(metadataValue.getValue()); + if (isAuthorityControlledField(md)) { + handler.logInfo(", authority = " + metadataValue.getAuthority()); + handler.logInfo(", confidence = " + metadataValue.getConfidence()); + } + handler.logInfo(""); + } + } + return changeCounter; + } + + /** + * is the field is defined as authority controlled + */ + private boolean isAuthorityControlledField(String md) { + String mdf = StringUtils.substringAfter(md, ":"); + mdf = StringUtils.substringBefore(mdf, "["); + return authorityControlled.contains(mdf); + } + + + /** + * Set authority controlled fields + */ + private void setAuthorizedMetadataFields() { + authorityControlled = new HashSet(); + Enumeration propertyNames = ConfigurationManager.getProperties().propertyNames(); + while (propertyNames.hasMoreElements()) { + String key = ((String) propertyNames.nextElement()).trim(); + if (key.startsWith(AC_PREFIX) + && ConfigurationManager.getBooleanProperty(key, false)) { + authorityControlled.add(key.substring(AC_PREFIX.length())); + } + } } /** @@ -155,7 +551,8 @@ public class MetadataImport { public List runImport(boolean change, boolean useWorkflow, boolean workflowNotify, - boolean useTemplate) throws MetadataImportException { + boolean useTemplate) + throws MetadataImportException, SQLException, AuthorizeException, WorkflowException, IOException { // Store the changes ArrayList changes = new ArrayList(); @@ -165,7 +562,11 @@ public class MetadataImport { c.setMode(Context.Mode.BATCH_EDIT); // Process each change + rowCount = 1; for (DSpaceCSVLine line : toImport) { + // Resolve target references to other items + populateRefAndRowMap(line, line.getID()); + line = resolveEntityRefs(line); // Get the DSpace item to compare with UUID id = line.getID(); @@ -178,7 +579,7 @@ public class MetadataImport { WorkflowItem wfItem = null; Item item = null; - // Is this a new item? + // Is this an existing item? if (id != null) { // Get the item item = itemService.find(c, id); @@ -215,9 +616,8 @@ public class MetadataImport { } } } - // Compare - compare(item, fromCSV, change, md, whatHasChanged, line); + compareAndUpdate(item, fromCSV, change, md, whatHasChanged, line); } } @@ -278,7 +678,7 @@ public class MetadataImport { BulkEditChange whatHasChanged = new BulkEditChange(); for (String md : line.keys()) { // Get the values we already have - if (!"id".equals(md)) { + if (!"id".equals(md) && !"rowName".equals(md)) { // Get the values from the CSV String[] fromCSV = line.get(md).toArray(new String[line.get(md).size()]); @@ -355,30 +755,23 @@ public class MetadataImport { item = wsItem.getItem(); // Add the metadata to the item - List relationships = new LinkedList<>(); + for (BulkEditMetadataValue dcv : whatHasChanged.getAdds()) { + itemService.addMetadata(c, item, dcv.getSchema(), + dcv.getElement(), + dcv.getQualifier(), + dcv.getLanguage(), + dcv.getValue(), + dcv.getAuthority(), + dcv.getConfidence()); + } + //Add relations after all metadata has been processed for (BulkEditMetadataValue dcv : whatHasChanged.getAdds()) { if (StringUtils.equals(dcv.getSchema(), MetadataSchemaEnum.RELATION.getName())) { - - if (!StringUtils.equals(dcv.getElement(), "type")) { - relationships.add(dcv); - } else { - handleRelationshipMetadataValueFromBulkEditMetadataValue(item, dcv); - } - - } else { - itemService.addMetadata(c, item, dcv.getSchema(), - dcv.getElement(), - dcv.getQualifier(), - dcv.getLanguage(), - dcv.getValue(), - dcv.getAuthority(), - dcv.getConfidence()); + addRelationship(c, item, dcv.getElement(), dcv.getValue()); } } - for (BulkEditMetadataValue relationship : relationships) { - handleRelationshipMetadataValueFromBulkEditMetadataValue(item, relationship); - } + // Should the workflow be used? if (useWorkflow) { WorkflowService workflowService = WorkflowServiceFactory.getInstance().getWorkflowService(); @@ -401,8 +794,6 @@ public class MetadataImport { } } - // Commit changes to the object -// c.commit(); whatHasChanged.setItem(item); } @@ -416,40 +807,23 @@ public class MetadataImport { c.uncacheEntity(wfItem); c.uncacheEntity(item); } + populateRefAndRowMap(line, item == null ? null : item.getID()); + // keep track of current rows processed + rowCount++; } c.setMode(originalMode); } catch (MetadataImportException mie) { throw mie; - } catch (Exception e) { - e.printStackTrace(); } // Return the changes + if (!change) { + validateExpressedRelations(); + } return changes; } - - /** - * This metod handles the BulkEditMetadataValue objects that correspond to Relationship metadatavalues - * @param item The item to which this metadatavalue will belong - * @param dcv The BulkEditMetadataValue to be processed - * @throws SQLException If something goes wrong - * @throws AuthorizeException If something goes wrong - */ - private void handleRelationshipMetadataValueFromBulkEditMetadataValue(Item item, BulkEditMetadataValue dcv) - throws SQLException, AuthorizeException { - LinkedList values = new LinkedList<>(); - values.add(dcv.getValue()); - LinkedList authorities = new LinkedList<>(); - authorities.add(dcv.getAuthority()); - LinkedList confidences = new LinkedList<>(); - confidences.add(dcv.getConfidence()); - handleRelationMetadata(c, item, dcv.getSchema(), dcv.getElement(), - dcv.getQualifier(), - dcv.getLanguage(), values, authorities, confidences); - } - /** * Compare an item metadata with a line from CSV, and optionally update the item * @@ -461,10 +835,11 @@ public class MetadataImport { * @param line line in CSV file * @throws SQLException if there is a problem accessing a Collection from the database, from its handle * @throws AuthorizeException if there is an authorization problem with permissions + * @throws MetadataImportException custom exception for error handling within metadataimport */ - protected void compare(Item item, String[] fromCSV, boolean change, - String md, BulkEditChange changes, DSpaceCSVLine line) - throws SQLException, AuthorizeException { + protected void compareAndUpdate(Item item, String[] fromCSV, boolean change, + String md, BulkEditChange changes, DSpaceCSVLine line) + throws SQLException, AuthorizeException, MetadataImportException { // Log what metadata element we're looking at String all = ""; for (String part : fromCSV) { @@ -474,8 +849,8 @@ public class MetadataImport { log.debug(LogManager.getHeader(c, "metadata_import", "item_id=" + item.getID() + ",fromCSV=" + all)); - // Don't compare collections or actions - if (("collection".equals(md)) || ("action".equals(md))) { + // Don't compare collections or actions or rowNames + if (("collection".equals(md)) || ("action".equals(md)) || ("rowName".equals(md))) { return; } @@ -637,10 +1012,9 @@ public class MetadataImport { } } - if (StringUtils.equals(schema, MetadataSchemaEnum.RELATION.getName())) { List relationshipTypeList = relationshipTypeService - .findByLeftOrRightLabel(c, element); + .findByLeftwardOrRightwardTypeName(c, element); for (RelationshipType relationshipType : relationshipTypeList) { for (Relationship relationship : relationshipService .findByItemAndRelationshipType(c, item, relationshipType)) { @@ -648,7 +1022,7 @@ public class MetadataImport { relationshipService.update(c, relationship); } } - handleRelationMetadata(c, item, schema, element, qualifier, language, values, authorities, confidences); + addRelationships(c, item, element, values); } else { itemService.clearMetadata(c, item, schema, element, qualifier, language); itemService.addMetadata(c, item, schema, element, qualifier, @@ -659,233 +1033,217 @@ public class MetadataImport { } /** - * This method decides whether the metadatavalue is of type relation.type or if it corresponds to - * a relationship and handles it accordingly to their respective methods + * Add an item metadata with a line from CSV, and optionally update the item + * + * @param fromCSV The metadata from the CSV file + * @param md The element to compare + * @param changes The changes object to populate + * @throws SQLException when an SQL error has occurred (querying DSpace) + * @throws AuthorizeException If the user can't make the changes + */ + protected void add(String[] fromCSV, String md, BulkEditChange changes) + throws SQLException, AuthorizeException { + // Don't add owning collection or action + if (("collection".equals(md)) || ("action".equals(md))) { + return; + } + + // Make a String array of the values + // First, strip of language if it is there + String language = null; + if (md.contains("[")) { + String[] bits = md.split("\\["); + language = bits[1].substring(0, bits[1].length() - 1); + } + AuthorityValue fromAuthority = authorityValueService.getAuthorityValueType(md); + if (md.indexOf(':') > 0) { + md = md.substring(md.indexOf(':') + 1); + } + + String[] bits = md.split("\\."); + String schema = bits[0]; + String element = bits[1]; + // If there is a language on the element, strip if off + if (element.contains("[")) { + element = element.substring(0, element.indexOf('[')); + } + String qualifier = null; + if (bits.length > 2) { + qualifier = bits[2]; + + // If there is a language, strip if off + if (qualifier.contains("[")) { + qualifier = qualifier.substring(0, qualifier.indexOf('[')); + } + } + + // Add all the values + for (String value : fromCSV) { + BulkEditMetadataValue dcv = getBulkEditValueFromCSV(language, schema, element, qualifier, value, + fromAuthority); + if (fromAuthority != null) { + value = dcv.getValue() + csv.getAuthoritySeparator() + dcv.getAuthority() + csv + .getAuthoritySeparator() + dcv.getConfidence(); + } + + // Add it + if ((value != null) && (!"".equals(value))) { + changes.registerAdd(dcv); + } + } + } + + protected BulkEditMetadataValue getBulkEditValueFromCSV(String language, String schema, String element, + String qualifier, String value, + AuthorityValue fromAuthority) { + // Look to see if it should be removed + BulkEditMetadataValue dcv = new BulkEditMetadataValue(); + dcv.setSchema(schema); + dcv.setElement(element); + dcv.setQualifier(qualifier); + dcv.setLanguage(language); + if (fromAuthority != null) { + if (value.indexOf(':') > 0) { + value = value.substring(0, value.indexOf(':')); + } + + // look up the value and authority in solr + List byValue = authorityValueService.findByValue(c, schema, element, qualifier, value); + AuthorityValue authorityValue = null; + if (byValue.isEmpty()) { + String toGenerate = fromAuthority.generateString() + value; + String field = schema + "_" + element + (StringUtils.isNotBlank(qualifier) ? "_" + qualifier : ""); + authorityValue = authorityValueService.generate(c, toGenerate, value, field); + dcv.setAuthority(toGenerate); + } else { + authorityValue = byValue.get(0); + dcv.setAuthority(authorityValue.getId()); + } + + dcv.setValue(authorityValue.getValue()); + dcv.setConfidence(Choices.CF_ACCEPTED); + } else if (value == null || !value.contains(csv.getAuthoritySeparator())) { + simplyCopyValue(value, dcv); + } else { + String[] parts = value.split(csv.getEscapedAuthoritySeparator()); + dcv.setValue(parts[0]); + dcv.setAuthority(parts[1]); + dcv.setConfidence((parts.length > 2 ? Integer.valueOf(parts[2]) : Choices.CF_ACCEPTED)); + } + return dcv; + } + + protected void simplyCopyValue(String value, BulkEditMetadataValue dcv) { + dcv.setValue(value); + dcv.setAuthority(null); + dcv.setConfidence(Choices.CF_UNSET); + } + + /** + * + * Adds multiple relationships with a matching typeName to an item. + * * @param c The relevant DSpace context * @param item The item to which this metadatavalue belongs to - * @param schema The schema for the metadatavalue - * @param element The element for the metadatavalue - * @param qualifier The qualifier for the metadatavalue - * @param language The language for the metadatavalue - * @param values The values for the metadatavalue - * @param authorities The authorities for the metadatavalue - * @param confidences The confidences for the metadatavalue + * @param typeName The element for the metadatavalue + * @param values to iterate over * @throws SQLException If something goes wrong * @throws AuthorizeException If something goes wrong */ - private void handleRelationMetadata(Context c, Item item, String schema, String element, String qualifier, - String language, List values, List authorities, - List confidences) throws SQLException, AuthorizeException { - - if (StringUtils.equals(element, "type") && StringUtils.isBlank(qualifier)) { - handleRelationTypeMetadata(c, item, schema, element, qualifier, language, values, authorities, confidences); - - } else { - for (String value : values) { - handleRelationOtherMetadata(c, item, element, value); - } + private void addRelationships(Context c, Item item, String typeName, List values) + throws SQLException, AuthorizeException, + MetadataImportException { + for (String value : values) { + addRelationship(c, item, typeName, value); } - } /** - * This method takes the item, element and values to determine what relationships should be built - * for these parameters and calls on the method to construct them + * Gets an existing entity from a target reference. + * + * @param context the context to use. + * @param targetReference the target reference which may be a UUID, metadata reference, or rowName reference. + * @return the entity, which is guaranteed to exist. + * @throws MetadataImportException if the target reference is badly formed or refers to a non-existing item. + */ + private Entity getEntity(Context context, String targetReference) throws MetadataImportException { + Entity entity = null; + UUID uuid = resolveEntityRef(context, targetReference); + // At this point, we have a uuid, so we can get an entity + try { + entity = entityService.findByItemId(context, uuid); + if (entity.getItem() == null) { + throw new IllegalArgumentException("No item found in repository with uuid: " + uuid); + } + return entity; + } catch (SQLException sqle) { + throw new MetadataImportException("Unable to find entity using reference: " + targetReference, sqle); + } + } + + /** + * + * Creates a relationship for the given item + * * @param c The relevant DSpace context * @param item The item that the relationships will be made for - * @param element The string determining which relationshiptype is to be used + * @param typeName The relationship typeName * @param value The value for the relationship * @throws SQLException If something goes wrong * @throws AuthorizeException If something goes wrong */ - private void handleRelationOtherMetadata(Context c, Item item, String element, String value) - throws SQLException, AuthorizeException { - Entity entity = entityService.findByItemId(c, item.getID()); + private void addRelationship(Context c, Item item, String typeName, String value) + throws SQLException, AuthorizeException, MetadataImportException { + if (value.isEmpty()) { + return; + } boolean left = false; - List acceptableRelationshipTypes = new LinkedList<>(); - String url = handleService.resolveToURL(c, value); - UUID uuid = UUIDUtils.fromString(value); - if (uuid == null && StringUtils.isNotBlank(url)) { - return; + + // Get entity from target reference + Entity relationEntity = getEntity(c, value); + // Get relationship type of entity and item + String relationEntityRelationshipType = itemService.getMetadata(relationEntity.getItem(), + "relationship", "type", + null, Item.ANY).get(0).getValue(); + String itemRelationshipType = itemService.getMetadata(item, "relationship", "type", + null, Item.ANY).get(0).getValue(); + + // Get the correct RelationshipType based on typeName + List relType = relationshipTypeService.findByLeftwardOrRightwardTypeName(c, typeName); + RelationshipType foundRelationshipType = matchRelationshipType(relType, relationEntityRelationshipType, + itemRelationshipType, typeName); + + if (foundRelationshipType == null) { + throw new MetadataImportException("Error on CSV row " + rowCount + ":" + "\n" + + "No Relationship type found for:\n" + + "Target type: " + relationEntityRelationshipType + "\n" + + "Origin referer type: " + itemRelationshipType + "\n" + + "with typeName: " + typeName); } - Entity relationEntity = entityService.findByItemId(c, uuid); - - - List leftRelationshipTypesForEntity = entityService.getLeftRelationshipTypes(c, entity); - List rightRelationshipTypesForEntity = entityService.getRightRelationshipTypes(c, entity); - - for (RelationshipType relationshipType : entityService.getAllRelationshipTypes(c, entity)) { - if (StringUtils.equalsIgnoreCase(relationshipType.getLeftLabel(), element)) { - left = handleLeftLabelEqualityRelationshipTypeElement(c, entity, relationEntity, left, - acceptableRelationshipTypes, - leftRelationshipTypesForEntity, - relationshipType); - } else if (StringUtils.equalsIgnoreCase(relationshipType.getRightLabel(), element)) { - left = handleRightLabelEqualityRelationshipTypeElement(c, entity, relationEntity, left, - acceptableRelationshipTypes, - rightRelationshipTypesForEntity, - relationshipType); - } + if (foundRelationshipType.getLeftwardType().equalsIgnoreCase(typeName)) { + left = true; } - if (acceptableRelationshipTypes.size() > 1) { - log.error("Ambiguous relationship_types were found"); - return; - } - if (acceptableRelationshipTypes.size() == 0) { - log.error("no relationship_types were found"); - return; - } - - //There is exactly one - buildRelationObject(c, item, value, left, acceptableRelationshipTypes.get(0)); - } - - /** - * This method creates the relationship for the item and stores it in the database - * @param c The relevant DSpace context - * @param item The item for which this relationship will be constructed - * @param value The value for the relationship - * @param left A boolean indicating whether the item is the leftItem or the rightItem - * @param acceptedRelationshipType The acceptable relationship type - * @throws SQLException If something goes wrong - * @throws AuthorizeException If something goes wrong - */ - private void buildRelationObject(Context c, Item item, String value, boolean left, - RelationshipType acceptedRelationshipType) - throws SQLException, AuthorizeException { + // Placeholder items for relation placing Item leftItem = null; Item rightItem = null; if (left) { leftItem = item; - rightItem = itemService.findByIdOrLegacyId(c, value); + rightItem = relationEntity.getItem(); } else { + leftItem = relationEntity.getItem(); rightItem = item; - leftItem = itemService.findByIdOrLegacyId(c, value); } - RelationshipType relationshipType = acceptedRelationshipType; + + // Create the relationship int leftPlace = relationshipService.findLeftPlaceByLeftItem(c, leftItem) + 1; int rightPlace = relationshipService.findRightPlaceByRightItem(c, rightItem) + 1; Relationship persistedRelationship = relationshipService.create(c, leftItem, rightItem, - relationshipType, leftPlace, rightPlace); + foundRelationshipType, leftPlace, rightPlace); relationshipService.update(c, persistedRelationship); } - /** - * This method will add RelationshipType objects to the acceptableRelationshipTypes list - * if applicable and valid RelationshipType objects are found. It will also return a boolean indicating - * whether we're dealing with a left Relationship or not - * @param c The relevant DSpace context - * @param entity The Entity for which the RelationshipType has to be checked - * @param relationEntity The other Entity of the Relationship - * @param left Boolean indicating whether the Relationship is left or not - * @param acceptableRelationshipTypes The list of RelationshipType objects that will be added to - * @param rightRelationshipTypesForEntity The list of RelationshipType objects that are possible - * for the right entity - * @param relationshipType The RelationshipType object that we want to check whether it's - * valid to be added or not - * @return A boolean indicating whether the relationship is left or right, will - * be false in this case - * @throws SQLException If something goes wrong - */ - private boolean handleRightLabelEqualityRelationshipTypeElement(Context c, Entity entity, Entity relationEntity, - boolean left, - List acceptableRelationshipTypes, - List - rightRelationshipTypesForEntity, - RelationshipType relationshipType) - throws SQLException { - if (StringUtils.equalsIgnoreCase(entityService.getType(c, entity).getLabel(), - relationshipType.getRightType().getLabel()) && - StringUtils.equalsIgnoreCase(entityService.getType(c, relationEntity).getLabel(), - relationshipType.getLeftType().getLabel())) { - - for (RelationshipType rightRelationshipType : rightRelationshipTypesForEntity) { - if (StringUtils.equalsIgnoreCase(rightRelationshipType.getLeftType().getLabel(), - relationshipType.getLeftType().getLabel()) || - StringUtils.equalsIgnoreCase(rightRelationshipType.getRightType().getLabel(), - relationshipType.getLeftType().getLabel())) { - left = false; - acceptableRelationshipTypes.add(relationshipType); - } - } - } - return left; - } - - /** - * This method will add RelationshipType objects to the acceptableRelationshipTypes list - * if applicable and valid RelationshipType objects are found. It will also return a boolean indicating - * whether we're dealing with a left Relationship or not - * @param c The relevant DSpace context - * @param entity The Entity for which the RelationshipType has to be checked - * @param relationEntity The other Entity of the Relationship - * @param left Boolean indicating whether the Relationship is left or not - * @param acceptableRelationshipTypes The list of RelationshipType objects that will be added to - * @param leftRelationshipTypesForEntity The list of RelationshipType objects that are possible - * for the left entity - * @param relationshipType The RelationshipType object that we want to check whether it's - * valid to be added or not - * @return A boolean indicating whether the relationship is left or right, will - * be true in this case - * @throws SQLException If something goes wrong - */ - private boolean handleLeftLabelEqualityRelationshipTypeElement(Context c, Entity entity, Entity relationEntity, - boolean left, - List acceptableRelationshipTypes, - List - leftRelationshipTypesForEntity, - RelationshipType relationshipType) - throws SQLException { - if (StringUtils.equalsIgnoreCase(entityService.getType(c, entity).getLabel(), - relationshipType.getLeftType().getLabel()) && - StringUtils.equalsIgnoreCase(entityService.getType(c, relationEntity).getLabel(), - relationshipType.getRightType().getLabel())) { - for (RelationshipType leftRelationshipType : leftRelationshipTypesForEntity) { - if (StringUtils.equalsIgnoreCase(leftRelationshipType.getRightType().getLabel(), - relationshipType.getRightType().getLabel()) || - StringUtils.equalsIgnoreCase(leftRelationshipType.getLeftType().getLabel(), - relationshipType.getRightType().getLabel())) { - left = true; - acceptableRelationshipTypes.add(relationshipType); - } - } - } - return left; - } - - /** - * This method will add the relationship.type metadata to the item if an EntityType can be found for the value in - * the values list. - * @param c The relevant DSpace context - * @param item The item to which this metadatavalue will be added - * @param schema The schema for the metadatavalue to be added - * @param element The element for the metadatavalue to be added - * @param qualifier The qualifier for the metadatavalue to be added - * @param language The language for the metadatavalue to be added - * @param values The value on which we'll search for EntityType object and it's the value - * for the metadatavalue that will be created - * @param authorities The authority for the metadatavalue. This will be filled with the ID - * of the found EntityType for the value if it exists - * @param confidences The confidence for the metadatavalue - * @throws SQLException If something goes wrong - * @throws AuthorizeException If something goes wrong - */ - private void handleRelationTypeMetadata(Context c, Item item, String schema, String element, String qualifier, - String language, List values, List authorities, - List confidences) - throws SQLException, AuthorizeException { - EntityType entityType = entityTypeService.findByEntityType(c, values.get(0)); - if (entityType != null) { - authorities.add(String.valueOf(entityType.getID())); - itemService.clearMetadata(c, item, schema, element, qualifier, language); - itemService.addMetadata(c, item, schema, element, qualifier, language, - values, authorities, confidences); - itemService.update(c, item); - } - } - /** * Compare changes between an items owning collection and mapped collections * and what is in the CSV file @@ -1016,111 +1374,421 @@ public class MetadataImport { } } + public void afterPropertiesSet() throws Exception { + setAuthorizedMetadataFields(); + } + /** - * Add an item metadata with a line from CSV, and optionally update the item + * Gets a copy of the given csv line with all entity target references resolved to UUID strings. + * Keys being iterated over represent metadatafields or special columns to be processed. * - * @param fromCSV The metadata from the CSV file - * @param md The element to compare - * @param changes The changes object to populate - * @throws SQLException when an SQL error has occurred (querying DSpace) - * @throws AuthorizeException If the user can't make the changes + * @param line the csv line to process. + * @return a copy, with all references resolved. + * @throws MetadataImportException if there is an error resolving any entity target reference. */ - protected void add(String[] fromCSV, String md, BulkEditChange changes) - throws SQLException, AuthorizeException { - // Don't add owning collection or action - if (("collection".equals(md)) || ("action".equals(md))) { - return; - } - - // Make a String array of the values - // First, strip of language if it is there - String language = null; - if (md.contains("[")) { - String[] bits = md.split("\\["); - language = bits[1].substring(0, bits[1].length() - 1); - } - AuthorityValue fromAuthority = authorityValueService.getAuthorityValueType(md); - if (md.indexOf(':') > 0) { - md = md.substring(md.indexOf(':') + 1); - } - - String[] bits = md.split("\\."); - String schema = bits[0]; - String element = bits[1]; - // If there is a language on the element, strip if off - if (element.contains("[")) { - element = element.substring(0, element.indexOf('[')); - } - String qualifier = null; - if (bits.length > 2) { - qualifier = bits[2]; - - // If there is a language, strip if off - if (qualifier.contains("[")) { - qualifier = qualifier.substring(0, qualifier.indexOf('[')); - } - } - - // Add all the values - for (String value : fromCSV) { - BulkEditMetadataValue dcv = getBulkEditValueFromCSV(language, schema, element, qualifier, value, - fromAuthority); - if (fromAuthority != null) { - value = dcv.getValue() + csv.getAuthoritySeparator() + dcv.getAuthority() + csv - .getAuthoritySeparator() + dcv.getConfidence(); - } - - // Add it - if ((value != null) && (!"".equals(value))) { - changes.registerAdd(dcv); - } - } - } - - protected BulkEditMetadataValue getBulkEditValueFromCSV(String language, String schema, String element, - String qualifier, String value, - AuthorityValue fromAuthority) { - // Look to see if it should be removed - BulkEditMetadataValue dcv = new BulkEditMetadataValue(); - dcv.setSchema(schema); - dcv.setElement(element); - dcv.setQualifier(qualifier); - dcv.setLanguage(language); - if (fromAuthority != null) { - if (value.indexOf(':') > 0) { - value = value.substring(0, value.indexOf(':')); - } - - // look up the value and authority in solr - List byValue = authorityValueService.findByValue(c, schema, element, qualifier, value); - AuthorityValue authorityValue = null; - if (byValue.isEmpty()) { - String toGenerate = fromAuthority.generateString() + value; - String field = schema + "_" + element + (StringUtils.isNotBlank(qualifier) ? "_" + qualifier : ""); - authorityValue = authorityValueService.generate(c, toGenerate, value, field); - dcv.setAuthority(toGenerate); + public DSpaceCSVLine resolveEntityRefs(DSpaceCSVLine line) throws MetadataImportException { + DSpaceCSVLine newLine = new DSpaceCSVLine(line.getID()); + UUID originId = evaluateOriginId(line.getID()); + for (String key : line.keys()) { + // If a key represents a relation field attempt to resolve the target reference from the csvRefMap + if (key.split("\\.")[0].equalsIgnoreCase("relation")) { + if (line.get(key).size() > 0) { + for (String val : line.get(key)) { + // Attempt to resolve the relation target reference + // These can be a UUID, metadata target reference or rowName target reference + String uuid = resolveEntityRef(c, val).toString(); + newLine.add(key, uuid); + //Entity refs have been resolved / placeholdered + //Populate the EntityRelationMap + populateEntityRelationMap(uuid, key, originId.toString()); + } + } } else { - authorityValue = byValue.get(0); - dcv.setAuthority(authorityValue.getId()); + if (line.get(key).size() > 1) { + for (String value : line.get(key)) { + newLine.add(key, value); + } + } else { + if (line.get(key).size() > 0) { + newLine.add(key, line.get(key).get(0)); + } + } } - - dcv.setValue(authorityValue.getValue()); - dcv.setConfidence(Choices.CF_ACCEPTED); - } else if (value == null || !value.contains(csv.getAuthoritySeparator())) { - simplyCopyValue(value, dcv); - } else { - String[] parts = value.split(csv.getEscapedAuthoritySeparator()); - dcv.setValue(parts[0]); - dcv.setAuthority(parts[1]); - dcv.setConfidence((parts.length > 2 ? Integer.valueOf(parts[2]) : Choices.CF_ACCEPTED)); } - return dcv; + + return newLine; } - protected void simplyCopyValue(String value, BulkEditMetadataValue dcv) { - dcv.setValue(value); - dcv.setAuthority(null); - dcv.setConfidence(Choices.CF_UNSET); + /** + * Populate the entityRelationMap with all target references and it's asscoiated typeNames + * to their respective origins + * + * @param refUUID the target reference UUID for the relation + * @param relationField the field of the typeNames to relate from + */ + private void populateEntityRelationMap(String refUUID, String relationField, String originId) { + HashMap> typeNames = null; + if (entityRelationMap.get(refUUID) == null) { + typeNames = new HashMap<>(); + ArrayList originIds = new ArrayList<>(); + originIds.add(originId); + typeNames.put(relationField, originIds); + entityRelationMap.put(refUUID, typeNames); + } else { + typeNames = entityRelationMap.get(refUUID); + if (typeNames.get(relationField) == null) { + ArrayList originIds = new ArrayList<>(); + originIds.add(originId); + typeNames.put(relationField, originIds); + } else { + ArrayList originIds = typeNames.get(relationField); + originIds.add(originId); + typeNames.put(relationField, originIds); + } + entityRelationMap.put(refUUID, typeNames); + } + } + + /** + * Populates the csvRefMap, csvRowMap, and entityTypeMap for the given csv line. + * + * The csvRefMap is an index that keeps track of which rows have a specific value for + * a specific metadata field or the special "rowName" column. This is used to help resolve indirect + * entity target references in the same CSV. + * + * The csvRowMap is a row number to UUID map, and contains an entry for every row that has + * been processed so far which has a known (minted) UUID for its item. This is used to help complete + * the resolution after the row number has been determined. + * + * @param line the csv line. + * @param uuid the uuid of the item, which may be null if it has not been minted yet. + */ + private void populateRefAndRowMap(DSpaceCSVLine line, @Nullable UUID uuid) { + if (uuid != null) { + csvRowMap.put(rowCount, uuid); + } else { + csvRowMap.put(rowCount, new UUID(0, rowCount)); + } + for (String key : line.keys()) { + if (key.contains(".") && !key.split("\\.")[0].equalsIgnoreCase("relation") || + key.equalsIgnoreCase("rowName")) { + for (String value : line.get(key)) { + String valueKey = key + ":" + value; + Set rowNums = csvRefMap.get(valueKey); + if (rowNums == null) { + rowNums = new HashSet<>(); + csvRefMap.put(valueKey, rowNums); + } + rowNums.add(rowCount); + } + } + //Populate entityTypeMap + if (key.equalsIgnoreCase("relationship.type") && line.get(key).size() > 0) { + if (uuid == null) { + entityTypeMap.put(new UUID(0, rowCount), line.get(key).get(0)); + } else { + entityTypeMap.put(uuid, line.get(key).get(0)); + } + } + } + } + + /** + * Gets the UUID of the item indicated by the given target reference, + * which may be a direct UUID string, a row reference + * of the form rowName:VALUE, or a metadata value reference of the form schema.element[.qualifier]:VALUE. + * + * The reference may refer to a previously-processed item in the CSV or an item in the database. + * + * @param context the context to use. + * @param reference the target reference which may be a UUID, metadata reference, or rowName reference. + * @return the uuid. + * @throws MetadataImportException if the target reference is malformed or ambiguous (refers to multiple items). + */ + private UUID resolveEntityRef(Context context, String reference) throws MetadataImportException { + // value reference + UUID uuid = null; + if (!reference.contains(":")) { + // assume it's a UUID + try { + return UUID.fromString(reference); + } catch (IllegalArgumentException e) { + throw new MetadataImportException("Error in CSV row " + rowCount + ":\n" + + "Not a UUID or indirect entity reference: '" + reference + "'"); + } + } else if (!reference.startsWith("rowName:")) { // Not a rowName ref; so it's a metadata value reference + MetadataValueService metadataValueService = ContentServiceFactory.getInstance().getMetadataValueService(); + MetadataFieldService metadataFieldService = + ContentServiceFactory.getInstance().getMetadataFieldService(); + int i = reference.indexOf(":"); + String mfValue = reference.substring(i + 1); + String mf[] = reference.substring(0, i).split("\\."); + if (mf.length < 2) { + throw new MetadataImportException("Error in CSV row " + rowCount + ":\n" + + "Bad metadata field in reference: '" + reference + + "' (expected syntax is schema.element[.qualifier])"); + } + String schema = mf[0]; + String element = mf[1]; + String qualifier = mf.length == 2 ? null : mf[2]; + try { + MetadataField mfo = metadataFieldService.findByElement(context, schema, element, qualifier); + Iterator mdv = metadataValueService.findByFieldAndValue(context, mfo, mfValue); + if (mdv.hasNext()) { + MetadataValue mdvVal = mdv.next(); + uuid = mdvVal.getDSpaceObject().getID(); + if (mdv.hasNext()) { + throw new MetadataImportException("Error in CSV row " + rowCount + ":\n" + + "Ambiguous reference; multiple matches in db: " + reference); + } + } + } catch (SQLException e) { + throw new MetadataImportException("Error in CSV row " + rowCount + ":\n" + + "Error looking up item by metadata reference: " + reference, e); + } + } + // Lookup UUIDs that may have already been processed into the csvRefMap + // See populateRefAndRowMap() for how the csvRefMap is populated + // See getMatchingCSVUUIDs() for how the reference param is sourced from the csvRefMap + Set csvUUIDs = getMatchingCSVUUIDs(reference); + if (csvUUIDs.size() > 1) { + throw new MetadataImportException("Error in CSV row " + rowCount + ":\n" + + "Ambiguous reference; multiple matches in csv: " + reference); + } else if (csvUUIDs.size() == 1) { + UUID csvUUID = csvUUIDs.iterator().next(); + if (csvUUID.equals(uuid)) { + return uuid; // one match from csv and db (same item) + } else if (uuid != null) { + throw new MetadataImportException("Error in CSV row " + rowCount + ":\n" + + "Ambiguous reference; multiple matches in db and csv: " + reference); + } else { + return csvUUID; // one match from csv + } + } else { // size == 0; the reference does not exist throw an error + if (uuid == null) { + throw new MetadataImportException("Error in CSV row " + rowCount + ":\n" + + "No matches found for reference: " + reference + + "\nKeep in mind you can only reference entries that " + + "are listed before this one within the CSV."); + } else { + return uuid; // one match from db + } + } + } + + /** + * Gets the set of matching lines as UUIDs that have already been processed given a metadata value. + * + * @param mdValueRef the metadataValue reference to search for. + * @return the set of matching lines as UUIDs. + */ + private Set getMatchingCSVUUIDs(String mdValueRef) { + Set set = new HashSet<>(); + if (csvRefMap.containsKey(mdValueRef)) { + for (Integer rowNum : csvRefMap.get(mdValueRef)) { + set.add(getUUIDForRow(rowNum)); + } + } + return set; + } + + /** + * Gets the UUID of the item of a given row in the CSV, if it has been minted. + * If the UUID has not yet been minted, gets a UUID representation of the row + * (a UUID whose numeric value equals the row number). + * + * @param rowNum the row number. + * @return the UUID of the item + */ + private UUID getUUIDForRow(int rowNum) { + if (csvRowMap.containsKey(rowNum)) { + return csvRowMap.get(rowNum); + } else { + return new UUID(0, rowNum); + } + } + + /** + * Return a UUID of the origin in process or a placeholder for the origin to be evaluated later + * + * @param originId UUID of the origin + * @return the UUID of the item or UUID placeholder + */ + private UUID evaluateOriginId(@Nullable UUID originId) { + if (originId != null) { + return originId; + } else { + return new UUID(0, rowCount); + } + } + + /** + * Validate every relation modification expressed in the CSV. + * + */ + private void validateExpressedRelations() throws MetadataImportException { + for (String targetUUID : entityRelationMap.keySet()) { + String targetType = null; + try { + // Get the type of reference. Attempt lookup in processed map first before looking in archive. + if (entityTypeMap.get(UUID.fromString(targetUUID)) != null) { + targetType = entityTypeService.findByEntityType(c, entityTypeMap.get(UUID.fromString(targetUUID))) + .getLabel(); + } else { + // Target item may be archived; check there. + // Add to errors if Realtionship.type cannot be derived + Item targetItem = null; + if (itemService.find(c, UUID.fromString(targetUUID)) != null) { + targetItem = itemService.find(c, UUID.fromString(targetUUID)); + List relTypes = itemService.getMetadata(targetItem, "relationship", + "type", null, Item.ANY); + String relTypeValue = null; + if (relTypes.size() > 0) { + relTypeValue = relTypes.get(0).getValue(); + targetType = entityTypeService.findByEntityType(c, relTypeValue).getLabel(); + } else { + relationValidationErrors.add("Cannot resolve Entity type for target UUID: " + + targetUUID); + } + } else { + relationValidationErrors.add("Cannot resolve Entity type for target UUID: " + + targetUUID); + } + } + if (targetType == null) { + continue; + } + // Get typeNames for each origin referer of this target. + for (String typeName : entityRelationMap.get(targetUUID).keySet()) { + // Resolve Entity Type for each origin referer. + for (String originRefererUUID : entityRelationMap.get(targetUUID).get(typeName)) { + // Evaluate row number for origin referer. + String originRow = "N/A"; + if (csvRowMap.containsValue(UUID.fromString(originRefererUUID))) { + for (int key : csvRowMap.keySet()) { + if (csvRowMap.get(key).toString().equalsIgnoreCase(originRefererUUID)) { + originRow = key + ""; + break; + } + } + } + String originType = ""; + // Validate target type and origin type pairing with typeName or add to errors. + // Attempt lookup in processed map first before looking in archive. + if (entityTypeMap.get(UUID.fromString(originRefererUUID)) != null) { + originType = entityTypeMap.get(UUID.fromString(originRefererUUID)); + validateTypesByTypeByTypeName(targetType, originType, typeName, originRow); + } else { + // Origin item may be archived; check there. + // Add to errors if Realtionship.type cannot be derived. + Item originItem = null; + if (itemService.find(c, UUID.fromString(targetUUID)) != null) { + originItem = itemService.find(c, UUID.fromString(originRefererUUID)); + List relTypes = itemService.getMetadata(originItem, "relationship", + "type", null, Item.ANY); + String relTypeValue = null; + if (relTypes.size() > 0) { + relTypeValue = relTypes.get(0).getValue(); + originType = entityTypeService.findByEntityType(c, relTypeValue).getLabel(); + validateTypesByTypeByTypeName(targetType, originType, typeName, originRow); + } else { + relationValidationErrors.add("Error on CSV row " + originRow + ":" + "\n" + + "Cannot resolve Entity type for reference: " + + originRefererUUID); + } + + } else { + relationValidationErrors.add("Error on CSV row " + originRow + ":" + "\n" + + "Cannot resolve Entity type for reference: " + + originRefererUUID + " in row: " + originRow); + } + } + } + } + + } catch (SQLException sqle) { + throw new MetadataImportException("Error interacting with database!", sqle); + } + + } // If relationValidationErrors is empty all described relationships are valid. + if (!relationValidationErrors.isEmpty()) { + StringBuilder errors = new StringBuilder(); + for (String error : relationValidationErrors) { + errors.append(error + "\n"); + } + throw new MetadataImportException("Error validating relationships: \n" + errors); + } + } + + /** + * Generates a list of potenital Relationship Types given a typeName and attempts to match the given + * targetType and originType to a Relationship Type in the list. + * + * @param targetType entity type of target. + * @param originType entity type of origin referer. + * @param typeName left or right typeName of the respective Relationship. + * @return the UUID of the item. + */ + private void validateTypesByTypeByTypeName(String targetType, String originType, String typeName, String originRow) + throws MetadataImportException { + try { + RelationshipType foundRelationshipType = null; + List relationshipTypeList = relationshipTypeService + .findByLeftwardOrRightwardTypeName(c, typeName.split("\\.")[1]); + // Validate described relationship form the CSV. + foundRelationshipType = matchRelationshipType(relationshipTypeList, targetType, originType, typeName); + if (foundRelationshipType == null) { + relationValidationErrors.add("Error on CSV row " + originRow + ":" + "\n" + + "No Relationship type found for:\n" + + "Target type: " + targetType + "\n" + + "Origin referer type: " + originType + "\n" + + "with typeName: " + typeName + " for type: " + originType); + } + } catch (SQLException sqle) { + throw new MetadataImportException("Error interacting with database!", sqle); + } + } + + /** + * Matches two Entity types to a Relationship Type from a set of Relationship Types. + * + * @param relTypes set of Relationship Types. + * @param targetType entity type of target. + * @param originType entity type of origin referer. + * @return null or matched Relationship Type. + */ + private RelationshipType matchRelationshipType(List relTypes, + String targetType, String originType, String originTypeName) { + RelationshipType foundRelationshipType = null; + if (originTypeName.split("\\.").length > 1) { + originTypeName = originTypeName.split("\\.")[1]; + } + for (RelationshipType relationshipType : relTypes) { + // Is origin type leftward or righward + boolean isLeft = false; + if (relationshipType.getLeftType().getLabel().equalsIgnoreCase(originType)) { + isLeft = true; + } + if (isLeft) { + // Validate typeName reference + if (!relationshipType.getLeftwardType().equalsIgnoreCase(originTypeName)) { + continue; + } + if (relationshipType.getLeftType().getLabel().equalsIgnoreCase(originType) && + relationshipType.getRightType().getLabel().equalsIgnoreCase(targetType)) { + foundRelationshipType = relationshipType; + } + } else { + if (!relationshipType.getRightwardType().equalsIgnoreCase(originTypeName)) { + continue; + } + if (relationshipType.getLeftType().getLabel().equalsIgnoreCase(targetType) && + relationshipType.getRightType().getLabel().equalsIgnoreCase(originType)) { + foundRelationshipType = relationshipType; + } + } + } + return foundRelationshipType; } /** @@ -1155,386 +1823,4 @@ public class MetadataImport { // Remove newlines as different operating systems sometimes use different formats return in.replaceAll("\r\n", "").replaceAll("\n", "").trim(); } - - /** - * Print the help message - * - * @param options The command line options the user gave - * @param exitCode the system exit code to use - */ - private static void printHelp(Options options, int exitCode) { - // print the help message - HelpFormatter myhelp = new HelpFormatter(); - myhelp.printHelp("MetatadataImport\n", options); - System.out.println("\nmetadataimport: MetadataImport -f filename"); - System.exit(exitCode); - } - - /** - * Display the changes that have been detected, or that have been made - * - * @param changes The changes detected - * @param changed Whether or not the changes have been made - * @return The number of items that have changed - */ - private static int displayChanges(List changes, boolean changed) { - // Display the changes - int changeCounter = 0; - for (BulkEditChange change : changes) { - // Get the changes - List adds = change.getAdds(); - List removes = change.getRemoves(); - List newCollections = change.getNewMappedCollections(); - List oldCollections = change.getOldMappedCollections(); - if ((adds.size() > 0) || (removes.size() > 0) || - (newCollections.size() > 0) || (oldCollections.size() > 0) || - (change.getNewOwningCollection() != null) || (change.getOldOwningCollection() != null) || - (change.isDeleted()) || (change.isWithdrawn()) || (change.isReinstated())) { - // Show the item - Item i = change.getItem(); - - System.out.println("-----------------------------------------------------------"); - if (!change.isNewItem()) { - System.out.println("Changes for item: " + i.getID() + " (" + i.getHandle() + ")"); - } else { - System.out.print("New item: "); - if (i != null) { - if (i.getHandle() != null) { - System.out.print(i.getID() + " (" + i.getHandle() + ")"); - } else { - System.out.print(i.getID() + " (in workflow)"); - } - } - System.out.println(); - } - changeCounter++; - } - - // Show actions - if (change.isDeleted()) { - if (changed) { - System.out.println(" - EXPUNGED!"); - } else { - System.out.println(" - EXPUNGE!"); - } - } - if (change.isWithdrawn()) { - if (changed) { - System.out.println(" - WITHDRAWN!"); - } else { - System.out.println(" - WITHDRAW!"); - } - } - if (change.isReinstated()) { - if (changed) { - System.out.println(" - REINSTATED!"); - } else { - System.out.println(" - REINSTATE!"); - } - } - - if (change.getNewOwningCollection() != null) { - Collection c = change.getNewOwningCollection(); - if (c != null) { - String cHandle = c.getHandle(); - String cName = c.getName(); - if (!changed) { - System.out.print(" + New owning collection (" + cHandle + "): "); - } else { - System.out.print(" + New owning collection (" + cHandle + "): "); - } - System.out.println(cName); - } - - c = change.getOldOwningCollection(); - if (c != null) { - String cHandle = c.getHandle(); - String cName = c.getName(); - if (!changed) { - System.out.print(" + Old owning collection (" + cHandle + "): "); - } else { - System.out.print(" + Old owning collection (" + cHandle + "): "); - } - System.out.println(cName); - } - } - - // Show new mapped collections - for (Collection c : newCollections) { - String cHandle = c.getHandle(); - String cName = c.getName(); - if (!changed) { - System.out.print(" + Map to collection (" + cHandle + "): "); - } else { - System.out.print(" + Mapped to collection (" + cHandle + "): "); - } - System.out.println(cName); - } - - // Show old mapped collections - for (Collection c : oldCollections) { - String cHandle = c.getHandle(); - String cName = c.getName(); - if (!changed) { - System.out.print(" + Un-map from collection (" + cHandle + "): "); - } else { - System.out.print(" + Un-mapped from collection (" + cHandle + "): "); - } - System.out.println(cName); - } - - // Show additions - for (BulkEditMetadataValue metadataValue : adds) { - String md = metadataValue.getSchema() + "." + metadataValue.getElement(); - if (metadataValue.getQualifier() != null) { - md += "." + metadataValue.getQualifier(); - } - if (metadataValue.getLanguage() != null) { - md += "[" + metadataValue.getLanguage() + "]"; - } - if (!changed) { - System.out.print(" + Add (" + md + "): "); - } else { - System.out.print(" + Added (" + md + "): "); - } - System.out.print(metadataValue.getValue()); - if (isAuthorityControlledField(md)) { - System.out.print(", authority = " + metadataValue.getAuthority()); - System.out.print(", confidence = " + metadataValue.getConfidence()); - } - System.out.println(""); - } - - // Show removals - for (BulkEditMetadataValue metadataValue : removes) { - String md = metadataValue.getSchema() + "." + metadataValue.getElement(); - if (metadataValue.getQualifier() != null) { - md += "." + metadataValue.getQualifier(); - } - if (metadataValue.getLanguage() != null) { - md += "[" + metadataValue.getLanguage() + "]"; - } - if (!changed) { - System.out.print(" - Remove (" + md + "): "); - } else { - System.out.print(" - Removed (" + md + "): "); - } - System.out.print(metadataValue.getValue()); - if (isAuthorityControlledField(md)) { - System.out.print(", authority = " + metadataValue.getAuthority()); - System.out.print(", confidence = " + metadataValue.getConfidence()); - } - System.out.println(""); - } - } - return changeCounter; - } - - /** - * is the field is defined as authority controlled - */ - private static boolean isAuthorityControlledField(String md) { - String mdf = StringUtils.substringAfter(md, ":"); - mdf = StringUtils.substringBefore(mdf, "["); - return authorityControlled.contains(mdf); - } - - /** - * Set authority controlled fields - */ - private static void setAuthorizedMetadataFields() { - authorityControlled = new HashSet(); - Enumeration propertyNames = ConfigurationManager.getProperties().propertyNames(); - while (propertyNames.hasMoreElements()) { - String key = ((String) propertyNames.nextElement()).trim(); - if (key.startsWith(AC_PREFIX) - && ConfigurationManager.getBooleanProperty(key, false)) { - authorityControlled.add(key.substring(AC_PREFIX.length())); - } - } - } - - /** - * main method to run the metadata exporter - * - * @param argv the command line arguments given - */ - public static void main(String[] argv) { - // Create an options object and populate it - CommandLineParser parser = new PosixParser(); - - Options options = new Options(); - - options.addOption("f", "file", true, "source file"); - options.addOption("e", "email", true, "email address or user id of user (required if adding new items)"); - options.addOption("s", "silent", false, - "silent operation - doesn't request confirmation of changes USE WITH CAUTION"); - options.addOption("w", "workflow", false, "workflow - when adding new items, use collection workflow"); - options.addOption("n", "notify", false, - "notify - when adding new items using a workflow, send notification emails"); - options.addOption("t", "template", false, - "template - when adding new items, use the collection template (if it exists)"); - options.addOption("h", "help", false, "help"); - - // Parse the command line arguments - CommandLine line; - try { - line = parser.parse(options, argv); - } catch (ParseException pe) { - System.err.println("Error parsing command line arguments: " + pe.getMessage()); - System.exit(1); - return; - } - - if (line.hasOption('h')) { - printHelp(options, 0); - } - - // Check a filename is given - if (!line.hasOption('f')) { - System.err.println("Required parameter -f missing!"); - printHelp(options, 1); - } - String filename = line.getOptionValue('f'); - - // Option to apply template to new items - boolean useTemplate = false; - if (line.hasOption('t')) { - useTemplate = true; - } - - // Options for workflows, and workflow notifications for new items - boolean useWorkflow = false; - boolean workflowNotify = false; - if (line.hasOption('w')) { - useWorkflow = true; - if (line.hasOption('n')) { - workflowNotify = true; - } - } else if (line.hasOption('n')) { - System.err.println("Invalid option 'n': (notify) can only be specified with the 'w' (workflow) option."); - System.exit(1); - } - - // Create a context - Context c; - try { - c = new Context(); - c.turnOffAuthorisationSystem(); - } catch (Exception e) { - System.err.println("Unable to create a new DSpace Context: " + e.getMessage()); - System.exit(1); - return; - } - - // Find the EPerson, assign to context - try { - if (line.hasOption('e')) { - EPerson eperson; - String e = line.getOptionValue('e'); - if (e.indexOf('@') != -1) { - eperson = EPersonServiceFactory.getInstance().getEPersonService().findByEmail(c, e); - } else { - eperson = EPersonServiceFactory.getInstance().getEPersonService().find(c, UUID.fromString(e)); - } - - if (eperson == null) { - System.out.println("Error, eperson cannot be found: " + e); - System.exit(1); - } - c.setCurrentUser(eperson); - } - } catch (Exception e) { - System.err.println("Unable to find DSpace user: " + e.getMessage()); - System.exit(1); - return; - } - - // Is this a silent run? - boolean change = false; - - // Read lines from the CSV file - DSpaceCSV csv; - try { - csv = new DSpaceCSV(new File(filename), c); - } catch (MetadataImportInvalidHeadingException miihe) { - System.err.println(miihe.getMessage()); - System.exit(1); - return; - } catch (Exception e) { - System.err.println("Error reading file: " + e.getMessage()); - System.exit(1); - return; - } - - // Perform the first import - just highlight differences - MetadataImport importer = new MetadataImport(c, csv); - List changes; - - if (!line.hasOption('s')) { - // See what has changed - try { - changes = importer.runImport(false, useWorkflow, workflowNotify, useTemplate); - } catch (MetadataImportException mie) { - System.err.println("Error: " + mie.getMessage()); - System.exit(1); - return; - } - - // Display the changes - int changeCounter = displayChanges(changes, false); - - // If there were changes, ask if we should execute them - if (changeCounter > 0) { - try { - // Ask the user if they want to make the changes - System.out.println("\n" + changeCounter + " item(s) will be changed\n"); - System.out.print("Do you want to make these changes? [y/n] "); - String yn = (new BufferedReader(new InputStreamReader(System.in))).readLine(); - if ("y".equalsIgnoreCase(yn)) { - change = true; - } else { - System.out.println("No data has been changed."); - } - } catch (IOException ioe) { - System.err.println("Error: " + ioe.getMessage()); - System.err.println("No changes have been made"); - System.exit(1); - } - } else { - System.out.println("There were no changes detected"); - } - } else { - change = true; - } - - try { - // If required, make the change - if (change) { - try { - // Make the changes - changes = importer.runImport(true, useWorkflow, workflowNotify, useTemplate); - } catch (MetadataImportException mie) { - System.err.println("Error: " + mie.getMessage()); - System.exit(1); - return; - } - - // Display the changes - displayChanges(changes, true); - - // Commit the change to the DB -// c.commit(); - } - - // Finsh off and tidy up - c.restoreAuthSystemState(); - c.complete(); - } catch (Exception e) { - c.abort(); - System.err.println("Error committing changes to database: " + e.getMessage()); - System.err.println("Aborting most recent changes."); - System.exit(1); - } - } } diff --git a/dspace-api/src/main/java/org/dspace/content/MetadataExportServiceImpl.java b/dspace-api/src/main/java/org/dspace/content/MetadataExportServiceImpl.java new file mode 100644 index 0000000000..a76d4aabb0 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/content/MetadataExportServiceImpl.java @@ -0,0 +1,130 @@ +/** + * 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.content; + +import java.sql.SQLException; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; + +import com.google.common.collect.Iterators; +import org.apache.logging.log4j.Logger; +import org.dspace.app.bulkedit.DSpaceCSV; +import org.dspace.content.service.ItemService; +import org.dspace.content.service.MetadataExportService; +import org.dspace.core.Constants; +import org.dspace.core.Context; +import org.dspace.handle.factory.HandleServiceFactory; +import org.springframework.beans.factory.annotation.Autowired; + +public class MetadataExportServiceImpl implements MetadataExportService { + + private static final Logger log = org.apache.logging.log4j.LogManager.getLogger(MetadataExportServiceImpl.class); + + @Autowired + private ItemService itemService; + + public DSpaceCSV handleExport(Context context, boolean exportAllItems, boolean exportAllMetadata, String handle) + throws Exception { + Iterator toExport = null; + + if (!exportAllItems) { + log.info("Exporting whole repository WARNING: May take some time!"); + toExport = itemService.findAll(context); + } else { + DSpaceObject dso = HandleServiceFactory.getInstance().getHandleService().resolveToObject(context, handle); + if (dso == null) { + throw new IllegalArgumentException( + "Item '" + handle + "' does not resolve to an item in your repository!"); + } + + if (dso.getType() == Constants.ITEM) { + log.info("Exporting item '" + dso.getName() + "' (" + handle + ")"); + List item = new ArrayList<>(); + item.add((Item) dso); + toExport = item.iterator(); + } else if (dso.getType() == Constants.COLLECTION) { + log.info("Exporting collection '" + dso.getName() + "' (" + handle + ")"); + Collection collection = (Collection) dso; + toExport = itemService.findByCollection(context, collection); + } else if (dso.getType() == Constants.COMMUNITY) { + log.info("Exporting community '" + dso.getName() + "' (" + handle + ")"); + toExport = buildFromCommunity(context, (Community) dso); + } else { + throw new IllegalArgumentException("Error identifying '" + handle + "'"); + } + } + + DSpaceCSV csv = this.export(context, toExport, exportAllMetadata); + return csv; + } + + /** + * Run the export + * + * @return the exported CSV lines + */ + public DSpaceCSV export(Context context, Iterator toExport, boolean exportAll) throws Exception { + Context.Mode originalMode = context.getCurrentMode(); + context.setMode(Context.Mode.READ_ONLY); + + // Process each item + DSpaceCSV csv = new DSpaceCSV(exportAll); + while (toExport.hasNext()) { + Item item = toExport.next(); + csv.addItem(item); + context.uncacheEntity(item); + } + + context.setMode(originalMode); + // Return the results + return csv; + } + + public DSpaceCSV export(Context context, Community community, boolean exportAll) throws Exception { + return export(context, buildFromCommunity(context, community), exportAll); + } + + /** + * Build an array list of item ids that are in a community (include sub-communities and collections) + * + * @param context DSpace context + * @param community The community to build from + * @return The list of item ids + * @throws SQLException if database error + */ + private Iterator buildFromCommunity(Context context, Community community) + throws SQLException { + // Add all the collections + List collections = community.getCollections(); + Iterator result = null; + for (Collection collection : collections) { + Iterator items = itemService.findByCollection(context, collection); + result = addItemsToResult(result, items); + + } + // Add all the sub-communities + List communities = community.getSubcommunities(); + for (Community subCommunity : communities) { + Iterator items = buildFromCommunity(context, subCommunity); + result = addItemsToResult(result, items); + } + + return result; + } + + private Iterator addItemsToResult(Iterator result, Iterator items) { + if (result == null) { + result = items; + } else { + result = Iterators.concat(result, items); + } + + return result; + } +} diff --git a/dspace-api/src/main/java/org/dspace/content/service/MetadataExportService.java b/dspace-api/src/main/java/org/dspace/content/service/MetadataExportService.java new file mode 100644 index 0000000000..de2ef4984f --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/content/service/MetadataExportService.java @@ -0,0 +1,26 @@ +/** + * 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.content.service; + +import java.util.Iterator; + +import org.dspace.app.bulkedit.DSpaceCSV; +import org.dspace.content.Community; +import org.dspace.content.Item; +import org.dspace.core.Context; + +public interface MetadataExportService { + + public DSpaceCSV handleExport(Context context, boolean exportAllItems, boolean exportAllMetadata, String handle) + throws Exception; + + public DSpaceCSV export(Context context, Iterator toExport, boolean exportAll) throws Exception; + + public DSpaceCSV export(Context context, Community community, boolean exportAll) throws Exception; + +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java b/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java index 4ce1c5063a..87c06d2f46 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java +++ b/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java @@ -7,10 +7,14 @@ */ package org.dspace.scripts; +import java.io.InputStream; import java.sql.SQLException; +import java.util.LinkedList; +import java.util.List; import org.apache.commons.cli.CommandLine; import org.apache.commons.cli.DefaultParser; +import org.apache.commons.cli.Option; import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; import org.dspace.authorize.service.AuthorizeService; @@ -73,6 +77,18 @@ public abstract class DSpaceRunnable implements Runnable { return options; } + public List getFileNamesFromInputStreamOptions() { + List fileNames = new LinkedList<>(); + + for (Option option : options.getOptions()) { + if (option.getType() == InputStream.class) { + fileNames.add(commandLine.getOptionValue(option.getOpt())); + } + } + + return fileNames; + } + /** * This method will take the primitive array of String objects that represent the parameters given to the String * and it'll parse these into a CommandLine object that can be used by the script to retrieve the data diff --git a/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java b/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java index cb5a5c9944..8e2565428a 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java @@ -7,6 +7,8 @@ */ package org.dspace.scripts; +import java.io.IOException; +import java.io.InputStream; import java.sql.SQLException; import java.util.ArrayList; import java.util.Collections; @@ -17,8 +19,14 @@ import java.util.regex.Pattern; import org.apache.commons.lang3.StringUtils; import org.apache.logging.log4j.Logger; +import org.dspace.authorize.AuthorizeException; +import org.dspace.authorize.service.AuthorizeService; +import org.dspace.content.Bitstream; import org.dspace.content.ProcessStatus; import org.dspace.content.dao.ProcessDAO; +import org.dspace.content.service.BitstreamFormatService; +import org.dspace.content.service.BitstreamService; +import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.core.LogManager; import org.dspace.eperson.EPerson; @@ -35,6 +43,15 @@ public class ProcessServiceImpl implements ProcessService { @Autowired private ProcessDAO processDAO; + @Autowired + private BitstreamService bitstreamService; + + @Autowired + private BitstreamFormatService bitstreamFormatService; + + @Autowired + private AuthorizeService authorizeService; + @Override public Process create(Context context, EPerson ePerson, String scriptName, List parameters) throws SQLException { @@ -112,6 +129,21 @@ public class ProcessServiceImpl implements ProcessService { } + @Override + public void appendFile(Context context, Process process, InputStream is, String type, String fileName) + throws IOException, SQLException, AuthorizeException { + Bitstream bitstream = bitstreamService.create(context, is); + bitstream.setName(context, fileName); + bitstreamService.setFormat(context, bitstream, bitstreamFormatService.guessFormat(context, bitstream)); + bitstreamService.addMetadata(context, bitstream, "process", "type", null, null, type); + authorizeService.addPolicy(context, bitstream, Constants.READ, context.getCurrentUser()); + authorizeService.addPolicy(context, bitstream, Constants.WRITE, context.getCurrentUser()); + authorizeService.addPolicy(context, bitstream, Constants.DELETE, context.getCurrentUser()); + bitstreamService.update(context, bitstream); + process.addBitstream(bitstream); + update(context, process); + } + @Override public void delete(Context context, Process process) throws SQLException { processDAO.delete(context, process); @@ -141,6 +173,33 @@ public class ProcessServiceImpl implements ProcessService { return parameterList; } + @Override + public Bitstream getBitstreamByName(Context context, Process process, String bitstreamName) { + for (Bitstream bitstream : getBitstreams(context, process, null)) { + if (StringUtils.equals(bitstream.getName(), bitstreamName)) { + return bitstream; + } + } + + return null; + } + + public List getBitstreams(Context context, Process process, String type) { + List allBitstreams = process.getBitstreams(); + + if (type == null) { + return allBitstreams; + } else { + List filteredBitstreams = new ArrayList<>(); + for (Bitstream bitstream : allBitstreams) { + if (StringUtils.equals(bitstreamService.getMetadata(bitstream, "process.type"), type)) { + filteredBitstreams.add(bitstream); + } + } + return filteredBitstreams; + } + } + public int countTotal(Context context) throws SQLException { return processDAO.countRows(context); } diff --git a/dspace-api/src/main/java/org/dspace/scripts/handler/DSpaceRunnableHandler.java b/dspace-api/src/main/java/org/dspace/scripts/handler/DSpaceRunnableHandler.java index 01ca2fafd9..7e1bd713f3 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/handler/DSpaceRunnableHandler.java +++ b/dspace-api/src/main/java/org/dspace/scripts/handler/DSpaceRunnableHandler.java @@ -7,9 +7,13 @@ */ package org.dspace.scripts.handler; +import java.io.IOException; +import java.io.InputStream; import java.sql.SQLException; import org.apache.commons.cli.Options; +import org.dspace.authorize.AuthorizeException; +import org.dspace.core.Context; /** * This is an interface meant to be implemented by any DSpaceRunnableHandler to specify specific execution methods @@ -78,4 +82,9 @@ public interface DSpaceRunnableHandler { * @param name The name of the script */ public void printHelp(Options options, String name); + + public InputStream getFileStream(Context context, String fileName) throws IOException, AuthorizeException; + + public void writeFilestream(Context context, String fileName, InputStream inputStream, String type) + throws IOException; } diff --git a/dspace-api/src/main/java/org/dspace/scripts/handler/impl/CommandLineDSpaceRunnableHandler.java b/dspace-api/src/main/java/org/dspace/scripts/handler/impl/CommandLineDSpaceRunnableHandler.java index 97925c1843..f7a62b8acf 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/handler/impl/CommandLineDSpaceRunnableHandler.java +++ b/dspace-api/src/main/java/org/dspace/scripts/handler/impl/CommandLineDSpaceRunnableHandler.java @@ -7,9 +7,15 @@ */ package org.dspace.scripts.handler.impl; +import java.io.File; +import java.io.IOException; +import java.io.InputStream; + import org.apache.commons.cli.HelpFormatter; import org.apache.commons.cli.Options; +import org.apache.commons.io.FileUtils; import org.apache.logging.log4j.Logger; +import org.dspace.core.Context; import org.dspace.scripts.handler.DSpaceRunnableHandler; /** @@ -84,4 +90,20 @@ public class CommandLineDSpaceRunnableHandler implements DSpaceRunnableHandler { formatter.printHelp(name, options); } } + + @Override + public InputStream getFileStream(Context context, String fileName) throws IOException { + File file = new File(fileName); + if (!file.isFile()) { + return null; + } + return FileUtils.openInputStream(file); + } + + @Override + public void writeFilestream(Context context, String fileName, InputStream inputStream, String type) + throws IOException { + File file = new File(fileName); + FileUtils.copyInputStreamToFile(inputStream, file); + } } diff --git a/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java b/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java index e277ab32f4..c2363effd5 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java +++ b/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java @@ -7,9 +7,13 @@ */ package org.dspace.scripts.service; +import java.io.IOException; +import java.io.InputStream; import java.sql.SQLException; import java.util.List; +import org.dspace.authorize.AuthorizeException; +import org.dspace.content.Bitstream; import org.dspace.core.Context; import org.dspace.eperson.EPerson; import org.dspace.scripts.DSpaceCommandLineParameter; @@ -104,6 +108,9 @@ public interface ProcessService { */ public void complete(Context context, Process process) throws SQLException; + public void appendFile(Context context, Process process, InputStream is, String type, String fileName) + throws IOException, SQLException, AuthorizeException; + /** * This method will delete the given Process object from the database * @param context The relevant DSpace context @@ -128,6 +135,10 @@ public interface ProcessService { */ public List getParameters(Process process); + public Bitstream getBitstreamByName(Context context, Process process, String bitstreamName); + + public List getBitstreams(Context context, Process process, String type); + /** * Returns the total amount of Process objects in the dataase * @param context The relevant DSpace context diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ScriptProcessesController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ScriptProcessesController.java index b89e4126bf..6c1c12500b 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ScriptProcessesController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ScriptProcessesController.java @@ -7,6 +7,8 @@ */ package org.dspace.app.rest; +import java.util.List; + import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; import org.dspace.app.rest.link.HalLinkService; @@ -24,7 +26,9 @@ import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.multipart.MultipartFile; /** * This controller adds additional subresource methods to allow connecting scripts with processes @@ -53,12 +57,13 @@ public class ScriptProcessesController { */ @RequestMapping(method = RequestMethod.POST) @PreAuthorize("hasAuthority('ADMIN')") - public ResponseEntity startProcess(@PathVariable(name = "name") String scriptName) + public ResponseEntity startProcess(@PathVariable(name = "name") String scriptName, + @RequestParam(name = "file") List files) throws Exception { if (log.isTraceEnabled()) { log.trace("Starting Process for Script with name: " + scriptName); } - ProcessRest processRest = scriptRestRepository.startProcess(scriptName); + ProcessRest processRest = scriptRestRepository.startProcess(scriptName, files); ProcessResource processResource = new ProcessResource(processRest, utils, null); halLinkService.addLinks(processResource); return ControllerUtils.toResponseEntity(HttpStatus.ACCEPTED, null, processResource); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/exception/DSpaceApiExceptionControllerAdvice.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/exception/DSpaceApiExceptionControllerAdvice.java index f075828e88..e92c204cfb 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/exception/DSpaceApiExceptionControllerAdvice.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/exception/DSpaceApiExceptionControllerAdvice.java @@ -29,6 +29,7 @@ import org.springframework.web.bind.annotation.ControllerAdvice; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.ResponseStatus; import org.springframework.web.context.request.WebRequest; +import org.springframework.web.multipart.MultipartException; import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler; /** @@ -54,8 +55,8 @@ public class DSpaceApiExceptionControllerAdvice extends ResponseEntityExceptionH } } - @ExceptionHandler(IllegalArgumentException.class) - protected void handleIllegalArgumentException(HttpServletRequest request, HttpServletResponse response, + @ExceptionHandler({IllegalArgumentException.class, MultipartException.class}) + protected void handleWrongRequestException(HttpServletRequest request, HttpServletResponse response, Exception ex) throws IOException { sendErrorResponse(request, response, ex, ex.getMessage(), HttpServletResponse.SC_BAD_REQUEST); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java index 12b33d441c..3341156529 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java @@ -24,6 +24,7 @@ import org.dspace.app.rest.converter.DSpaceRunnableParameterConverter; import org.dspace.app.rest.converter.ScriptConverter; import org.dspace.app.rest.converter.processes.ProcessConverter; import org.dspace.app.rest.exception.DSpaceBadRequestException; +import org.dspace.app.rest.exception.UnprocessableEntityException; import org.dspace.app.rest.model.ParameterValueRest; import org.dspace.app.rest.model.ProcessRest; import org.dspace.app.rest.model.ScriptRest; @@ -40,6 +41,7 @@ import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.security.access.AccessDeniedException; import org.springframework.stereotype.Component; +import org.springframework.web.multipart.MultipartFile; /** * This is the REST repository dealing with the Script logic @@ -103,7 +105,8 @@ public class ScriptRestRepository extends DSpaceRestRepository files) throws SQLException, IOException, AuthorizeException { Context context = obtainContext(); String properties = requestService.getCurrentRequest().getServletRequest().getParameter("properties"); List dSpaceCommandLineParameters = @@ -119,7 +122,7 @@ public class ScriptRestRepository extends DSpaceRestRepository args = constructArgs(dSpaceCommandLineParameters); try { - runDSpaceScript(scriptToExecute, restDSpaceRunnableHandler, args); + runDSpaceScript(files, context, scriptToExecute, restDSpaceRunnableHandler, args); context.complete(); return processConverter.fromModel(restDSpaceRunnableHandler.getProcess()); } catch (SQLException e) { @@ -167,10 +170,13 @@ public class ScriptRestRepository extends DSpaceRestRepository args) { + private void runDSpaceScript(List files, Context context, DSpaceRunnable scriptToExecute, + RestDSpaceRunnableHandler restDSpaceRunnableHandler, List args) + throws IOException { try { scriptToExecute.initialize(args.toArray(new String[0]), restDSpaceRunnableHandler); + checkFileNames(scriptToExecute, files); + processFiles(context, restDSpaceRunnableHandler, files); restDSpaceRunnableHandler.schedule(scriptToExecute); } catch (ParseException e) { scriptToExecute.printHelp(); @@ -181,4 +187,31 @@ public class ScriptRestRepository extends DSpaceRestRepository files) + throws IOException { + for (MultipartFile file : files) { + restDSpaceRunnableHandler + .writeFilestream(context, file.getOriginalFilename(), file.getInputStream(), "inputfile"); + } + } + + private void checkFileNames(DSpaceRunnable scriptToExecute, List files) { + List fileNames = new LinkedList<>(); + for (MultipartFile file : files) { + String fileName = file.getOriginalFilename(); + if (fileNames.contains(fileName)) { + throw new UnprocessableEntityException("There are two files with the same name: " + fileName); + } else { + fileNames.add(fileName); + } + } + + List fileNamesFromOptions = scriptToExecute.getFileNamesFromInputStreamOptions(); + if (!fileNames.containsAll(fileNamesFromOptions)) { + throw new UnprocessableEntityException("Files given in properties aren't all present in the request"); + } + } + + } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java index dd549a5873..890f59cc4b 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java @@ -7,6 +7,8 @@ */ package org.dspace.app.rest.scripts.handler.impl; +import java.io.IOException; +import java.io.InputStream; import java.io.PrintWriter; import java.io.StringWriter; import java.sql.SQLException; @@ -16,8 +18,12 @@ import org.apache.commons.cli.HelpFormatter; import org.apache.commons.cli.Options; import org.apache.commons.lang3.exception.ExceptionUtils; import org.apache.logging.log4j.Logger; +import org.dspace.authorize.AuthorizeException; +import org.dspace.content.Bitstream; import org.dspace.content.ProcessStatus; +import org.dspace.content.factory.ContentServiceFactory; import org.dspace.content.factory.ProcessServiceFactory; +import org.dspace.content.service.BitstreamService; import org.dspace.core.Context; import org.dspace.eperson.EPerson; import org.dspace.scripts.DSpaceCommandLineParameter; @@ -25,6 +31,8 @@ import org.dspace.scripts.DSpaceRunnable; import org.dspace.scripts.Process; import org.dspace.scripts.handler.DSpaceRunnableHandler; import org.dspace.scripts.service.ProcessService; +import org.dspace.utils.DSpace; +import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; /** * The {@link DSpaceRunnableHandler} dealing with Scripts started from the REST api @@ -34,6 +42,7 @@ public class RestDSpaceRunnableHandler implements DSpaceRunnableHandler { .getLogger(RestDSpaceRunnableHandler.class); private ProcessService processService = ProcessServiceFactory.getInstance().getProcessService(); + private BitstreamService bitstreamService = ContentServiceFactory.getInstance().getBitstreamService(); private Integer processId; private String scriptName; @@ -176,6 +185,29 @@ public class RestDSpaceRunnableHandler implements DSpaceRunnableHandler { } } + @Override + public InputStream getFileStream(Context context, String fileName) throws IOException, AuthorizeException { + try { + Process process = processService.find(context, processId); + Bitstream bitstream = processService.getBitstreamByName(context, process, fileName); + return bitstreamService.retrieve(context, bitstream); + } catch (SQLException sqlException) { + log.error("SQL exception while attempting to find process", sqlException); + } + return null; + } + + @Override + public void writeFilestream(Context context, String fileName, InputStream inputStream, String type) + throws IOException { + try { + Process process = processService.find(context, processId); + processService.appendFile(context, process, inputStream, type, fileName); + } catch (SQLException | AuthorizeException exception) { + log.error("Exception occurred while attempting to find process", exception); + } + } + /** * This method will return the process created by this handler * @return The Process database object created by this handler @@ -200,6 +232,9 @@ public class RestDSpaceRunnableHandler implements DSpaceRunnableHandler { * @param script The script to be ran */ public void schedule(DSpaceRunnable script) { + ThreadPoolTaskExecutor taskExecutor = new DSpace().getServiceManager() + .getServiceByName("dspaceRunnableThreadExecutor", + ThreadPoolTaskExecutor.class); Context context = new Context(); try { Process process = processService.find(context, processId); @@ -213,6 +248,6 @@ public class RestDSpaceRunnableHandler implements DSpaceRunnableHandler { context.abort(); } } - script.run(); + taskExecutor.execute(script); } } diff --git a/dspace/config/spring/rest/scripts.xml b/dspace/config/spring/rest/scripts.xml new file mode 100644 index 0000000000..8fadf8be72 --- /dev/null +++ b/dspace/config/spring/rest/scripts.xml @@ -0,0 +1,9 @@ + + + + + + + + \ No newline at end of file From 84775128b1ed5b768c24a1d18a5da972366a20ec Mon Sep 17 00:00:00 2001 From: Kevin Van de Velde Date: Thu, 5 Dec 2019 15:59:52 +0100 Subject: [PATCH 002/125] Adding missing MetadataExportServiceImpl to the core-services.xml file --- dspace/config/spring/api/core-services.xml | 1 + 1 file changed, 1 insertion(+) diff --git a/dspace/config/spring/api/core-services.xml b/dspace/config/spring/api/core-services.xml index f1ce9103b0..6a1d4f897a 100644 --- a/dspace/config/spring/api/core-services.xml +++ b/dspace/config/spring/api/core-services.xml @@ -44,6 +44,7 @@ + From e295a76c70a8f211531248957ceb27df2019a078 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Tue, 10 Dec 2019 16:13:54 +0100 Subject: [PATCH 003/125] [Task 66428] Applied feedback to the MetadataImport and Export scripts and framework --- .../org/dspace/app/bulkedit/DSpaceCSV.java | 22 ------------ .../dspace/app/bulkedit/MetadataExport.java | 29 ++++++++------- .../dspace/app/bulkedit/MetadataImport.java | 24 ++++--------- .../app/bulkedit/MetadataImportCLI.java | 29 +++++++++++++++ .../content/MetadataExportServiceImpl.java | 24 ++++++------- .../service/MetadataExportService.java | 36 +++++++++++++++++-- .../org/dspace/scripts/DSpaceRunnable.java | 5 +++ .../dspace/scripts/ProcessServiceImpl.java | 1 + .../handler/DSpaceRunnableHandler.java | 22 ++++++++++-- .../CommandLineDSpaceRunnableHandler.java | 12 ------- .../scripts/service/ProcessService.java | 16 +++++++++ .../impl/RestDSpaceRunnableHandler.java | 5 --- dspace/config/spring/api/scripts.xml | 2 +- dspace/config/spring/rest/scripts.xml | 4 +++ 14 files changed, 142 insertions(+), 89 deletions(-) create mode 100644 dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCLI.java diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/DSpaceCSV.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/DSpaceCSV.java index 93f8c07bc3..d85f327092 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/DSpaceCSV.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/DSpaceCSV.java @@ -8,12 +8,8 @@ package org.dspace.app.bulkedit; import java.io.BufferedReader; -import java.io.BufferedWriter; -import java.io.FileOutputStream; -import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; -import java.io.OutputStreamWriter; import java.io.Serializable; import java.util.ArrayList; import java.util.Arrays; @@ -623,24 +619,6 @@ public class DSpaceCSV implements Serializable { return csvLines; } - /** - * Save the CSV file to the given filename - * - * @param filename The filename to save the CSV file to - * @throws IOException Thrown if an error occurs when writing the file - */ - public final void save(String filename) throws IOException { - // Save the file - BufferedWriter out = new BufferedWriter( - new OutputStreamWriter( - new FileOutputStream(filename), "UTF-8")); - for (String csvLine : getCSVLinesAsStringArray()) { - out.write(csvLine + "\n"); - } - out.flush(); - out.close(); - } - public InputStream getInputStream() { StringBuilder stringBuilder = new StringBuilder(); for (String csvLine : getCSVLinesAsStringArray()) { diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java index a27ee5cdf2..f6527855f0 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java @@ -21,7 +21,7 @@ import org.springframework.beans.factory.annotation.Autowired; */ public class MetadataExport extends DSpaceRunnable { - private Context c = null; + private Context context = null; private boolean help = false; private String filename = null; private String handle = null; @@ -31,43 +31,46 @@ public class MetadataExport extends DSpaceRunnable { @Autowired private MetadataExportService metadataExportService; - protected Context context; - private MetadataExport() { - Options options = constructOptions(); - this.options = options; + this.options = constructOptions(); } private Options constructOptions() { Options options = new Options(); options.addOption("i", "id", true, "ID or handle of thing to export (item, collection, or community)"); + options.getOption("i").setType(String.class); options.addOption("f", "file", true, "destination where you want file written"); + options.getOption("f").setType(String.class); options.getOption("f").setRequired(true); options.addOption("a", "all", false, "include all metadata fields that are not normally changed (e.g. provenance)"); + options.getOption("a").setType(boolean.class); options.addOption("h", "help", false, "help"); + options.getOption("h").setType(boolean.class); + return options; } public void internalRun() throws Exception { if (help) { - handler.logInfo("\nfull export: metadataexport -f filename"); - handler.logInfo("partial export: metadataexport -i handle -f filename"); + handler.logInfo("\nfull export: metadata-export -f filename"); + handler.logInfo("partial export: metadata-export -i handle -f filename"); printHelp(); return; } - DSpaceCSV dSpaceCSV = metadataExportService.handleExport(c, exportAllItems, exportAllMetadata, handle); - handler.writeFilestream(c, filename, dSpaceCSV.getInputStream(), "exportCSV"); - c.restoreAuthSystemState(); - c.complete(); + DSpaceCSV dSpaceCSV = metadataExportService.handleExport(context, exportAllItems, exportAllMetadata, handle, + handler); + handler.writeFilestream(context, filename, dSpaceCSV.getInputStream(), "exportCSV"); + context.restoreAuthSystemState(); + context.complete(); } public void setup() throws ParseException { - c = new Context(); - c.turnOffAuthorisationSystem(); + context = new Context(); + context.turnOffAuthorisationSystem(); if (commandLine.hasOption('h')) { help = true; diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java index 83e3e2d8b4..6fd4be68fe 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java @@ -21,7 +21,6 @@ import java.util.Set; import java.util.UUID; import javax.annotation.Nullable; -import org.apache.commons.cli.HelpFormatter; import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; import org.apache.commons.lang3.StringUtils; @@ -59,6 +58,7 @@ import org.dspace.eperson.EPerson; import org.dspace.eperson.factory.EPersonServiceFactory; import org.dspace.handle.service.HandleService; import org.dspace.scripts.DSpaceRunnable; +import org.dspace.scripts.handler.DSpaceRunnableHandler; import org.dspace.workflow.WorkflowItem; import org.dspace.workflow.WorkflowService; import org.dspace.workflow.factory.WorkflowServiceFactory; @@ -219,7 +219,7 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { try { // Ask the user if they want to make the changes handler.logInfo("\n" + changeCounter + " item(s) will be changed\n"); - change = handler.getUserValidation(); + change = determineChange(handler); } catch (IOException ioe) { throw new IOException("Error: " + ioe.getMessage() + ", No changes have been made", ioe); @@ -256,6 +256,10 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { } + protected boolean determineChange(DSpaceRunnableHandler handler) throws IOException { + return true; + } + public void setup() throws ParseException { useTemplate = false; filename = null; @@ -322,7 +326,7 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { change = false; } - private MetadataImport() { + public MetadataImport() { Options options = constructOptions(); this.options = options; } @@ -1230,20 +1234,6 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { return in.replaceAll("\r\n", "").replaceAll("\n", "").trim(); } - /** - * Print the help message - * - * @param options The command line options the user gave - * @param exitCode the system exit code to use - */ - private static void printHelp(Options options, int exitCode) { - // print the help message - HelpFormatter myhelp = new HelpFormatter(); - myhelp.printHelp("MetatadataImport\n", options); - System.out.println("\nmetadataimport: MetadataImport -f filename"); - System.exit(exitCode); - } - /** * Display the changes that have been detected, or that have been made * diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCLI.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCLI.java new file mode 100644 index 0000000000..f7ed5adce5 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCLI.java @@ -0,0 +1,29 @@ +/** + * 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.io.BufferedReader; +import java.io.IOException; +import java.io.InputStreamReader; + +import org.dspace.scripts.handler.DSpaceRunnableHandler; + +public class MetadataImportCLI extends MetadataImport { + + @Override + protected boolean determineChange(DSpaceRunnableHandler handler) throws IOException { + handler.logInfo("Do you want to make these changes? [y/n] "); + try (BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(System.in))) { + String yn = bufferedReader.readLine(); + if ("y".equalsIgnoreCase(yn)) { + return true; + } + return false; + } + } +} diff --git a/dspace-api/src/main/java/org/dspace/content/MetadataExportServiceImpl.java b/dspace-api/src/main/java/org/dspace/content/MetadataExportServiceImpl.java index a76d4aabb0..24338954d0 100644 --- a/dspace-api/src/main/java/org/dspace/content/MetadataExportServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/MetadataExportServiceImpl.java @@ -13,28 +13,27 @@ import java.util.Iterator; import java.util.List; import com.google.common.collect.Iterators; -import org.apache.logging.log4j.Logger; import org.dspace.app.bulkedit.DSpaceCSV; import org.dspace.content.service.ItemService; import org.dspace.content.service.MetadataExportService; import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.handle.factory.HandleServiceFactory; +import org.dspace.scripts.handler.DSpaceRunnableHandler; import org.springframework.beans.factory.annotation.Autowired; public class MetadataExportServiceImpl implements MetadataExportService { - private static final Logger log = org.apache.logging.log4j.LogManager.getLogger(MetadataExportServiceImpl.class); - @Autowired private ItemService itemService; - public DSpaceCSV handleExport(Context context, boolean exportAllItems, boolean exportAllMetadata, String handle) - throws Exception { + @Override + public DSpaceCSV handleExport(Context context, boolean exportAllItems, boolean exportAllMetadata, String handle, + DSpaceRunnableHandler handler) throws Exception { Iterator toExport = null; if (!exportAllItems) { - log.info("Exporting whole repository WARNING: May take some time!"); + handler.logInfo("Exporting whole repository WARNING: May take some time!"); toExport = itemService.findAll(context); } else { DSpaceObject dso = HandleServiceFactory.getInstance().getHandleService().resolveToObject(context, handle); @@ -44,16 +43,16 @@ public class MetadataExportServiceImpl implements MetadataExportService { } if (dso.getType() == Constants.ITEM) { - log.info("Exporting item '" + dso.getName() + "' (" + handle + ")"); + handler.logInfo("Exporting item '" + dso.getName() + "' (" + handle + ")"); List item = new ArrayList<>(); item.add((Item) dso); toExport = item.iterator(); } else if (dso.getType() == Constants.COLLECTION) { - log.info("Exporting collection '" + dso.getName() + "' (" + handle + ")"); + handler.logInfo("Exporting collection '" + dso.getName() + "' (" + handle + ")"); Collection collection = (Collection) dso; toExport = itemService.findByCollection(context, collection); } else if (dso.getType() == Constants.COMMUNITY) { - log.info("Exporting community '" + dso.getName() + "' (" + handle + ")"); + handler.logInfo("Exporting community '" + dso.getName() + "' (" + handle + ")"); toExport = buildFromCommunity(context, (Community) dso); } else { throw new IllegalArgumentException("Error identifying '" + handle + "'"); @@ -64,11 +63,7 @@ public class MetadataExportServiceImpl implements MetadataExportService { return csv; } - /** - * Run the export - * - * @return the exported CSV lines - */ + @Override public DSpaceCSV export(Context context, Iterator toExport, boolean exportAll) throws Exception { Context.Mode originalMode = context.getCurrentMode(); context.setMode(Context.Mode.READ_ONLY); @@ -86,6 +81,7 @@ public class MetadataExportServiceImpl implements MetadataExportService { return csv; } + @Override public DSpaceCSV export(Context context, Community community, boolean exportAll) throws Exception { return export(context, buildFromCommunity(context, community), exportAll); } diff --git a/dspace-api/src/main/java/org/dspace/content/service/MetadataExportService.java b/dspace-api/src/main/java/org/dspace/content/service/MetadataExportService.java index de2ef4984f..77584ceeb0 100644 --- a/dspace-api/src/main/java/org/dspace/content/service/MetadataExportService.java +++ b/dspace-api/src/main/java/org/dspace/content/service/MetadataExportService.java @@ -13,14 +13,46 @@ import org.dspace.app.bulkedit.DSpaceCSV; import org.dspace.content.Community; import org.dspace.content.Item; import org.dspace.core.Context; +import org.dspace.scripts.handler.DSpaceRunnableHandler; +/** + * This is the interface to be implemented by a Service that deals with the exporting of Metadata + */ public interface MetadataExportService { - public DSpaceCSV handleExport(Context context, boolean exportAllItems, boolean exportAllMetadata, String handle) - throws Exception; + /** + * This method will export DSpaceObject objects depending on the parameters it gets. It can export all the items + * in the repository, all the items in a community, all the items in a collection or a specific item. The latter + * three are specified by the handle parameter. The entire repository can be exported by defining the + * exportAllItems parameter as true + * @param context The relevant DSpace context + * @param exportAllItems A boolean indicating whether or not the entire repository should be exported + * @param exportAllMetadata Defines if all metadata should be exported or only the allowed ones + * @param handle The handle for the DSpaceObject to be exported, can be a Community, Collection or Item + * @return A DSpaceCSV object containing the exported information + * @throws Exception If something goes wrong + */ + public DSpaceCSV handleExport(Context context, boolean exportAllItems, boolean exportAllMetadata, + String handle, DSpaceRunnableHandler dSpaceRunnableHandler) throws Exception; + /** + * This method will export all the Items in the given toExport iterator to a DSpaceCSV + * @param context The relevant DSpace context + * @param toExport The iterator containing the items to export + * @param exportAll Defines if all metadata should be exported or only the allowed ones + * @return A DSpaceCSV object containing the exported information + * @throws Exception If something goes wrong + */ public DSpaceCSV export(Context context, Iterator toExport, boolean exportAll) throws Exception; + /** + * This method will export all the Items within the given Community to a DSpaceCSV + * @param context The relevant DSpace context + * @param community The Community that contains the Items to be exported + * @param exportAll Defines if all metadata should be exported or only the allowed ones + * @return A DSpaceCSV object containing the exported information + * @throws Exception If something goes wrong + */ public DSpaceCSV export(Context context, Community community, boolean exportAll) throws Exception; } \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java b/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java index 87c06d2f46..8d8d8caa60 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java +++ b/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java @@ -77,6 +77,11 @@ public abstract class DSpaceRunnable implements Runnable { return options; } + /** + * This method will traverse all the options and it'll grab options defined as an InputStream type to then save + * the filename specified by that option in a list of Strings that'll be returned in the end + * @return The list of Strings representing filenames from the options given to the script + */ public List getFileNamesFromInputStreamOptions() { List fileNames = new LinkedList<>(); diff --git a/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java b/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java index 8e2565428a..67fd151ac9 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java @@ -184,6 +184,7 @@ public class ProcessServiceImpl implements ProcessService { return null; } + @Override public List getBitstreams(Context context, Process process, String type) { List allBitstreams = process.getBitstreams(); diff --git a/dspace-api/src/main/java/org/dspace/scripts/handler/DSpaceRunnableHandler.java b/dspace-api/src/main/java/org/dspace/scripts/handler/DSpaceRunnableHandler.java index 7d615f4f49..543f21855c 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/handler/DSpaceRunnableHandler.java +++ b/dspace-api/src/main/java/org/dspace/scripts/handler/DSpaceRunnableHandler.java @@ -83,11 +83,27 @@ public interface DSpaceRunnableHandler { */ public void printHelp(Options options, String name); + /** + * This method will grab the InputStream for the file defined by the given file name. The exact implementation will + * differ based on whether it's a REST call or CommandLine call. The REST Call will look for Bitstreams in the + * Database whereas the CommandLine call will look on the filesystem + * @param context The relevant DSpace context + * @param fileName The filename for the file that holds the InputStream + * @return The InputStream for the file defined by the given file name + * @throws IOException If something goes wrong + * @throws AuthorizeException If something goes wrong + */ public InputStream getFileStream(Context context, String fileName) throws IOException, AuthorizeException; + /** + * This method will write the InputStream to either a file on the filesystem or a bitstream in the database + * depending on whether it's coming from a CommandLine call or REST call respectively + * @param context The relevant DSpace context + * @param fileName The filename + * @param inputStream The inputstream to be written + * @param type The type of the file + * @throws IOException If something goes wrong + */ public void writeFilestream(Context context, String fileName, InputStream inputStream, String type) throws IOException; - - boolean getUserValidation() throws IOException; - } diff --git a/dspace-api/src/main/java/org/dspace/scripts/handler/impl/CommandLineDSpaceRunnableHandler.java b/dspace-api/src/main/java/org/dspace/scripts/handler/impl/CommandLineDSpaceRunnableHandler.java index f0482cde92..f7a62b8acf 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/handler/impl/CommandLineDSpaceRunnableHandler.java +++ b/dspace-api/src/main/java/org/dspace/scripts/handler/impl/CommandLineDSpaceRunnableHandler.java @@ -7,11 +7,9 @@ */ package org.dspace.scripts.handler.impl; -import java.io.BufferedReader; import java.io.File; import java.io.IOException; import java.io.InputStream; -import java.io.InputStreamReader; import org.apache.commons.cli.HelpFormatter; import org.apache.commons.cli.Options; @@ -108,14 +106,4 @@ public class CommandLineDSpaceRunnableHandler implements DSpaceRunnableHandler { File file = new File(fileName); FileUtils.copyInputStreamToFile(inputStream, file); } - - @Override - public boolean getUserValidation() throws IOException { - logInfo("Do you want to make these changes? [y/n] "); - String yn = (new BufferedReader(new InputStreamReader(System.in))).readLine(); - if ("y".equalsIgnoreCase(yn)) { - return true; - } - return false; - } } diff --git a/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java b/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java index c2363effd5..b8e78a5f4f 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java +++ b/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java @@ -135,8 +135,24 @@ public interface ProcessService { */ public List getParameters(Process process); + /** + * This method will return the Bitstream that matches the given name for the given Process + * @param context The relevant DSpace context + * @param process The process that should hold the requested Bitstream + * @param bitstreamName The name of the requested Bitstream + * @return The Bitstream from the given Process that matches the given bitstream name + */ public Bitstream getBitstreamByName(Context context, Process process, String bitstreamName); + /** + * This method will return all the Bitstreams for a given process if the type is defined as null. If type is + * different than null, the bitstreams with metadata process.type equal to the given type from that process + * are returned + * @param context The relevant DSpace context + * @param process The process that holds the Bitstreams to be searched in + * @param type The type that the Bitstream must have + * @return The list of Bitstreams of the given type for the given Process + */ public List getBitstreams(Context context, Process process, String type); /** diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java index 4b45fecb78..890f59cc4b 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java @@ -250,9 +250,4 @@ public class RestDSpaceRunnableHandler implements DSpaceRunnableHandler { } taskExecutor.execute(script); } - - @Override - public boolean getUserValidation() throws IOException { - return true; - } } diff --git a/dspace/config/spring/api/scripts.xml b/dspace/config/spring/api/scripts.xml index c57500d271..fc10384e95 100644 --- a/dspace/config/spring/api/scripts.xml +++ b/dspace/config/spring/api/scripts.xml @@ -9,7 +9,7 @@ - + diff --git a/dspace/config/spring/rest/scripts.xml b/dspace/config/spring/rest/scripts.xml index 8fadf8be72..09fca4e47f 100644 --- a/dspace/config/spring/rest/scripts.xml +++ b/dspace/config/spring/rest/scripts.xml @@ -6,4 +6,8 @@ + + + + \ No newline at end of file From a208058d387a2ec06c9153735e6deba15c0deded Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Mon, 6 Jan 2020 14:12:08 +0100 Subject: [PATCH 004/125] Working on fixes test issues --- .../org/dspace/app/launcher/ScriptLauncher.java | 15 ++++----------- dspace/config/spring/api/scripts.xml | 2 +- dspace/config/spring/rest/scripts.xml | 4 +++- 3 files changed, 8 insertions(+), 13 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java b/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java index fd0465c931..1ed9a2ac78 100644 --- a/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java +++ b/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java @@ -13,12 +13,6 @@ import java.lang.reflect.Method; import java.util.List; import java.util.TreeMap; -import org.apache.commons.cli.ParseException; -import org.apache.commons.lang3.StringUtils; -import org.apache.log4j.Logger; -import org.dspace.scripts.DSpaceRunnable; -import org.dspace.scripts.handler.DSpaceRunnableHandler; -import org.dspace.scripts.handler.impl.CommandLineDSpaceRunnableHandler; import org.apache.commons.cli.ParseException; import org.apache.log4j.Logger; import org.dspace.scripts.DSpaceRunnable; @@ -28,7 +22,6 @@ import org.dspace.scripts.handler.impl.CommandLineDSpaceRunnableHandler; import org.dspace.servicemanager.DSpaceKernelImpl; import org.dspace.servicemanager.DSpaceKernelInit; import org.dspace.services.RequestService; -import org.dspace.utils.DSpace; import org.jdom.Document; import org.jdom.Element; import org.jdom.input.SAXBuilder; @@ -115,11 +108,11 @@ public class ScriptLauncher { * @param commandConfigs The Document * @param dSpaceRunnableHandler The DSpaceRunnableHandler for this execution * @param kernelImpl The relevant DSpaceKernelImpl - * @return A 1 or 0 depending on whether the script failed or passed respectively + * @return A 1 or 0 depending on whether the script failed or passed respectively */ public static int handleScript(String[] args, Document commandConfigs, - DSpaceRunnableHandler dSpaceRunnableHandler, - DSpaceKernelImpl kernelImpl) { + DSpaceRunnableHandler dSpaceRunnableHandler, + DSpaceKernelImpl kernelImpl) { int status; DSpaceRunnable script = ScriptServiceFactory.getInstance().getScriptService().getScriptForName(args[0]); if (script != null) { @@ -135,7 +128,7 @@ public class ScriptLauncher { * @param args The arguments of the script with the script name as first place in the array * @param dSpaceRunnableHandler The relevant DSpaceRunnableHandler * @param script The script to be executed - * @return A 1 or 0 depending on whether the script failed or passed respectively + * @return A 1 or 0 depending on whether the script failed or passed respectively */ private static int executeScript(String[] args, DSpaceRunnableHandler dSpaceRunnableHandler, DSpaceRunnable script) { diff --git a/dspace/config/spring/api/scripts.xml b/dspace/config/spring/api/scripts.xml index fc10384e95..81acb052c3 100644 --- a/dspace/config/spring/api/scripts.xml +++ b/dspace/config/spring/api/scripts.xml @@ -9,7 +9,7 @@ - + diff --git a/dspace/config/spring/rest/scripts.xml b/dspace/config/spring/rest/scripts.xml index 09fca4e47f..dcdd55ebee 100644 --- a/dspace/config/spring/rest/scripts.xml +++ b/dspace/config/spring/rest/scripts.xml @@ -6,7 +6,9 @@ - + + From 24f5cf0896632c29e0631dfa0909fa0473f5ba1e Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Thu, 9 Jan 2020 15:03:42 +0100 Subject: [PATCH 005/125] Fixed tests in CSVMetadataImportReferenceTest and script bean issues --- .../dspace/app/bulkedit/MetadataImport.java | 515 +++++++++--------- .../org/dspace/scripts/DSpaceRunnable.java | 24 +- .../org/dspace/scripts/ScriptServiceImpl.java | 12 +- .../config/spring/api/scripts.xml | 9 +- .../app/rest/ScriptRestRepositoryIT.java | 16 +- dspace/config/spring/api/scripts.xml | 9 +- dspace/config/spring/rest/scripts.xml | 3 +- 7 files changed, 289 insertions(+), 299 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java index 6fd4be68fe..939c0d1de6 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java @@ -59,6 +59,7 @@ import org.dspace.eperson.factory.EPersonServiceFactory; import org.dspace.handle.service.HandleService; import org.dspace.scripts.DSpaceRunnable; import org.dspace.scripts.handler.DSpaceRunnableHandler; +import org.dspace.workflow.WorkflowException; import org.dspace.workflow.WorkflowItem; import org.dspace.workflow.WorkflowService; import org.dspace.workflow.factory.WorkflowServiceFactory; @@ -374,275 +375,271 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { public List runImport(boolean change, boolean useWorkflow, boolean workflowNotify, - boolean useTemplate) throws MetadataImportException { + boolean useTemplate) + throws MetadataImportException, SQLException, AuthorizeException, WorkflowException, IOException { // Store the changes ArrayList changes = new ArrayList(); // Make the changes - try { - Context.Mode originalMode = c.getCurrentMode(); - c.setMode(Context.Mode.BATCH_EDIT); + Context.Mode originalMode = c.getCurrentMode(); + c.setMode(Context.Mode.BATCH_EDIT); - // Process each change - rowCount = 1; - for (DSpaceCSVLine line : toImport) { - // Resolve target references to other items - populateRefAndRowMap(line, line.getID()); - line = resolveEntityRefs(line); - // Get the DSpace item to compare with - UUID id = line.getID(); + // Process each change + rowCount = 1; + for (DSpaceCSVLine line : toImport) { + // Resolve target references to other items + populateRefAndRowMap(line, line.getID()); + line = resolveEntityRefs(line); + // Get the DSpace item to compare with + UUID id = line.getID(); - // Is there an action column? - if (csv.hasActions() && (!"".equals(line.getAction())) && (id == null)) { - throw new MetadataImportException("'action' not allowed for new items!"); - } - - WorkspaceItem wsItem = null; - WorkflowItem wfItem = null; - Item item = null; - - // Is this an existing item? - if (id != null) { - // Get the item - item = itemService.find(c, id); - if (item == null) { - throw new MetadataImportException("Unknown item ID " + id); - } - - // Record changes - BulkEditChange whatHasChanged = new BulkEditChange(item); - - // Has it moved collection? - List collections = line.get("collection"); - if (collections != null) { - // Sanity check we're not orphaning it - if (collections.size() == 0) { - throw new MetadataImportException("Missing collection from item " + item.getHandle()); - } - List actualCollections = item.getCollections(); - compare(item, collections, actualCollections, whatHasChanged, change); - } - - // Iterate through each metadata element in the csv line - for (String md : line.keys()) { - // Get the values we already have - if (!"id".equals(md)) { - // Get the values from the CSV - String[] fromCSV = line.get(md).toArray(new String[line.get(md).size()]); - // Remove authority unless the md is not authority controlled - if (!isAuthorityControlledField(md)) { - for (int i = 0; i < fromCSV.length; i++) { - int pos = fromCSV[i].indexOf(csv.getAuthoritySeparator()); - if (pos > -1) { - fromCSV[i] = fromCSV[i].substring(0, pos); - } - } - } - // Compare - compareAndUpdate(item, fromCSV, change, md, whatHasChanged, line); - } - } - - if (csv.hasActions()) { - // Perform the action - String action = line.getAction(); - if ("".equals(action)) { - // Do nothing - } else if ("expunge".equals(action)) { - // Does the configuration allow deletes? - if (!ConfigurationManager.getBooleanProperty("bulkedit", "allowexpunge", false)) { - throw new MetadataImportException("'expunge' action denied by configuration"); - } - - // Remove the item - - if (change) { - itemService.delete(c, item); - } - - whatHasChanged.setDeleted(); - } else if ("withdraw".equals(action)) { - // Withdraw the item - if (!item.isWithdrawn()) { - if (change) { - itemService.withdraw(c, item); - } - whatHasChanged.setWithdrawn(); - } - } else if ("reinstate".equals(action)) { - // Reinstate the item - if (item.isWithdrawn()) { - if (change) { - itemService.reinstate(c, item); - } - whatHasChanged.setReinstated(); - } - } else { - // Unknown action! - throw new MetadataImportException("Unknown action: " + action); - } - } - - // Only record if changes have been made - if (whatHasChanged.hasChanges()) { - changes.add(whatHasChanged); - } - } else { - // This is marked as a new item, so no need to compare - - // First check a user is set, otherwise this can't happen - if (c.getCurrentUser() == null) { - throw new MetadataImportException( - "When adding new items, a user must be specified with the -e option"); - } - - // Iterate through each metadata element in the csv line - BulkEditChange whatHasChanged = new BulkEditChange(); - for (String md : line.keys()) { - // Get the values we already have - if (!"id".equals(md) && !"rowName".equals(md)) { - // Get the values from the CSV - String[] fromCSV = line.get(md).toArray(new String[line.get(md).size()]); - - // Remove authority unless the md is not authority controlled - if (!isAuthorityControlledField(md)) { - for (int i = 0; i < fromCSV.length; i++) { - int pos = fromCSV[i].indexOf(csv.getAuthoritySeparator()); - if (pos > -1) { - fromCSV[i] = fromCSV[i].substring(0, pos); - } - } - } - - // Add all the values from the CSV line - add(fromCSV, md, whatHasChanged); - } - } - - // Check it has an owning collection - List collections = line.get("collection"); - if (collections == null) { - throw new MetadataImportException( - "New items must have a 'collection' assigned in the form of a handle"); - } - - // Check collections are really collections - ArrayList check = new ArrayList(); - Collection collection; - for (String handle : collections) { - try { - // Resolve the handle to the collection - collection = (Collection) handleService.resolveToObject(c, handle); - - // Check it resolved OK - if (collection == null) { - throw new MetadataImportException( - "'" + handle + "' is not a Collection! You must specify a valid collection for " + - "new items"); - } - - // Check for duplicate - if (check.contains(collection)) { - throw new MetadataImportException( - "Duplicate collection assignment detected in new item! " + handle); - } else { - check.add(collection); - } - } catch (Exception ex) { - throw new MetadataImportException( - "'" + handle + "' is not a Collection! You must specify a valid collection for new " + - "items", - ex); - } - } - - // Record the addition to collections - boolean first = true; - for (String handle : collections) { - Collection extra = (Collection) handleService.resolveToObject(c, handle); - if (first) { - whatHasChanged.setOwningCollection(extra); - } else { - whatHasChanged.registerNewMappedCollection(extra); - } - first = false; - } - - // Create the new item? - if (change) { - // Create the item - String collectionHandle = line.get("collection").get(0); - collection = (Collection) handleService.resolveToObject(c, collectionHandle); - wsItem = workspaceItemService.create(c, collection, useTemplate); - item = wsItem.getItem(); - - // Add the metadata to the item - for (BulkEditMetadataValue dcv : whatHasChanged.getAdds()) { - if (!StringUtils.equals(dcv.getSchema(), MetadataSchemaEnum.RELATION.getName())) { - itemService.addMetadata(c, item, dcv.getSchema(), - dcv.getElement(), - dcv.getQualifier(), - dcv.getLanguage(), - dcv.getValue(), - dcv.getAuthority(), - dcv.getConfidence()); - } - } - //Add relations after all metadata has been processed - for (BulkEditMetadataValue dcv : whatHasChanged.getAdds()) { - if (StringUtils.equals(dcv.getSchema(), MetadataSchemaEnum.RELATION.getName())) { - addRelationship(c, item, dcv.getElement(), dcv.getValue()); - } - } - - - // Should the workflow be used? - if (useWorkflow) { - WorkflowService workflowService = WorkflowServiceFactory.getInstance().getWorkflowService(); - if (workflowNotify) { - wfItem = workflowService.start(c, wsItem); - } else { - wfItem = workflowService.startWithoutNotify(c, wsItem); - } - } else { - // Install the item - installItemService.installItem(c, wsItem); - } - - // Add to extra collections - if (line.get("collection").size() > 0) { - for (int i = 1; i < collections.size(); i++) { - String handle = collections.get(i); - Collection extra = (Collection) handleService.resolveToObject(c, handle); - collectionService.addItem(c, extra, item); - } - } - - whatHasChanged.setItem(item); - } - - // Record the changes - changes.add(whatHasChanged); - } - - if (change) { - //only clear cache if changes have been made. - c.uncacheEntity(wsItem); - c.uncacheEntity(wfItem); - c.uncacheEntity(item); - } - populateRefAndRowMap(line, item == null ? null : item.getID()); - // keep track of current rows processed - rowCount++; + // Is there an action column? + if (csv.hasActions() && (!"".equals(line.getAction())) && (id == null)) { + throw new MetadataImportException("'action' not allowed for new items!"); } - c.setMode(originalMode); - } catch (MetadataImportException mie) { - throw mie; - } catch (Exception e) { - e.printStackTrace(); + WorkspaceItem wsItem = null; + WorkflowItem wfItem = null; + Item item = null; + + // Is this an existing item? + if (id != null) { + // Get the item + item = itemService.find(c, id); + if (item == null) { + throw new MetadataImportException("Unknown item ID " + id); + } + + // Record changes + BulkEditChange whatHasChanged = new BulkEditChange(item); + + // Has it moved collection? + List collections = line.get("collection"); + if (collections != null) { + // Sanity check we're not orphaning it + if (collections.size() == 0) { + throw new MetadataImportException("Missing collection from item " + item.getHandle()); + } + List actualCollections = item.getCollections(); + compare(item, collections, actualCollections, whatHasChanged, change); + } + + // Iterate through each metadata element in the csv line + for (String md : line.keys()) { + // Get the values we already have + if (!"id".equals(md)) { + // Get the values from the CSV + String[] fromCSV = line.get(md).toArray(new String[line.get(md).size()]); + // Remove authority unless the md is not authority controlled + if (!isAuthorityControlledField(md)) { + for (int i = 0; i < fromCSV.length; i++) { + int pos = fromCSV[i].indexOf(csv.getAuthoritySeparator()); + if (pos > -1) { + fromCSV[i] = fromCSV[i].substring(0, pos); + } + } + } + // Compare + compareAndUpdate(item, fromCSV, change, md, whatHasChanged, line); + } + } + + if (csv.hasActions()) { + // Perform the action + String action = line.getAction(); + if ("".equals(action)) { + // Do nothing + } else if ("expunge".equals(action)) { + // Does the configuration allow deletes? + if (!ConfigurationManager.getBooleanProperty("bulkedit", "allowexpunge", false)) { + throw new MetadataImportException("'expunge' action denied by configuration"); + } + + // Remove the item + + if (change) { + itemService.delete(c, item); + } + + whatHasChanged.setDeleted(); + } else if ("withdraw".equals(action)) { + // Withdraw the item + if (!item.isWithdrawn()) { + if (change) { + itemService.withdraw(c, item); + } + whatHasChanged.setWithdrawn(); + } + } else if ("reinstate".equals(action)) { + // Reinstate the item + if (item.isWithdrawn()) { + if (change) { + itemService.reinstate(c, item); + } + whatHasChanged.setReinstated(); + } + } else { + // Unknown action! + throw new MetadataImportException("Unknown action: " + action); + } + } + + // Only record if changes have been made + if (whatHasChanged.hasChanges()) { + changes.add(whatHasChanged); + } + } else { + // This is marked as a new item, so no need to compare + + // First check a user is set, otherwise this can't happen + if (c.getCurrentUser() == null) { + throw new MetadataImportException( + "When adding new items, a user must be specified with the -e option"); + } + + // Iterate through each metadata element in the csv line + BulkEditChange whatHasChanged = new BulkEditChange(); + for (String md : line.keys()) { + // Get the values we already have + if (!"id".equals(md) && !"rowName".equals(md)) { + // Get the values from the CSV + String[] fromCSV = line.get(md).toArray(new String[line.get(md).size()]); + + // Remove authority unless the md is not authority controlled + if (!isAuthorityControlledField(md)) { + for (int i = 0; i < fromCSV.length; i++) { + int pos = fromCSV[i].indexOf(csv.getAuthoritySeparator()); + if (pos > -1) { + fromCSV[i] = fromCSV[i].substring(0, pos); + } + } + } + + // Add all the values from the CSV line + add(fromCSV, md, whatHasChanged); + } + } + + // Check it has an owning collection + List collections = line.get("collection"); + if (collections == null) { + throw new MetadataImportException( + "New items must have a 'collection' assigned in the form of a handle"); + } + + // Check collections are really collections + ArrayList check = new ArrayList(); + Collection collection; + for (String handle : collections) { + try { + // Resolve the handle to the collection + collection = (Collection) handleService.resolveToObject(c, handle); + + // Check it resolved OK + if (collection == null) { + throw new MetadataImportException( + "'" + handle + "' is not a Collection! You must specify a valid collection for " + + "new items"); + } + + // Check for duplicate + if (check.contains(collection)) { + throw new MetadataImportException( + "Duplicate collection assignment detected in new item! " + handle); + } else { + check.add(collection); + } + } catch (Exception ex) { + throw new MetadataImportException( + "'" + handle + "' is not a Collection! You must specify a valid collection for new " + + "items", + ex); + } + } + + // Record the addition to collections + boolean first = true; + for (String handle : collections) { + Collection extra = (Collection) handleService.resolveToObject(c, handle); + if (first) { + whatHasChanged.setOwningCollection(extra); + } else { + whatHasChanged.registerNewMappedCollection(extra); + } + first = false; + } + + // Create the new item? + if (change) { + // Create the item + String collectionHandle = line.get("collection").get(0); + collection = (Collection) handleService.resolveToObject(c, collectionHandle); + wsItem = workspaceItemService.create(c, collection, useTemplate); + item = wsItem.getItem(); + + // Add the metadata to the item + for (BulkEditMetadataValue dcv : whatHasChanged.getAdds()) { + if (!StringUtils.equals(dcv.getSchema(), MetadataSchemaEnum.RELATION.getName())) { + itemService.addMetadata(c, item, dcv.getSchema(), + dcv.getElement(), + dcv.getQualifier(), + dcv.getLanguage(), + dcv.getValue(), + dcv.getAuthority(), + dcv.getConfidence()); + } + } + //Add relations after all metadata has been processed + for (BulkEditMetadataValue dcv : whatHasChanged.getAdds()) { + if (StringUtils.equals(dcv.getSchema(), MetadataSchemaEnum.RELATION.getName())) { + addRelationship(c, item, dcv.getElement(), dcv.getValue()); + } + } + + + // Should the workflow be used? + if (useWorkflow) { + WorkflowService workflowService = WorkflowServiceFactory.getInstance().getWorkflowService(); + if (workflowNotify) { + wfItem = workflowService.start(c, wsItem); + } else { + wfItem = workflowService.startWithoutNotify(c, wsItem); + } + } else { + // Install the item + installItemService.installItem(c, wsItem); + } + + // Add to extra collections + if (line.get("collection").size() > 0) { + for (int i = 1; i < collections.size(); i++) { + String handle = collections.get(i); + Collection extra = (Collection) handleService.resolveToObject(c, handle); + collectionService.addItem(c, extra, item); + } + } + + whatHasChanged.setItem(item); + } + + // Record the changes + changes.add(whatHasChanged); + } + + if (change) { + //only clear cache if changes have been made. + c.uncacheEntity(wsItem); + c.uncacheEntity(wfItem); + c.uncacheEntity(item); + } + populateRefAndRowMap(line, item == null ? null : item.getID()); + // keep track of current rows processed + rowCount++; } + c.setMode(originalMode); + + // Return the changes if (!change) { validateExpressedRelations(); diff --git a/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java b/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java index 8d8d8caa60..cad875a53b 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java +++ b/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java @@ -20,6 +20,7 @@ import org.apache.commons.cli.ParseException; import org.dspace.authorize.service.AuthorizeService; import org.dspace.core.Context; import org.dspace.scripts.handler.DSpaceRunnableHandler; +import org.springframework.beans.factory.BeanNameAware; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Required; @@ -28,7 +29,7 @@ import org.springframework.beans.factory.annotation.Required; * it provides the basic variables to be hold by the script as well as the means to initialize, parse and run the script * Every DSpaceRunnable that is implemented in this way should be defined in the scripts.xml config file as a bean */ -public abstract class DSpaceRunnable implements Runnable { +public abstract class DSpaceRunnable implements Runnable, BeanNameAware { /** * The name of the script @@ -55,15 +56,6 @@ public abstract class DSpaceRunnable implements Runnable { @Autowired private AuthorizeService authorizeService; - public String getName() { - return name; - } - - @Required - public void setName(String name) { - this.name = name; - } - public String getDescription() { return description; } @@ -174,4 +166,16 @@ public abstract class DSpaceRunnable implements Runnable { } return false; } + + public void setBeanName(String beanName) { + this.name = beanName; + } + + /** + * Generic getter for the name + * @return the name value of this DSpaceRunnable + */ + public String getName() { + return name; + } } diff --git a/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java b/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java index e2a6acf3a8..7f1f0b83e6 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java @@ -10,8 +10,8 @@ package org.dspace.scripts; import java.util.List; import java.util.stream.Collectors; -import org.apache.commons.lang3.StringUtils; import org.dspace.core.Context; +import org.dspace.kernel.ServiceManager; import org.dspace.scripts.service.ScriptService; import org.springframework.beans.factory.annotation.Autowired; @@ -19,21 +19,17 @@ import org.springframework.beans.factory.annotation.Autowired; * The implementation for the {@link ScriptService} */ public class ScriptServiceImpl implements ScriptService { - @Autowired - private List dSpaceRunnables; + private ServiceManager serviceManager; @Override public DSpaceRunnable getScriptForName(String name) { - return dSpaceRunnables.stream() - .filter(dSpaceRunnable -> StringUtils.equalsIgnoreCase(dSpaceRunnable.getName(), name)) - .findFirst() - .orElse(null); + return serviceManager.getServiceByName(name, DSpaceRunnable.class); } @Override public List getDSpaceRunnables(Context context) { - return dSpaceRunnables.stream().filter( + return serviceManager.getServicesByType(DSpaceRunnable.class).stream().filter( dSpaceRunnable -> dSpaceRunnable.isAllowedToExecute(context)).collect(Collectors.toList()); } } diff --git a/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml b/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml index c62fc959ba..8072292b28 100644 --- a/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml +++ b/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml @@ -4,18 +4,15 @@ xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd"> - - + - - + - - + diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java index 22f998148b..96a6d3034d 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java @@ -86,28 +86,28 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { getClient(token).perform(get("/api/system/scripts").param("size", "1")) .andExpect(status().isOk()) - .andExpect(jsonPath("$._embedded.scripts", hasItem( + .andExpect(jsonPath("$._embedded.scripts", Matchers.not(Matchers.hasItem( ScriptMatcher.matchScript(dSpaceRunnableList.get(0).getName(), dSpaceRunnableList.get(0).getDescription()) - ))) - .andExpect(jsonPath("$._embedded.scripts", Matchers.not(hasItem( + )))) + .andExpect(jsonPath("$._embedded.scripts", hasItem( ScriptMatcher.matchScript(dSpaceRunnableList.get(1).getName(), dSpaceRunnableList.get(1).getDescription()) - )))) + ))) .andExpect(jsonPath("$.page", is(PageMatcher.pageEntry(0, 1)))); getClient(token).perform(get("/api/system/scripts").param("size", "1").param("page", "1")) .andExpect(status().isOk()) - .andExpect(jsonPath("$._embedded.scripts", Matchers.not(hasItem( + .andExpect(jsonPath("$._embedded.scripts", hasItem( ScriptMatcher.matchScript(dSpaceRunnableList.get(0).getName(), dSpaceRunnableList.get(0).getDescription()) - )))) - .andExpect(jsonPath("$._embedded.scripts", hasItem( + ))) + .andExpect(jsonPath("$._embedded.scripts", Matchers.not(hasItem( ScriptMatcher.matchScript(dSpaceRunnableList.get(1).getName(), dSpaceRunnableList.get(1).getDescription()) - ))) + )))) .andExpect(jsonPath("$.page", is(PageMatcher.pageEntry(1, 1)))); } diff --git a/dspace/config/spring/api/scripts.xml b/dspace/config/spring/api/scripts.xml index 81acb052c3..1efd83d9db 100644 --- a/dspace/config/spring/api/scripts.xml +++ b/dspace/config/spring/api/scripts.xml @@ -4,18 +4,15 @@ xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd"> - - + - - + - - + diff --git a/dspace/config/spring/rest/scripts.xml b/dspace/config/spring/rest/scripts.xml index dcdd55ebee..2a2070f585 100644 --- a/dspace/config/spring/rest/scripts.xml +++ b/dspace/config/spring/rest/scripts.xml @@ -8,8 +8,7 @@ - - + \ No newline at end of file From 182a8f01f373d25031f9bc1a71c51e8ba8ddbae4 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Wed, 15 Jan 2020 13:49:31 +0100 Subject: [PATCH 006/125] Applied feedback to the MetadataExport and MetadataImport scripts --- .../dspace/app/bulkedit/MetadataExport.java | 14 ++- .../dspace/app/bulkedit/MetadataImport.java | 99 +++++++++++-------- .../app/bulkedit/MetadataImportCLI.java | 4 + ...> MetadataDSpaceCsvExportServiceImpl.java} | 4 +- ...va => MetadataDSpaceCsvExportService.java} | 2 +- .../handler/DSpaceRunnableHandler.java | 5 +- .../CommandLineDSpaceRunnableHandler.java | 9 +- .../scripts/service/ProcessService.java | 12 +++ .../rest/repository/ScriptRestRepository.java | 4 +- .../impl/RestDSpaceRunnableHandler.java | 21 ++-- dspace/config/spring/api/core-services.xml | 2 +- 11 files changed, 107 insertions(+), 69 deletions(-) rename dspace-api/src/main/java/org/dspace/content/{MetadataExportServiceImpl.java => MetadataDSpaceCsvExportServiceImpl.java} (96%) rename dspace-api/src/main/java/org/dspace/content/service/{MetadataExportService.java => MetadataDSpaceCsvExportService.java} (98%) diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java index f6527855f0..47e9fcb6ab 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java @@ -7,9 +7,11 @@ */ package org.dspace.app.bulkedit; +import java.io.OutputStream; + import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; -import org.dspace.content.service.MetadataExportService; +import org.dspace.content.service.MetadataDSpaceCsvExportService; import org.dspace.core.Context; import org.dspace.scripts.DSpaceRunnable; import org.springframework.beans.factory.annotation.Autowired; @@ -29,7 +31,7 @@ public class MetadataExport extends DSpaceRunnable { private boolean exportAllItems = false; @Autowired - private MetadataExportService metadataExportService; + private MetadataDSpaceCsvExportService metadataDSpaceCsvExportService; private MetadataExport() { this.options = constructOptions(); @@ -41,7 +43,7 @@ public class MetadataExport extends DSpaceRunnable { options.addOption("i", "id", true, "ID or handle of thing to export (item, collection, or community)"); options.getOption("i").setType(String.class); options.addOption("f", "file", true, "destination where you want file written"); - options.getOption("f").setType(String.class); + options.getOption("f").setType(OutputStream.class); options.getOption("f").setRequired(true); options.addOption("a", "all", false, "include all metadata fields that are not normally changed (e.g. provenance)"); @@ -61,8 +63,9 @@ public class MetadataExport extends DSpaceRunnable { return; } - DSpaceCSV dSpaceCSV = metadataExportService.handleExport(context, exportAllItems, exportAllMetadata, handle, - handler); + DSpaceCSV dSpaceCSV = metadataDSpaceCsvExportService + .handleExport(context, exportAllItems, exportAllMetadata, handle, + handler); handler.writeFilestream(context, filename, dSpaceCSV.getInputStream(), "exportCSV"); context.restoreAuthSystemState(); context.complete(); @@ -74,6 +77,7 @@ public class MetadataExport extends DSpaceRunnable { if (commandLine.hasOption('h')) { help = true; + return; } // Check a filename is given diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java index 939c0d1de6..759981655e 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java @@ -17,6 +17,7 @@ import java.util.HashSet; import java.util.Iterator; import java.util.List; import java.util.Map; +import java.util.Optional; import java.util.Set; import java.util.UUID; import javax.annotation.Nullable; @@ -177,10 +178,8 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { * @param c The context * @param toImport An array of CSV lines to examine */ - public void initMetadataImport(Context c, DSpaceCSV toImport) { + public void initMetadataImport(DSpaceCSV toImport) { // Store the import settings - this.c = c; - csv = toImport; this.toImport = toImport.getCSVLines(); } @@ -193,7 +192,13 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { // Read commandLines from the CSV file try { - csv = new DSpaceCSV(handler.getFileStream(c, filename), c); + Optional optionalFileStream = handler.getFileStream(c, filename); + if (optionalFileStream.isPresent()) { + csv = new DSpaceCSV(optionalFileStream.get(), c); + } else { + throw new IllegalArgumentException("Error reading file, the file couldn't be found for filename: " + + filename); + } } catch (MetadataImportInvalidHeadingException miihe) { throw miihe; } catch (Exception e) { @@ -201,7 +206,7 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { } // Perform the first import - just highlight differences - initMetadataImport(c, csv); + initMetadataImport(csv); List changes; if (!commandLine.hasOption('s') || validateOnly) { @@ -257,6 +262,14 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { } + /** + * This method determines whether the changes should be applied or not. This is default set to true for the REST + * script as we don't want to interact with the caller. This will be overwritten in the CLI script to ask for + * confirmation + * @param handler Applicable DSpaceRunnableHandler + * @return boolean indicating the value + * @throws IOException If something goes wrong + */ protected boolean determineChange(DSpaceRunnableHandler handler) throws IOException { return true; } @@ -269,6 +282,7 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { if (commandLine.hasOption('h')) { help = true; + return; } // Check a filename is given @@ -1238,7 +1252,7 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { * @param changed Whether or not the changes have been made * @return The number of items that have changed */ - private static int displayChanges(List changes, boolean changed) { + private int displayChanges(List changes, boolean changed) { // Display the changes int changeCounter = 0; for (BulkEditChange change : changes) { @@ -1253,20 +1267,19 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { (change.isDeleted()) || (change.isWithdrawn()) || (change.isReinstated())) { // Show the item Item i = change.getItem(); - - System.out.println("-----------------------------------------------------------"); + handler.logInfo("-----------------------------------------------------------"); if (!change.isNewItem()) { - System.out.println("Changes for item: " + i.getID() + " (" + i.getHandle() + ")"); + handler.logInfo("Changes for item: " + i.getID() + " (" + i.getHandle() + ")"); } else { - System.out.print("New item: "); + handler.logInfo("New item: "); if (i != null) { if (i.getHandle() != null) { - System.out.print(i.getID() + " (" + i.getHandle() + ")"); + handler.logInfo(i.getID() + " (" + i.getHandle() + ")"); } else { - System.out.print(i.getID() + " (in workflow)"); + handler.logInfo(i.getID() + " (in workflow)"); } } - System.out.println(); + handler.logInfo(""); } changeCounter++; } @@ -1274,23 +1287,23 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { // Show actions if (change.isDeleted()) { if (changed) { - System.out.println(" - EXPUNGED!"); + handler.logInfo(" - EXPUNGED!"); } else { - System.out.println(" - EXPUNGE!"); + handler.logInfo(" - EXPUNGE!"); } } if (change.isWithdrawn()) { if (changed) { - System.out.println(" - WITHDRAWN!"); + handler.logInfo(" - WITHDRAWN!"); } else { - System.out.println(" - WITHDRAW!"); + handler.logInfo(" - WITHDRAW!"); } } if (change.isReinstated()) { if (changed) { - System.out.println(" - REINSTATED!"); + handler.logInfo(" - REINSTATED!"); } else { - System.out.println(" - REINSTATE!"); + handler.logInfo(" - REINSTATE!"); } } @@ -1300,11 +1313,11 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { String cHandle = c.getHandle(); String cName = c.getName(); if (!changed) { - System.out.print(" + New owning collection (" + cHandle + "): "); + handler.logInfo(" + New owning collection (" + cHandle + "): "); } else { - System.out.print(" + New owning collection (" + cHandle + "): "); + handler.logInfo(" + New owning collection (" + cHandle + "): "); } - System.out.println(cName); + handler.logInfo(cName); } c = change.getOldOwningCollection(); @@ -1312,11 +1325,11 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { String cHandle = c.getHandle(); String cName = c.getName(); if (!changed) { - System.out.print(" + Old owning collection (" + cHandle + "): "); + handler.logInfo(" + Old owning collection (" + cHandle + "): "); } else { - System.out.print(" + Old owning collection (" + cHandle + "): "); + handler.logInfo(" + Old owning collection (" + cHandle + "): "); } - System.out.println(cName); + handler.logInfo(cName); } } @@ -1325,11 +1338,11 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { String cHandle = c.getHandle(); String cName = c.getName(); if (!changed) { - System.out.print(" + Map to collection (" + cHandle + "): "); + handler.logInfo(" + Map to collection (" + cHandle + "): "); } else { - System.out.print(" + Mapped to collection (" + cHandle + "): "); + handler.logInfo(" + Mapped to collection (" + cHandle + "): "); } - System.out.println(cName); + handler.logInfo(cName); } // Show old mapped collections @@ -1337,11 +1350,11 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { String cHandle = c.getHandle(); String cName = c.getName(); if (!changed) { - System.out.print(" + Un-map from collection (" + cHandle + "): "); + handler.logInfo(" + Un-map from collection (" + cHandle + "): "); } else { - System.out.print(" + Un-mapped from collection (" + cHandle + "): "); + handler.logInfo(" + Un-mapped from collection (" + cHandle + "): "); } - System.out.println(cName); + handler.logInfo(cName); } // Show additions @@ -1354,16 +1367,16 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { md += "[" + metadataValue.getLanguage() + "]"; } if (!changed) { - System.out.print(" + Add (" + md + "): "); + handler.logInfo(" + Add (" + md + "): "); } else { - System.out.print(" + Added (" + md + "): "); + handler.logInfo(" + Added (" + md + "): "); } - System.out.print(metadataValue.getValue()); + handler.logInfo(metadataValue.getValue()); if (isAuthorityControlledField(md)) { - System.out.print(", authority = " + metadataValue.getAuthority()); - System.out.print(", confidence = " + metadataValue.getConfidence()); + handler.logInfo(", authority = " + metadataValue.getAuthority()); + handler.logInfo(", confidence = " + metadataValue.getConfidence()); } - System.out.println(""); + handler.logInfo(""); } // Show removals @@ -1376,16 +1389,16 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { md += "[" + metadataValue.getLanguage() + "]"; } if (!changed) { - System.out.print(" - Remove (" + md + "): "); + handler.logInfo(" - Remove (" + md + "): "); } else { - System.out.print(" - Removed (" + md + "): "); + handler.logInfo(" - Removed (" + md + "): "); } - System.out.print(metadataValue.getValue()); + handler.logInfo(metadataValue.getValue()); if (isAuthorityControlledField(md)) { - System.out.print(", authority = " + metadataValue.getAuthority()); - System.out.print(", confidence = " + metadataValue.getConfidence()); + handler.logInfo(", authority = " + metadataValue.getAuthority()); + handler.logInfo(", confidence = " + metadataValue.getConfidence()); } - System.out.println(""); + handler.logInfo(""); } } return changeCounter; diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCLI.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCLI.java index f7ed5adce5..efc396d68f 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCLI.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCLI.java @@ -13,6 +13,10 @@ import java.io.InputStreamReader; import org.dspace.scripts.handler.DSpaceRunnableHandler; +/** + * CLI variant for the {@link MetadataImport} class + * This has been made so that we can specify the behaviour of the determineChanges method to be specific for the CLI + */ public class MetadataImportCLI extends MetadataImport { @Override diff --git a/dspace-api/src/main/java/org/dspace/content/MetadataExportServiceImpl.java b/dspace-api/src/main/java/org/dspace/content/MetadataDSpaceCsvExportServiceImpl.java similarity index 96% rename from dspace-api/src/main/java/org/dspace/content/MetadataExportServiceImpl.java rename to dspace-api/src/main/java/org/dspace/content/MetadataDSpaceCsvExportServiceImpl.java index 24338954d0..57027a5100 100644 --- a/dspace-api/src/main/java/org/dspace/content/MetadataExportServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/MetadataDSpaceCsvExportServiceImpl.java @@ -15,14 +15,14 @@ import java.util.List; import com.google.common.collect.Iterators; import org.dspace.app.bulkedit.DSpaceCSV; import org.dspace.content.service.ItemService; -import org.dspace.content.service.MetadataExportService; +import org.dspace.content.service.MetadataDSpaceCsvExportService; import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.handle.factory.HandleServiceFactory; import org.dspace.scripts.handler.DSpaceRunnableHandler; import org.springframework.beans.factory.annotation.Autowired; -public class MetadataExportServiceImpl implements MetadataExportService { +public class MetadataDSpaceCsvExportServiceImpl implements MetadataDSpaceCsvExportService { @Autowired private ItemService itemService; diff --git a/dspace-api/src/main/java/org/dspace/content/service/MetadataExportService.java b/dspace-api/src/main/java/org/dspace/content/service/MetadataDSpaceCsvExportService.java similarity index 98% rename from dspace-api/src/main/java/org/dspace/content/service/MetadataExportService.java rename to dspace-api/src/main/java/org/dspace/content/service/MetadataDSpaceCsvExportService.java index 77584ceeb0..aeb956fc49 100644 --- a/dspace-api/src/main/java/org/dspace/content/service/MetadataExportService.java +++ b/dspace-api/src/main/java/org/dspace/content/service/MetadataDSpaceCsvExportService.java @@ -18,7 +18,7 @@ import org.dspace.scripts.handler.DSpaceRunnableHandler; /** * This is the interface to be implemented by a Service that deals with the exporting of Metadata */ -public interface MetadataExportService { +public interface MetadataDSpaceCsvExportService { /** * This method will export DSpaceObject objects depending on the parameters it gets. It can export all the items diff --git a/dspace-api/src/main/java/org/dspace/scripts/handler/DSpaceRunnableHandler.java b/dspace-api/src/main/java/org/dspace/scripts/handler/DSpaceRunnableHandler.java index 543f21855c..078ba6bfa2 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/handler/DSpaceRunnableHandler.java +++ b/dspace-api/src/main/java/org/dspace/scripts/handler/DSpaceRunnableHandler.java @@ -10,6 +10,7 @@ package org.dspace.scripts.handler; import java.io.IOException; import java.io.InputStream; import java.sql.SQLException; +import java.util.Optional; import org.apache.commons.cli.Options; import org.dspace.authorize.AuthorizeException; @@ -93,7 +94,7 @@ public interface DSpaceRunnableHandler { * @throws IOException If something goes wrong * @throws AuthorizeException If something goes wrong */ - public InputStream getFileStream(Context context, String fileName) throws IOException, AuthorizeException; + public Optional getFileStream(Context context, String fileName) throws IOException, AuthorizeException; /** * This method will write the InputStream to either a file on the filesystem or a bitstream in the database @@ -105,5 +106,5 @@ public interface DSpaceRunnableHandler { * @throws IOException If something goes wrong */ public void writeFilestream(Context context, String fileName, InputStream inputStream, String type) - throws IOException; + throws IOException, SQLException, AuthorizeException; } diff --git a/dspace-api/src/main/java/org/dspace/scripts/handler/impl/CommandLineDSpaceRunnableHandler.java b/dspace-api/src/main/java/org/dspace/scripts/handler/impl/CommandLineDSpaceRunnableHandler.java index f7a62b8acf..6775b9a455 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/handler/impl/CommandLineDSpaceRunnableHandler.java +++ b/dspace-api/src/main/java/org/dspace/scripts/handler/impl/CommandLineDSpaceRunnableHandler.java @@ -10,6 +10,7 @@ package org.dspace.scripts.handler.impl; import java.io.File; import java.io.IOException; import java.io.InputStream; +import java.util.Optional; import org.apache.commons.cli.HelpFormatter; import org.apache.commons.cli.Options; @@ -92,12 +93,12 @@ public class CommandLineDSpaceRunnableHandler implements DSpaceRunnableHandler { } @Override - public InputStream getFileStream(Context context, String fileName) throws IOException { + public Optional getFileStream(Context context, String fileName) throws IOException { File file = new File(fileName); - if (!file.isFile()) { - return null; + if (!(file.exists() && file.isFile())) { + return Optional.empty(); } - return FileUtils.openInputStream(file); + return Optional.of(FileUtils.openInputStream(file)); } @Override diff --git a/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java b/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java index b8e78a5f4f..0287faab5c 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java +++ b/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java @@ -108,6 +108,18 @@ public interface ProcessService { */ public void complete(Context context, Process process) throws SQLException; + /** + * The method will create a bitstream from the given inputstream with the given type as metadata and given name + * as name and attach it to the given process + * @param context The relevant DSpace context + * @param process The process for which the bitstream will be made + * @param is The inputstream for the bitstream + * @param type The type of the bitstream + * @param fileName The name of the bitstream + * @throws IOException If something goes wrong + * @throws SQLException If something goes wrong + * @throws AuthorizeException If something goes wrong + */ public void appendFile(Context context, Process process, InputStream is, String type, String fileName) throws IOException, SQLException, AuthorizeException; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java index bc1709598d..a97a5d96fd 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java @@ -143,7 +143,7 @@ public class ScriptRestRepository extends DSpaceRestRepository files, Context context, DSpaceRunnable scriptToExecute, RestDSpaceRunnableHandler restDSpaceRunnableHandler, List args) - throws IOException { + throws IOException, SQLException, AuthorizeException { try { scriptToExecute.initialize(args.toArray(new String[0]), restDSpaceRunnableHandler); checkFileNames(scriptToExecute, files); @@ -160,7 +160,7 @@ public class ScriptRestRepository extends DSpaceRestRepository files) - throws IOException { + throws IOException, SQLException, AuthorizeException { for (MultipartFile file : files) { restDSpaceRunnableHandler .writeFilestream(context, file.getOriginalFilename(), file.getInputStream(), "inputfile"); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java index 2922267e85..0ae8199866 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java @@ -13,6 +13,7 @@ import java.io.PrintWriter; import java.io.StringWriter; import java.sql.SQLException; import java.util.List; +import java.util.Optional; import org.apache.commons.cli.HelpFormatter; import org.apache.commons.cli.Options; @@ -186,11 +187,17 @@ public class RestDSpaceRunnableHandler implements DSpaceRunnableHandler { } @Override - public InputStream getFileStream(Context context, String fileName) throws IOException, AuthorizeException { + public Optional getFileStream(Context context, String fileName) throws IOException, + AuthorizeException { try { Process process = processService.find(context, processId); Bitstream bitstream = processService.getBitstreamByName(context, process, fileName); - return bitstreamService.retrieve(context, bitstream); + InputStream inputStream = bitstreamService.retrieve(context, bitstream); + if (inputStream == null) { + return Optional.empty(); + } else { + return Optional.of(inputStream); + } } catch (SQLException sqlException) { log.error("SQL exception while attempting to find process", sqlException); } @@ -199,13 +206,9 @@ public class RestDSpaceRunnableHandler implements DSpaceRunnableHandler { @Override public void writeFilestream(Context context, String fileName, InputStream inputStream, String type) - throws IOException { - try { - Process process = processService.find(context, processId); - processService.appendFile(context, process, inputStream, type, fileName); - } catch (SQLException | AuthorizeException exception) { - log.error("Exception occurred while attempting to find process", exception); - } + throws IOException, SQLException, AuthorizeException { + Process process = processService.find(context, processId); + processService.appendFile(context, process, inputStream, type, fileName); } /** diff --git a/dspace/config/spring/api/core-services.xml b/dspace/config/spring/api/core-services.xml index 82d596d192..c1778e64e2 100644 --- a/dspace/config/spring/api/core-services.xml +++ b/dspace/config/spring/api/core-services.xml @@ -44,7 +44,7 @@ - + From 2d9e688d95ab065ed0c21a619a8cefb291123d1c Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Mon, 20 Jan 2020 11:43:14 +0100 Subject: [PATCH 007/125] [Task 68281] applied feedback to the metadata-import and metadata-export scripts --- .../dspace/app/bulkedit/MetadataExport.java | 11 ++++++++++ .../dspace/app/bulkedit/MetadataImport.java | 3 --- .../org/dspace/scripts/DSpaceRunnable.java | 18 +++++++++++++++++ .../rest/repository/ScriptRestRepository.java | 5 +++++ dspace/config/registries/process-types.xml | 20 +++++++++++++++++++ 5 files changed, 54 insertions(+), 3 deletions(-) create mode 100644 dspace/config/registries/process-types.xml diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java index 47e9fcb6ab..706a84620e 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java @@ -8,11 +8,13 @@ package org.dspace.app.bulkedit; import java.io.OutputStream; +import java.sql.SQLException; import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; import org.dspace.content.service.MetadataDSpaceCsvExportService; import org.dspace.core.Context; +import org.dspace.eperson.service.EPersonService; import org.dspace.scripts.DSpaceRunnable; import org.springframework.beans.factory.annotation.Autowired; @@ -33,6 +35,9 @@ public class MetadataExport extends DSpaceRunnable { @Autowired private MetadataDSpaceCsvExportService metadataDSpaceCsvExportService; + @Autowired + private EPersonService ePersonService; + private MetadataExport() { this.options = constructOptions(); } @@ -92,5 +97,11 @@ public class MetadataExport extends DSpaceRunnable { exportAllItems = true; } handle = commandLine.getOptionValue('i'); + + try { + context.setCurrentUser(ePersonService.find(context, getEpersonIdentifier())); + } catch (SQLException e) { + handler.handleException(e); + } } } diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java index 759981655e..0c3f697bd8 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java @@ -1279,7 +1279,6 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { handler.logInfo(i.getID() + " (in workflow)"); } } - handler.logInfo(""); } changeCounter++; } @@ -1376,7 +1375,6 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { handler.logInfo(", authority = " + metadataValue.getAuthority()); handler.logInfo(", confidence = " + metadataValue.getConfidence()); } - handler.logInfo(""); } // Show removals @@ -1398,7 +1396,6 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { handler.logInfo(", authority = " + metadataValue.getAuthority()); handler.logInfo(", confidence = " + metadataValue.getConfidence()); } - handler.logInfo(""); } } return changeCounter; diff --git a/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java b/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java index cad875a53b..ac8a67539d 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java +++ b/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java @@ -11,6 +11,7 @@ import java.io.InputStream; import java.sql.SQLException; import java.util.LinkedList; import java.util.List; +import java.util.UUID; import org.apache.commons.cli.CommandLine; import org.apache.commons.cli.DefaultParser; @@ -31,6 +32,7 @@ import org.springframework.beans.factory.annotation.Required; */ public abstract class DSpaceRunnable implements Runnable, BeanNameAware { + private UUID epersonIdentifier; /** * The name of the script */ @@ -178,4 +180,20 @@ public abstract class DSpaceRunnable implements Runnable, BeanNameAware { public String getName() { return name; } + + /** + * Generic getter for the epersonIdentifier + * @return the epersonIdentifier value of this DSpaceRunnable + */ + public UUID getEpersonIdentifier() { + return epersonIdentifier; + } + + /** + * Generic setter for the epersonIdentifier + * @param epersonIdentifier The epersonIdentifier to be set on this DSpaceRunnable + */ + public void setEpersonIdentifier(UUID epersonIdentifier) { + this.epersonIdentifier = epersonIdentifier; + } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java index a97a5d96fd..16b86f397b 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java @@ -30,6 +30,7 @@ import org.dspace.app.rest.projection.Projection; import org.dspace.app.rest.scripts.handler.impl.RestDSpaceRunnableHandler; import org.dspace.authorize.AuthorizeException; import org.dspace.core.Context; +import org.dspace.eperson.EPerson; import org.dspace.scripts.DSpaceCommandLineParameter; import org.dspace.scripts.DSpaceRunnable; import org.dspace.scripts.service.ScriptService; @@ -100,6 +101,10 @@ public class ScriptRestRepository extends DSpaceRestRepository args = constructArgs(dSpaceCommandLineParameters); diff --git a/dspace/config/registries/process-types.xml b/dspace/config/registries/process-types.xml new file mode 100644 index 0000000000..672f8f94bf --- /dev/null +++ b/dspace/config/registries/process-types.xml @@ -0,0 +1,20 @@ + + + + DSpace Process Types + + + + process + http://dspace.org/process + + + + process + type + + + + + + From 130db9531d871edc49af6412665babff082af7df Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Wed, 22 Jan 2020 14:14:01 +0100 Subject: [PATCH 008/125] [Task 68380] added files and file endpoints to the Process endpoints --- .../org/dspace/scripts/DSpaceRunnable.java | 4 +- .../dspace/scripts/ProcessServiceImpl.java | 8 +- .../scripts/service/ProcessService.java | 2 +- .../app/rest/ProcessRestController.java | 107 ++++++++++++++++++ .../link/process/ProcessHalLinkFactory.java | 14 +++ .../ProcessResourceHalLinkFactory.java | 15 ++- .../rest/model/ProcessFileWrapperRest.java | 35 ++++++ .../hateoas/ProcessFileWrapperResource.java | 42 +++++++ .../repository/ProcessRestRepository.java | 76 +++++++++++++ .../rest/repository/ScriptRestRepository.java | 6 + .../app/rest/ProcessRestRepositoryIT.java | 4 +- .../app/rest/ScriptRestRepositoryIT.java | 84 +++++++++++++- .../app/rest/matcher/ProcessMatcher.java | 5 +- .../app/rest/matcher/ScriptMatcher.java | 3 +- .../impl/MockDSpaceRunnableScript.java | 5 + dspace/config/dspace.cfg | 1 + 16 files changed, 391 insertions(+), 20 deletions(-) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessRestController.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessHalLinkFactory.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileWrapperRest.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileWrapperResource.java diff --git a/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java b/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java index ac8a67539d..8d3701a490 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java +++ b/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java @@ -18,6 +18,7 @@ import org.apache.commons.cli.DefaultParser; import org.apache.commons.cli.Option; import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; +import org.apache.commons.lang3.StringUtils; import org.dspace.authorize.service.AuthorizeService; import org.dspace.core.Context; import org.dspace.scripts.handler.DSpaceRunnableHandler; @@ -80,7 +81,8 @@ public abstract class DSpaceRunnable implements Runnable, BeanNameAware { List fileNames = new LinkedList<>(); for (Option option : options.getOptions()) { - if (option.getType() == InputStream.class) { + if (option.getType() == InputStream.class && + StringUtils.isNotBlank(commandLine.getOptionValue(option.getOpt()))) { fileNames.add(commandLine.getOptionValue(option.getOpt())); } } diff --git a/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java b/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java index 67fd151ac9..5fa8ec7699 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java @@ -17,6 +17,7 @@ import java.util.Date; import java.util.List; import java.util.regex.Pattern; +import org.apache.commons.collections4.ListUtils; import org.apache.commons.lang3.StringUtils; import org.apache.logging.log4j.Logger; import org.dspace.authorize.AuthorizeException; @@ -145,11 +146,14 @@ public class ProcessServiceImpl implements ProcessService { } @Override - public void delete(Context context, Process process) throws SQLException { + public void delete(Context context, Process process) throws SQLException, IOException, AuthorizeException { + + for (Bitstream bitstream : ListUtils.emptyIfNull(process.getBitstreams())) { + bitstreamService.delete(context, bitstream); + } processDAO.delete(context, process); log.info(LogManager.getHeader(context, "process_delete", "Process with ID " + process.getID() + " and name " + process.getName() + " has been deleted")); - } @Override diff --git a/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java b/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java index 0287faab5c..28f302f9e3 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java +++ b/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java @@ -129,7 +129,7 @@ public interface ProcessService { * @param process The Process object to be deleted * @throws SQLException If something goes wrong */ - public void delete(Context context, Process process) throws SQLException; + public void delete(Context context, Process process) throws SQLException, IOException, AuthorizeException; /** * This method will be used to update the given Process object in the database diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessRestController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessRestController.java new file mode 100644 index 0000000000..8c9cdd5200 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessRestController.java @@ -0,0 +1,107 @@ +/** + * 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.rest; + +import static org.springframework.hateoas.mvc.ControllerLinkBuilder.linkTo; +import static org.springframework.hateoas.mvc.ControllerLinkBuilder.methodOn; + +import java.sql.SQLException; +import java.util.List; +import java.util.stream.Collectors; + +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import org.dspace.app.rest.link.HalLinkService; +import org.dspace.app.rest.link.process.ProcessResourceHalLinkFactory; +import org.dspace.app.rest.model.BitstreamRest; +import org.dspace.app.rest.model.ProcessRest; +import org.dspace.app.rest.model.hateoas.BitstreamResource; +import org.dspace.app.rest.model.hateoas.ProcessFileWrapperResource; +import org.dspace.app.rest.repository.ProcessRestRepository; +import org.dspace.app.rest.utils.Utils; +import org.dspace.authorize.AuthorizeException; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; +import org.springframework.data.web.PagedResourcesAssembler; +import org.springframework.hateoas.Link; +import org.springframework.hateoas.PagedResources; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RestController; + +@RestController +@RequestMapping("/api/" + ProcessRest.CATEGORY + "/" + ProcessRest.PLURAL_NAME) +public class ProcessRestController { + + private static final Logger log = LogManager.getLogger(); + + @Autowired + HalLinkService linkService; + + @Autowired + private ProcessRestRepository processRestRepository; + + @Autowired + private Utils utils; + + @Autowired + private HalLinkService halLinkService; + + @Autowired + ProcessResourceHalLinkFactory processResourceHalLinkFactory; + + @RequestMapping(method = RequestMethod.GET, value = "/{processId}/files") + public ProcessFileWrapperResource listFilesFromProcess(@PathVariable(name = "processId") Integer processId) + throws SQLException, AuthorizeException { + + if (log.isTraceEnabled()) { + log.trace("Retrieving Files from Process with ID: " + processId); + } + + ProcessFileWrapperResource processFileWrapperResource = + new ProcessFileWrapperResource(processRestRepository.getProcessFileWrapperRest(processId), utils); + halLinkService.addLinks(processFileWrapperResource); + return processFileWrapperResource; + } + + @RequestMapping(method = RequestMethod.GET, value = "/{processId}/files/{fileType}") + public PagedResources listFilesWithTypeFromProcess( + @PathVariable(name = "processId") Integer processId, + @PathVariable(name = "fileType") String fileType, + Pageable pageable, PagedResourcesAssembler assembler) throws SQLException, AuthorizeException { + + if (log.isTraceEnabled()) { + log.trace("Retrieving Files with type " + fileType + " from Process with ID: " + processId); + } + + List bitstreamResources = processRestRepository + .getProcessBitstreamsByType(processId, fileType).stream() + .map(bitstreamRest -> new BitstreamResource(bitstreamRest, utils)) + .collect(Collectors.toList()); + + Page page = utils.getPage(bitstreamResources, pageable); + + Link link = linkTo( + methodOn(this.getClass()).listFilesWithTypeFromProcess(processId, fileType, pageable, assembler)) + .withSelfRel(); + PagedResources result = assembler.toResource(page, link); + + return result; + } + + @RequestMapping(method = RequestMethod.GET, value = "/{processId}/files/name/{fileName:.+}") + public BitstreamResource getBitstreamByName(@PathVariable(name = "processId") Integer processId, + @PathVariable(name = "fileName") String fileName) + throws SQLException, AuthorizeException { + + BitstreamRest bitstreamRest = processRestRepository.getProcessBitstreamByName(processId, fileName); + return new BitstreamResource(bitstreamRest, utils); + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessHalLinkFactory.java new file mode 100644 index 0000000000..11fcb1b71c --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessHalLinkFactory.java @@ -0,0 +1,14 @@ +/** + * 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.rest.link.process; + +import org.dspace.app.rest.ProcessRestController; +import org.dspace.app.rest.link.HalLinkFactory; + +public abstract class ProcessHalLinkFactory extends HalLinkFactory { +} \ No newline at end of file diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java index 4bbf77ff97..44642ce310 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java @@ -9,8 +9,7 @@ package org.dspace.app.rest.link.process; import java.util.LinkedList; -import org.dspace.app.rest.RestResourceController; -import org.dspace.app.rest.link.HalLinkFactory; +import org.dspace.app.rest.ProcessRestController; import org.dspace.app.rest.model.hateoas.ProcessResource; import org.dspace.services.ConfigurationService; import org.springframework.beans.factory.annotation.Autowired; @@ -18,24 +17,24 @@ import org.springframework.data.domain.Pageable; import org.springframework.hateoas.Link; import org.springframework.stereotype.Component; -/** - * This class will provide the ProcessResource with links - */ @Component -public class ProcessResourceHalLinkFactory extends HalLinkFactory { +public class ProcessResourceHalLinkFactory extends ProcessHalLinkFactory { @Autowired private ConfigurationService configurationService; protected void addLinks(ProcessResource halResource, Pageable pageable, LinkedList list) throws Exception { String dspaceRestUrl = configurationService.getProperty("dspace.restUrl"); +// list.add( +// buildLink("script", dspaceRestUrl + "/api/system/scripts/" + halResource.getContent().getScriptName())); + list.add(buildLink("files", getMethodOn().listFilesFromProcess(halResource.getContent().getProcessId()))); list.add( buildLink("script", dspaceRestUrl + "/api/system/scripts/" + halResource.getContent().getScriptName())); } - protected Class getControllerClass() { - return RestResourceController.class; + protected Class getControllerClass() { + return ProcessRestController.class; } protected Class getResourceClass() { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileWrapperRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileWrapperRest.java new file mode 100644 index 0000000000..df9059393e --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileWrapperRest.java @@ -0,0 +1,35 @@ +/** + * 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.rest.model; + +import java.util.List; + +import com.fasterxml.jackson.annotation.JsonIgnore; + +public class ProcessFileWrapperRest { + private Integer processId; + + @JsonIgnore + private List bitstreams; + + public Integer getProcessId() { + return processId; + } + + public void setProcessId(Integer processId) { + this.processId = processId; + } + + public void setBitstreams(List bistreams) { + this.bitstreams = bistreams; + } + + public List getBitstreams() { + return bitstreams; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileWrapperResource.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileWrapperResource.java new file mode 100644 index 0000000000..e2ca726bb7 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileWrapperResource.java @@ -0,0 +1,42 @@ +/** + * 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.rest.model.hateoas; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import org.dspace.app.rest.model.BitstreamRest; +import org.dspace.app.rest.model.MetadataValueRest; +import org.dspace.app.rest.model.ProcessFileWrapperRest; +import org.dspace.app.rest.utils.Utils; + + +public class ProcessFileWrapperResource extends HALResource { + + public ProcessFileWrapperResource(ProcessFileWrapperRest content, Utils utils) { + super(content); + + if (content != null) { + HashMap> bitstreamResourceMap = new HashMap<>(); + for (BitstreamRest bitstreamRest : content.getBitstreams()) { + List fileType = bitstreamRest.getMetadata().getMap().get("process.type"); + if (fileType != null && !fileType.isEmpty()) { + bitstreamResourceMap + .computeIfAbsent(fileType.get(0).getValue(), k -> new ArrayList<>()) + .add(new BitstreamResource(bitstreamRest, utils)); + } + } + + for (Map.Entry> entry : bitstreamResourceMap.entrySet()) { + embedResource(entry.getKey(), entry.getValue()); + } + } + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java index ebfdb4d2a6..03fe8f5bd9 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java @@ -8,16 +8,26 @@ package org.dspace.app.rest.repository; import java.sql.SQLException; +import java.util.Collections; import java.util.List; +import java.util.stream.Collectors; import org.apache.log4j.Logger; +import org.dspace.app.rest.converter.ConverterService; +import org.dspace.app.rest.model.BitstreamRest; +import org.dspace.app.rest.model.ProcessFileWrapperRest; import org.dspace.app.rest.model.ProcessRest; +import org.dspace.app.rest.projection.Projection; +import org.dspace.authorize.AuthorizeException; +import org.dspace.authorize.service.AuthorizeService; +import org.dspace.content.Bitstream; import org.dspace.core.Context; import org.dspace.scripts.Process; import org.dspace.scripts.service.ProcessService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; +import org.springframework.data.rest.webmvc.ResourceNotFoundException; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Component; @@ -32,6 +42,14 @@ public class ProcessRestRepository extends DSpaceRestRepository getProcessBitstreams(Integer processId) throws SQLException, AuthorizeException { + return getProcessBitstreamsByType(processId, null); + } + + public ProcessFileWrapperRest getProcessFileWrapperRest(Integer processId) throws SQLException, AuthorizeException { + ProcessFileWrapperRest processFileWrapperRest = new ProcessFileWrapperRest(); + processFileWrapperRest.setBitstreams(getProcessBitstreams(processId)); + processFileWrapperRest.setProcessId(processId); + + return processFileWrapperRest; + } + + public List getProcessBitstreamsByType(Integer processId, String type) + throws SQLException, AuthorizeException { + Context context = obtainContext(); + Process process = processService.find(context, processId); + if (process == null) { + throw new ResourceNotFoundException("Process with id " + processId + " was not found"); + } + if ((context.getCurrentUser() == null) || (!context.getCurrentUser() + .equals(process.getEPerson()) && !authorizeService + .isAdmin(context))) { + throw new AuthorizeException("The current user is not eligible to view the process with id: " + processId); + } + List bitstreams = processService.getBitstreams(context, process, type); + + if (bitstreams == null) { + return Collections.emptyList(); + } + + return bitstreams.stream() + .map(bitstream -> (BitstreamRest) converterService.toRest(bitstream, Projection.DEFAULT)) + .collect(Collectors.toList()); + + } + + public BitstreamRest getProcessBitstreamByName(Integer processId, String name) + throws SQLException, AuthorizeException { + Context context = obtainContext(); + Process process = processService.find(context, processId); + if (process == null) { + throw new ResourceNotFoundException("Process with id " + processId + " was not found"); + } + if ((context.getCurrentUser() == null) || (!context.getCurrentUser() + .equals(process.getEPerson()) && !authorizeService + .isAdmin(context))) { + throw new AuthorizeException("The current user is not eligible to view the process with id: " + processId); + } + Bitstream bitstream = processService.getBitstreamByName(context, process, name); + + if (bitstream == null) { + throw new ResourceNotFoundException( + "Bitstream with name " + name + " and process id " + processId + " was not found"); + } + + return converterService.toRest(bitstream, Projection.DEFAULT); + } + @Override public Class getDomainClass() { return ProcessRest.class; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java index 16b86f397b..2a1d63e482 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java @@ -172,6 +172,12 @@ public class ScriptRestRepository extends DSpaceRestRepository files) { List fileNames = new LinkedList<>(); for (MultipartFile file : files) { diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ProcessRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ProcessRestRepositoryIT.java index 92c37007b1..c90ad14b19 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ProcessRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ProcessRestRepositoryIT.java @@ -13,6 +13,7 @@ import static org.springframework.test.web.servlet.request.MockMvcRequestBuilder import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; +import java.io.IOException; import java.sql.SQLException; import java.util.LinkedList; @@ -21,6 +22,7 @@ import org.dspace.app.rest.builder.ProcessBuilder; import org.dspace.app.rest.matcher.PageMatcher; import org.dspace.app.rest.matcher.ProcessMatcher; import org.dspace.app.rest.test.AbstractControllerIntegrationTest; +import org.dspace.authorize.AuthorizeException; import org.dspace.content.ProcessStatus; import org.dspace.scripts.DSpaceCommandLineParameter; import org.dspace.scripts.Process; @@ -206,7 +208,7 @@ public class ProcessRestRepositoryIT extends AbstractControllerIntegrationTest { CollectionUtils.emptyIfNull(processService.findAll(context)).stream().forEach(process -> { try { processService.delete(context, process); - } catch (SQLException e) { + } catch (SQLException | IOException | AuthorizeException e) { throw new RuntimeException(e); } }); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java index 96a6d3034d..2be9929e58 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java @@ -10,11 +10,13 @@ package org.dspace.app.rest; import static org.hamcrest.Matchers.containsInAnyOrder; import static org.hamcrest.Matchers.hasItem; import static org.hamcrest.Matchers.is; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.fileUpload; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; +import java.io.IOException; import java.sql.SQLException; import java.util.Arrays; import java.util.LinkedList; @@ -23,6 +25,9 @@ import java.util.stream.Collectors; import com.google.gson.Gson; import org.apache.commons.collections4.CollectionUtils; +import org.dspace.app.rest.builder.CollectionBuilder; +import org.dspace.app.rest.builder.CommunityBuilder; +import org.dspace.app.rest.builder.ItemBuilder; import org.dspace.app.rest.converter.DSpaceRunnableParameterConverter; import org.dspace.app.rest.matcher.PageMatcher; import org.dspace.app.rest.matcher.ProcessMatcher; @@ -30,7 +35,12 @@ import org.dspace.app.rest.matcher.ScriptMatcher; import org.dspace.app.rest.model.ParameterValueRest; import org.dspace.app.rest.projection.Projection; import org.dspace.app.rest.test.AbstractControllerIntegrationTest; +import org.dspace.authorize.AuthorizeException; +import org.dspace.content.Collection; +import org.dspace.content.Community; +import org.dspace.content.Item; import org.dspace.content.ProcessStatus; +import org.dspace.content.service.BitstreamService; import org.dspace.scripts.DSpaceCommandLineParameter; import org.dspace.scripts.DSpaceRunnable; import org.dspace.scripts.service.ProcessService; @@ -38,12 +48,17 @@ import org.hamcrest.Matchers; import org.junit.After; import org.junit.Test; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.MediaType; +import org.springframework.mock.web.MockMultipartFile; public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { @Autowired private ProcessService processService; + @Autowired + private BitstreamService bitstreamService; + @Autowired private List dSpaceRunnableList; @@ -184,8 +199,9 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { parameters.add(new DSpaceCommandLineParameter("-q", null)); List list = parameters.stream() - .map(dSpaceCommandLineParameter -> dSpaceRunnableParameterConverter - .convert(dSpaceCommandLineParameter, Projection.DEFAULT)).collect(Collectors.toList()); + .map(dSpaceCommandLineParameter -> dSpaceRunnableParameterConverter + .convert(dSpaceCommandLineParameter, Projection.DEFAULT)) + .collect(Collectors.toList()); String token = getAuthToken(admin.getEmail(), password); @@ -216,8 +232,9 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { parameters.add(new DSpaceCommandLineParameter("-i", null)); List list = parameters.stream() - .map(dSpaceCommandLineParameter -> dSpaceRunnableParameterConverter - .convert(dSpaceCommandLineParameter, Projection.DEFAULT)).collect(Collectors.toList()); + .map(dSpaceCommandLineParameter -> dSpaceRunnableParameterConverter + .convert(dSpaceCommandLineParameter, Projection.DEFAULT)) + .collect(Collectors.toList()); String token = getAuthToken(admin.getEmail(), password); List acceptableProcessStatuses = new LinkedList<>(); @@ -245,12 +262,69 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { .andExpect(status().isBadRequest()); } + @Test + public void postProcessAdminWithFileSuccess() throws Exception { + LinkedList parameters = new LinkedList<>(); + + parameters.add(new DSpaceCommandLineParameter("-r", "test")); + parameters.add(new DSpaceCommandLineParameter("-i", null)); + + + context.turnOffAuthorisationSystem(); + + parentCommunity = CommunityBuilder.createCommunity(context) + .withName("Parent Community") + .build(); + Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) + .withName("Sub Community") + .build(); + Collection col1 = CollectionBuilder.createCollection(context, child1).withName("Collection 1").build(); + Collection col2 = CollectionBuilder.createCollection(context, child1).withName("Collection 2").build(); + + //2. Three public items that are readable by Anonymous with different subjects + Item publicItem1 = ItemBuilder.createItem(context, col1) + .withTitle("Public item 1") + .withIssueDate("2017-10-17") + .withAuthor("Smith, Donald").withAuthor("Doe, John") + .withSubject("ExtraEntry") + .build(); + + String bitstreamContent = "Hello, World!"; + MockMultipartFile bitstreamFile = new MockMultipartFile("file", + "hello.txt", MediaType.TEXT_PLAIN_VALUE, + bitstreamContent.getBytes()); + parameters.add(new DSpaceCommandLineParameter("-f", "hello.txt")); + + List list = parameters.stream() + .map(dSpaceCommandLineParameter -> dSpaceRunnableParameterConverter + .convert(dSpaceCommandLineParameter, Projection.DEFAULT)) + .collect(Collectors.toList()); + + String token = getAuthToken(admin.getEmail(), password); + List acceptableProcessStatuses = new LinkedList<>(); + acceptableProcessStatuses.addAll(Arrays.asList(ProcessStatus.SCHEDULED, + ProcessStatus.RUNNING, + ProcessStatus.COMPLETED)); + + getClient(token).perform(fileUpload("/api/system/scripts/mock-script/processes").file(bitstreamFile) + .param("properties", + new Gson().toJson(list))) + .andExpect(status().isAccepted()) + .andExpect(jsonPath("$", is( + ProcessMatcher.matchProcess("mock-script", + String.valueOf(admin.getID()), + parameters, + acceptableProcessStatuses)))); + + } + + @After public void destroy() throws Exception { CollectionUtils.emptyIfNull(processService.findAll(context)).stream().forEach(process -> { try { processService.delete(context, process); - } catch (SQLException e) { + } catch (SQLException | AuthorizeException | IOException e) { throw new RuntimeException(e); } }); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/matcher/ProcessMatcher.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/matcher/ProcessMatcher.java index 2ac00eb4ab..cc62c1e9ab 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/matcher/ProcessMatcher.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/matcher/ProcessMatcher.java @@ -65,7 +65,10 @@ public class ProcessMatcher { list.stream().map(dSpaceCommandLineParameter -> ParameterValueMatcher .matchParameterValue(dSpaceCommandLineParameter.getName(), dSpaceCommandLineParameter.getValue())) .collect(Collectors.toList()) - )) + )), + hasJsonPath("$._links.script.href", Matchers.containsString(name)), + hasJsonPath("$._links.files.href", Matchers.containsString("files")), + hasJsonPath("$._links.self.href", Matchers.containsString("api/system/processes")) ); } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/matcher/ScriptMatcher.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/matcher/ScriptMatcher.java index d348ee76c4..c919aadd86 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/matcher/ScriptMatcher.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/matcher/ScriptMatcher.java @@ -32,7 +32,8 @@ public class ScriptMatcher { matchScript("mock-script", "Mocking a script for testing purposes"), hasJsonPath("$.parameters", Matchers.containsInAnyOrder( ParameterMatcher.matchParameter(options.getOption("r")), - ParameterMatcher.matchParameter(options.getOption("i")) + ParameterMatcher.matchParameter(options.getOption("i")), + ParameterMatcher.matchParameter(options.getOption("f")) )) ); } diff --git a/dspace-server-webapp/src/test/java/org/dspace/scripts/impl/MockDSpaceRunnableScript.java b/dspace-server-webapp/src/test/java/org/dspace/scripts/impl/MockDSpaceRunnableScript.java index 5df5c8992b..0d48ad9c9d 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/scripts/impl/MockDSpaceRunnableScript.java +++ b/dspace-server-webapp/src/test/java/org/dspace/scripts/impl/MockDSpaceRunnableScript.java @@ -7,6 +7,8 @@ */ package org.dspace.scripts.impl; +import java.io.InputStream; + import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; import org.dspace.scripts.DSpaceRunnable; @@ -37,6 +39,9 @@ public class MockDSpaceRunnableScript extends DSpaceRunnable { options.addOption("i", "index", false, "description i"); options.getOption("i").setType(boolean.class); options.getOption("i").setRequired(true); + options.addOption("f", "file", true, "source file"); + options.getOption("f").setType(InputStream.class); + options.getOption("f").setRequired(false); return options; } } diff --git a/dspace/config/dspace.cfg b/dspace/config/dspace.cfg index bce46aaba6..38b0b0a7fb 100644 --- a/dspace/config/dspace.cfg +++ b/dspace/config/dspace.cfg @@ -789,6 +789,7 @@ registry.metadata.load = schema-organization-types.xml registry.metadata.load = schema-periodical-types.xml registry.metadata.load = schema-publicationIssue-types.xml registry.metadata.load = schema-publicationVolume-types.xml +registry.metadata.load = process-types.xml From 5265ebd382097d221b9b9bfc2df708b5819f1fa0 Mon Sep 17 00:00:00 2001 From: Kevin Van de Velde Date: Wed, 22 Jan 2020 14:53:42 +0100 Subject: [PATCH 009/125] Removing commented out code --- .../app/rest/link/process/ProcessResourceHalLinkFactory.java | 2 -- 1 file changed, 2 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java index 44642ce310..c71c94adbd 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java @@ -25,8 +25,6 @@ public class ProcessResourceHalLinkFactory extends ProcessHalLinkFactory list) throws Exception { String dspaceRestUrl = configurationService.getProperty("dspace.restUrl"); -// list.add( -// buildLink("script", dspaceRestUrl + "/api/system/scripts/" + halResource.getContent().getScriptName())); list.add(buildLink("files", getMethodOn().listFilesFromProcess(halResource.getContent().getProcessId()))); list.add( buildLink("script", dspaceRestUrl + "/api/system/scripts/" + halResource.getContent().getScriptName())); From 90073abfb7b7ffec2482751dd6ad92939ec874b0 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Tue, 11 Feb 2020 12:41:48 +0100 Subject: [PATCH 010/125] [Task 68534] applied feedback to the metadata import and export script and wrote tests for them --- .../dspace/app/bulkedit/MetadataExport.java | 2 +- .../MetadataDSpaceCsvExportServiceImpl.java | 2 +- .../org/dspace/scripts/ScriptServiceImpl.java | 1 + .../dspaceFolder/assetstore/testImport.csv | 2 + .../config/spring/api/scripts.xml | 4 ++ .../app/bulkedit/MetadataExportTest.java | 65 +++++++++++++++++++ .../app/bulkedit/MetadataImportTest.java | 52 +++++++++++++++ .../impl/TestDSpaceRunnableHandler.java | 36 ++++++++++ .../src/test/resources/test-config.properties | 2 + .../dspace/app/rest/model/ParameterRest.java | 23 +++++++ .../app/rest/ScriptRestRepositoryIT.java | 10 +-- 11 files changed, 193 insertions(+), 6 deletions(-) create mode 100644 dspace-api/src/test/data/dspaceFolder/assetstore/testImport.csv create mode 100644 dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataExportTest.java create mode 100644 dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataImportTest.java create mode 100644 dspace-api/src/test/java/org/dspace/app/scripts/handler/impl/TestDSpaceRunnableHandler.java diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java index 706a84620e..c61c71742c 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java @@ -93,7 +93,7 @@ public class MetadataExport extends DSpaceRunnable { exportAllMetadata = commandLine.hasOption('a'); - if (commandLine.hasOption('i')) { + if (!commandLine.hasOption('i')) { exportAllItems = true; } handle = commandLine.getOptionValue('i'); diff --git a/dspace-api/src/main/java/org/dspace/content/MetadataDSpaceCsvExportServiceImpl.java b/dspace-api/src/main/java/org/dspace/content/MetadataDSpaceCsvExportServiceImpl.java index 57027a5100..2dc0cd5f54 100644 --- a/dspace-api/src/main/java/org/dspace/content/MetadataDSpaceCsvExportServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/MetadataDSpaceCsvExportServiceImpl.java @@ -32,7 +32,7 @@ public class MetadataDSpaceCsvExportServiceImpl implements MetadataDSpaceCsvExpo DSpaceRunnableHandler handler) throws Exception { Iterator toExport = null; - if (!exportAllItems) { + if (exportAllItems) { handler.logInfo("Exporting whole repository WARNING: May take some time!"); toExport = itemService.findAll(context); } else { diff --git a/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java b/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java index 7f1f0b83e6..6e87da849f 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java @@ -19,6 +19,7 @@ import org.springframework.beans.factory.annotation.Autowired; * The implementation for the {@link ScriptService} */ public class ScriptServiceImpl implements ScriptService { + @Autowired private ServiceManager serviceManager; diff --git a/dspace-api/src/test/data/dspaceFolder/assetstore/testImport.csv b/dspace-api/src/test/data/dspaceFolder/assetstore/testImport.csv new file mode 100644 index 0000000000..cb658de4ed --- /dev/null +++ b/dspace-api/src/test/data/dspaceFolder/assetstore/testImport.csv @@ -0,0 +1,2 @@ +id,collection,dc.contributor.author ++,"123456789/2","Donald, SmithImported" diff --git a/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml b/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml index 8072292b28..a151984be0 100644 --- a/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml +++ b/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml @@ -8,6 +8,10 @@ + + + + diff --git a/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataExportTest.java b/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataExportTest.java new file mode 100644 index 0000000000..e08fb62d9c --- /dev/null +++ b/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataExportTest.java @@ -0,0 +1,65 @@ +/** + * 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 junit.framework.TestCase.assertTrue; + +import java.io.File; +import java.io.FileInputStream; +import java.nio.charset.StandardCharsets; + +import org.apache.commons.io.IOUtils; +import org.dspace.AbstractIntegrationTest; +import org.dspace.app.launcher.ScriptLauncher; +import org.dspace.app.scripts.handler.impl.TestDSpaceRunnableHandler; +import org.dspace.content.Collection; +import org.dspace.content.Community; +import org.dspace.content.Item; +import org.dspace.content.WorkspaceItem; +import org.dspace.content.factory.ContentServiceFactory; +import org.dspace.content.service.CollectionService; +import org.dspace.content.service.CommunityService; +import org.dspace.content.service.InstallItemService; +import org.dspace.content.service.ItemService; +import org.dspace.content.service.WorkspaceItemService; +import org.dspace.services.ConfigurationService; +import org.dspace.services.factory.DSpaceServicesFactory; +import org.junit.Test; + +public class MetadataExportTest extends AbstractIntegrationTest { + + private ItemService itemService = ContentServiceFactory.getInstance().getItemService(); + private CollectionService collectionService = ContentServiceFactory.getInstance().getCollectionService(); + private CommunityService communityService = ContentServiceFactory.getInstance().getCommunityService(); + private WorkspaceItemService workspaceItemService = ContentServiceFactory.getInstance().getWorkspaceItemService(); + private InstallItemService installItemService = ContentServiceFactory.getInstance().getInstallItemService(); + private ConfigurationService configurationService = DSpaceServicesFactory.getInstance().getConfigurationService(); + + @Test + public void metadataExportToCsvTest() throws Exception { + context.turnOffAuthorisationSystem(); + Community community = communityService.create(null, context); + Collection collection = collectionService.create(context, community); + WorkspaceItem wi = workspaceItemService.create(context, collection, true); + Item item = wi.getItem(); + itemService.addMetadata(context, item, "dc", "contributor", "author", null, "Donald, Smith"); + item = installItemService.installItem(context, wi); + String fileLocation = configurationService.getProperty("dspace.dir") + testProps.get("test.exportcsv") + .toString(); + + String[] args = new String[] {"metadata-export", "-i", String.valueOf(item.getHandle()), "-f", fileLocation}; + TestDSpaceRunnableHandler testDSpaceRunnableHandler = new TestDSpaceRunnableHandler(); + + ScriptLauncher.handleScript(args, ScriptLauncher.getConfig(kernelImpl), testDSpaceRunnableHandler, kernelImpl); + File file = new File(fileLocation); + String fileContent = IOUtils.toString(new FileInputStream(file), StandardCharsets.UTF_8); + assertTrue(fileContent.contains("Donald, Smith")); + assertTrue(fileContent.contains(String.valueOf(item.getID()))); + + } +} diff --git a/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataImportTest.java b/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataImportTest.java new file mode 100644 index 0000000000..3b649cabf9 --- /dev/null +++ b/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataImportTest.java @@ -0,0 +1,52 @@ +/** + * 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 junit.framework.TestCase.assertTrue; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.AbstractIntegrationTest; +import org.dspace.app.launcher.ScriptLauncher; +import org.dspace.app.scripts.handler.impl.TestDSpaceRunnableHandler; +import org.dspace.content.Community; +import org.dspace.content.Item; +import org.dspace.content.factory.ContentServiceFactory; +import org.dspace.content.service.CollectionService; +import org.dspace.content.service.CommunityService; +import org.dspace.content.service.ItemService; +import org.dspace.services.ConfigurationService; +import org.dspace.services.factory.DSpaceServicesFactory; +import org.junit.Test; + +public class MetadataImportTest extends AbstractIntegrationTest { + + private ItemService itemService = ContentServiceFactory.getInstance().getItemService(); + private CollectionService collectionService = ContentServiceFactory.getInstance().getCollectionService(); + private CommunityService communityService = ContentServiceFactory.getInstance().getCommunityService(); + private ConfigurationService configurationService = DSpaceServicesFactory.getInstance().getConfigurationService(); + + @Test + public void metadataImportTest() throws Exception { + context.turnOffAuthorisationSystem(); + Community community = communityService.create(null, context); + collectionService.create(context, community); + + String fileLocation = configurationService.getProperty("dspace.dir") + testProps.get("test.importcsv") + .toString(); + String[] args = new String[] {"metadata-import", "-f", fileLocation, "-e", eperson.getEmail(), "-s"}; + TestDSpaceRunnableHandler testDSpaceRunnableHandler = new TestDSpaceRunnableHandler(); + + ScriptLauncher.handleScript(args, ScriptLauncher.getConfig(kernelImpl), testDSpaceRunnableHandler, kernelImpl); + Item importedItem = itemService.findAll(context).next(); + assertTrue( + StringUtils.equals( + itemService.getMetadata(importedItem, "dc", "contributor", "author", Item.ANY).get(0).getValue(), + "Donald, SmithImported")); + + } +} diff --git a/dspace-api/src/test/java/org/dspace/app/scripts/handler/impl/TestDSpaceRunnableHandler.java b/dspace-api/src/test/java/org/dspace/app/scripts/handler/impl/TestDSpaceRunnableHandler.java new file mode 100644 index 0000000000..1b5b3fa7ac --- /dev/null +++ b/dspace-api/src/test/java/org/dspace/app/scripts/handler/impl/TestDSpaceRunnableHandler.java @@ -0,0 +1,36 @@ +/** + * 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.scripts.handler.impl; + +import org.dspace.scripts.handler.impl.CommandLineDSpaceRunnableHandler; + +/** + * This class will be used as a DSpaceRunnableHandler for the Tests so that we can stop the handler + * from calling System.exit() when a script would throw an exception + */ +public class TestDSpaceRunnableHandler extends CommandLineDSpaceRunnableHandler { + + private Exception exception = null; + + /** + * We're overriding this method so that we can stop the script from doing the System.exit() if + * an exception within the script is thrown + */ + @Override + public void handleException(String message, Exception e) { + exception = e; + } + + /** + * Generic getter for the exception + * @return the exception value of this TestDSpaceRunnableHandler + */ + public Exception getException() { + return exception; + } +} diff --git a/dspace-api/src/test/resources/test-config.properties b/dspace-api/src/test/resources/test-config.properties index 273d93c968..a61361d328 100644 --- a/dspace-api/src/test/resources/test-config.properties +++ b/dspace-api/src/test/resources/test-config.properties @@ -11,3 +11,5 @@ test.folder.assetstore = ./target/testing/dspace/assetstore #Path for a test file to create bitstreams test.bitstream = ./target/testing/dspace/assetstore/ConstitutionofIreland.pdf +test.exportcsv = /assetstore/test.csv +test.importcsv = /assetstore/testImport.csv diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ParameterRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ParameterRest.java index b24544c1bc..34d0057dc8 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ParameterRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ParameterRest.java @@ -25,6 +25,13 @@ public class ParameterRest { */ private String type; + /** + * Boolean indicating whether the parameter is mandatory or not + */ + private boolean mandatory; + + + public String getName() { return name; } @@ -48,4 +55,20 @@ public class ParameterRest { public void setType(String type) { this.type = type; } + + /** + * Generic getter for the mandatory + * @return the mandatory value of this ParameterRest + */ + public boolean isMandatory() { + return mandatory; + } + + /** + * Generic setter for the mandatory + * @param mandatory The mandatory to be set on this ParameterRest + */ + public void setMandatory(boolean mandatory) { + this.mandatory = mandatory; + } } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java index 2be9929e58..074150f86b 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java @@ -77,7 +77,9 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { ScriptMatcher.matchScript(dSpaceRunnableList.get(1).getName(), dSpaceRunnableList.get(1).getDescription()), ScriptMatcher.matchScript(dSpaceRunnableList.get(2).getName(), - dSpaceRunnableList.get(2).getDescription()) + dSpaceRunnableList.get(2).getDescription()), + ScriptMatcher.matchScript(dSpaceRunnableList.get(3).getName(), + dSpaceRunnableList.get(3).getDescription()) ))); } @@ -116,8 +118,8 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { getClient(token).perform(get("/api/system/scripts").param("size", "1").param("page", "1")) .andExpect(status().isOk()) .andExpect(jsonPath("$._embedded.scripts", hasItem( - ScriptMatcher.matchScript(dSpaceRunnableList.get(0).getName(), - dSpaceRunnableList.get(0).getDescription()) + ScriptMatcher.matchScript(dSpaceRunnableList.get(2).getName(), + dSpaceRunnableList.get(2).getDescription()) ))) .andExpect(jsonPath("$._embedded.scripts", Matchers.not(hasItem( ScriptMatcher.matchScript(dSpaceRunnableList.get(1).getName(), @@ -134,7 +136,7 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { getClient(token).perform(get("/api/system/scripts/mock-script")) .andExpect(status().isOk()) .andExpect(jsonPath("$", ScriptMatcher - .matchMockScript(dSpaceRunnableList.get(2).getOptions()))); + .matchMockScript(dSpaceRunnableList.get(3).getOptions()))); } @Test From e9d56e7c4146e718c5dfb32b369a1dbaf00f69cb Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Mon, 23 Mar 2020 14:13:11 +0100 Subject: [PATCH 011/125] [Task 69724] Scripts&Processes: split configuration and runnable --- .../dspace/app/bulkedit/MetadataExport.java | 45 ++--- .../dspace/app/bulkedit/MetadataImport.java | 93 ++++------ .../dspace/app/launcher/ScriptLauncher.java | 13 +- .../org/dspace/discovery/IndexClient.java | 30 ++- .../org/dspace/scripts/DSpaceRunnable.java | 171 +++++------------- .../org/dspace/scripts/ScriptServiceImpl.java | 17 +- .../configuration}/IndexClientOptions.java | 4 +- .../IndexDiscoveryScriptConfiguration.java | 45 +++++ .../MetadataExportScriptConfiguration.java | 61 +++++++ .../MetadataImportCliScriptConfiguration.java | 24 +++ .../MetadataImportScriptConfiguration.java | 70 +++++++ .../configuration/ScriptConfiguration.java | 103 +++++++++++ .../dspace/scripts/service/ScriptService.java | 8 +- .../config/spring/api/scripts.xml | 8 +- ...MockDSpaceRunnableScriptConfiguration.java | 57 ++++++ .../impl/MockDSpaceRunnableScript.java | 26 +-- .../app/rest/converter/ScriptConverter.java | 18 +- .../rest/repository/ScriptRestRepository.java | 37 ++-- .../app/rest/ScriptRestRepositoryIT.java | 38 ++-- ...MockDSpaceRunnableScriptConfiguration.java | 56 ++++++ .../impl/MockDSpaceRunnableScript.java | 31 +--- dspace/config/spring/api/scripts.xml | 6 +- dspace/config/spring/rest/scripts.xml | 2 +- 23 files changed, 623 insertions(+), 340 deletions(-) rename dspace-api/src/main/java/org/dspace/{discovery => scripts/configuration}/IndexClientOptions.java (96%) create mode 100644 dspace-api/src/main/java/org/dspace/scripts/configuration/IndexDiscoveryScriptConfiguration.java create mode 100644 dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataExportScriptConfiguration.java create mode 100644 dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportCliScriptConfiguration.java create mode 100644 dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportScriptConfiguration.java create mode 100644 dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java create mode 100644 dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java create mode 100644 dspace-server-webapp/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java index c61c71742c..2aa8216ced 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java @@ -7,23 +7,23 @@ */ package org.dspace.app.bulkedit; -import java.io.OutputStream; import java.sql.SQLException; -import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; import org.dspace.content.service.MetadataDSpaceCsvExportService; import org.dspace.core.Context; +import org.dspace.eperson.factory.EPersonServiceFactory; import org.dspace.eperson.service.EPersonService; import org.dspace.scripts.DSpaceRunnable; -import org.springframework.beans.factory.annotation.Autowired; +import org.dspace.scripts.configuration.MetadataExportScriptConfiguration; +import org.dspace.utils.DSpace; /** * Metadata exporter to allow the batch export of metadata into a file * * @author Stuart Lewis */ -public class MetadataExport extends DSpaceRunnable { +public class MetadataExport extends DSpaceRunnable { private Context context = null; private boolean help = false; @@ -32,33 +32,10 @@ public class MetadataExport extends DSpaceRunnable { private boolean exportAllMetadata = false; private boolean exportAllItems = false; - @Autowired - private MetadataDSpaceCsvExportService metadataDSpaceCsvExportService; + private MetadataDSpaceCsvExportService metadataDSpaceCsvExportService = new DSpace().getServiceManager() + .getServicesByType(MetadataDSpaceCsvExportService.class).get(0); - @Autowired - private EPersonService ePersonService; - - private MetadataExport() { - this.options = constructOptions(); - } - - private Options constructOptions() { - Options options = new Options(); - - options.addOption("i", "id", true, "ID or handle of thing to export (item, collection, or community)"); - options.getOption("i").setType(String.class); - options.addOption("f", "file", true, "destination where you want file written"); - options.getOption("f").setType(OutputStream.class); - options.getOption("f").setRequired(true); - options.addOption("a", "all", false, - "include all metadata fields that are not normally changed (e.g. provenance)"); - options.getOption("a").setType(boolean.class); - options.addOption("h", "help", false, "help"); - options.getOption("h").setType(boolean.class); - - - return options; - } + private EPersonService ePersonService = EPersonServiceFactory.getInstance().getEPersonService(); public void internalRun() throws Exception { if (help) { @@ -76,6 +53,12 @@ public class MetadataExport extends DSpaceRunnable { context.complete(); } + @Override + public MetadataExportScriptConfiguration getScriptConfiguration() { + return new DSpace().getServiceManager().getServiceByName("metadata-export", + MetadataExportScriptConfiguration.class); + } + public void setup() throws ParseException { context = new Context(); context.turnOffAuthorisationSystem(); @@ -99,7 +82,7 @@ public class MetadataExport extends DSpaceRunnable { handle = commandLine.getOptionValue('i'); try { - context.setCurrentUser(ePersonService.find(context, getEpersonIdentifier())); + context.setCurrentUser(ePersonService.find(context, getScriptConfiguration().getEpersonIdentifier())); } catch (SQLException e) { handler.handleException(e); } diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java index 0c3f697bd8..bb9be495d2 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java @@ -22,11 +22,11 @@ import java.util.Set; import java.util.UUID; import javax.annotation.Nullable; -import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; import org.apache.commons.lang3.StringUtils; import org.apache.logging.log4j.Logger; import org.dspace.authority.AuthorityValue; +import org.dspace.authority.factory.AuthorityServiceFactory; import org.dspace.authority.service.AuthorityValueService; import org.dspace.authorize.AuthorizeException; import org.dspace.content.Collection; @@ -57,22 +57,23 @@ import org.dspace.core.Context; import org.dspace.core.LogManager; import org.dspace.eperson.EPerson; import org.dspace.eperson.factory.EPersonServiceFactory; +import org.dspace.handle.factory.HandleServiceFactory; import org.dspace.handle.service.HandleService; import org.dspace.scripts.DSpaceRunnable; +import org.dspace.scripts.configuration.MetadataImportScriptConfiguration; import org.dspace.scripts.handler.DSpaceRunnableHandler; +import org.dspace.utils.DSpace; import org.dspace.workflow.WorkflowException; import org.dspace.workflow.WorkflowItem; import org.dspace.workflow.WorkflowService; import org.dspace.workflow.factory.WorkflowServiceFactory; -import org.springframework.beans.factory.InitializingBean; -import org.springframework.beans.factory.annotation.Autowired; /** * Metadata importer to allow the batch import of metadata from a file * * @author Stuart Lewis */ -public class MetadataImport extends DSpaceRunnable implements InitializingBean { +public class MetadataImport extends DSpaceRunnable { /** * The Context */ @@ -150,26 +151,18 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { */ protected static final Logger log = org.apache.logging.log4j.LogManager.getLogger(MetadataImport.class); - @Autowired - protected ItemService itemService; - @Autowired - protected InstallItemService installItemService; - @Autowired - protected CollectionService collectionService; - @Autowired - protected HandleService handleService; - @Autowired - protected WorkspaceItemService workspaceItemService; - @Autowired - protected RelationshipTypeService relationshipTypeService; - @Autowired - protected RelationshipService relationshipService; - @Autowired - protected EntityTypeService entityTypeService; - @Autowired - protected EntityService entityService; - @Autowired - protected AuthorityValueService authorityValueService; + protected ItemService itemService = ContentServiceFactory.getInstance().getItemService(); + protected InstallItemService installItemService = ContentServiceFactory.getInstance().getInstallItemService(); + protected CollectionService collectionService = ContentServiceFactory.getInstance().getCollectionService(); + protected HandleService handleService = HandleServiceFactory.getInstance().getHandleService(); + protected WorkspaceItemService workspaceItemService = ContentServiceFactory.getInstance().getWorkspaceItemService(); + protected RelationshipTypeService relationshipTypeService = ContentServiceFactory.getInstance() + .getRelationshipTypeService(); + protected RelationshipService relationshipService = ContentServiceFactory.getInstance().getRelationshipService(); + protected EntityTypeService entityTypeService = ContentServiceFactory.getInstance().getEntityTypeService(); + protected EntityService entityService = ContentServiceFactory.getInstance().getEntityService(); + protected AuthorityValueService authorityValueService = AuthorityServiceFactory.getInstance() + .getAuthorityValueService(); /** * Create an instance of the metadata importer. Requires a context and an array of CSV lines @@ -189,6 +182,9 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { printHelp(); return; } + if (authorityControlled == null) { + setAuthorizedMetadataFields(); + } // Read commandLines from the CSV file try { @@ -274,6 +270,13 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { return true; } + @Override + public MetadataImportScriptConfiguration getScriptConfiguration() { + return new DSpace().getServiceManager().getServiceByName("metadata-import", + MetadataImportScriptConfiguration.class); + } + + public void setup() throws ParseException { useTemplate = false; filename = null; @@ -340,40 +343,11 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { // Is this a silent run? change = false; } - - public MetadataImport() { - Options options = constructOptions(); - this.options = options; - } - - private Options constructOptions() { - Options options = new Options(); - - options.addOption("f", "file", true, "source file"); - options.getOption("f").setType(InputStream.class); - options.getOption("f").setRequired(true); - options.addOption("e", "email", true, "email address or user id of user (required if adding new items)"); - options.getOption("e").setType(String.class); - options.getOption("e").setRequired(true); - options.addOption("s", "silent", false, - "silent operation - doesn't request confirmation of changes USE WITH CAUTION"); - options.getOption("s").setType(boolean.class); - options.addOption("w", "workflow", false, "workflow - when adding new items, use collection workflow"); - options.getOption("w").setType(boolean.class); - options.addOption("n", "notify", false, - "notify - when adding new items using a workflow, send notification emails"); - options.getOption("n").setType(boolean.class); - options.addOption("v", "validate-only", false, - "validate - just validate the csv, don't run the import"); - options.getOption("v").setType(boolean.class); - options.addOption("t", "template", false, - "template - when adding new items, use the collection template (if it exists)"); - options.getOption("t").setType(boolean.class); - options.addOption("h", "help", false, "help"); - options.getOption("h").setType(boolean.class); - - return options; - } +// +// public MetadataImport() { +// Options options = constructOptions(); +// this.options = options; +// } /** * Run an import. The import can either be read-only to detect changes, or @@ -1844,7 +1818,4 @@ public class MetadataImport extends DSpaceRunnable implements InitializingBean { return foundRelationshipType; } - public void afterPropertiesSet() throws Exception { - setAuthorizedMetadataFields(); - } } \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java b/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java index 1ed9a2ac78..51bda048b4 100644 --- a/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java +++ b/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java @@ -16,9 +16,11 @@ import java.util.TreeMap; import org.apache.commons.cli.ParseException; import org.apache.log4j.Logger; import org.dspace.scripts.DSpaceRunnable; +import org.dspace.scripts.configuration.ScriptConfiguration; import org.dspace.scripts.factory.ScriptServiceFactory; import org.dspace.scripts.handler.DSpaceRunnableHandler; import org.dspace.scripts.handler.impl.CommandLineDSpaceRunnableHandler; +import org.dspace.scripts.service.ScriptService; import org.dspace.servicemanager.DSpaceKernelImpl; import org.dspace.servicemanager.DSpaceKernelInit; import org.dspace.services.RequestService; @@ -55,7 +57,7 @@ public class ScriptLauncher { * @throws FileNotFoundException if file doesn't exist */ public static void main(String[] args) - throws FileNotFoundException, IOException { + throws FileNotFoundException, IOException, IllegalAccessException, InstantiationException { // Initialise the service manager kernel try { kernelImpl = DSpaceKernelInit.getKernel(null); @@ -112,9 +114,14 @@ public class ScriptLauncher { */ public static int handleScript(String[] args, Document commandConfigs, DSpaceRunnableHandler dSpaceRunnableHandler, - DSpaceKernelImpl kernelImpl) { + DSpaceKernelImpl kernelImpl) throws InstantiationException, IllegalAccessException { int status; - DSpaceRunnable script = ScriptServiceFactory.getInstance().getScriptService().getScriptForName(args[0]); + ScriptService scriptService = ScriptServiceFactory.getInstance().getScriptService(); + ScriptConfiguration scriptConfiguration = scriptService.getScriptForName(args[0]); + DSpaceRunnable script = null; + if (scriptConfiguration != null) { + script = scriptService.getDSpaceRunnableForScriptConfiguration(scriptConfiguration); + } if (script != null) { status = executeScript(args, dSpaceRunnableHandler, script); } else { diff --git a/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java b/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java index 2e7b00a617..28f34d1606 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java +++ b/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java @@ -14,7 +14,6 @@ import java.util.Optional; import java.util.UUID; import org.apache.commons.cli.CommandLine; -import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; import org.dspace.content.Collection; import org.dspace.content.Community; @@ -30,17 +29,20 @@ import org.dspace.discovery.indexobject.factory.IndexFactory; import org.dspace.discovery.indexobject.factory.IndexObjectFactoryFactory; import org.dspace.handle.factory.HandleServiceFactory; import org.dspace.scripts.DSpaceRunnable; -import org.springframework.beans.factory.annotation.Autowired; +import org.dspace.scripts.configuration.IndexClientOptions; +import org.dspace.scripts.configuration.IndexDiscoveryScriptConfiguration; +import org.dspace.services.factory.DSpaceServicesFactory; +import org.dspace.utils.DSpace; /** * Class used to reindex dspace communities/collections/items into discovery */ -public class IndexClient extends DSpaceRunnable { +public class IndexClient extends DSpaceRunnable { private Context context; - - @Autowired - private IndexingService indexer; + private IndexingService indexer = DSpaceServicesFactory.getInstance().getServiceManager() + .getServiceByName(IndexingService.class.getName(), + IndexingService.class); private IndexClientOptions indexClientOptions; @@ -144,6 +146,12 @@ public class IndexClient extends DSpaceRunnable { handler.logInfo("Done with indexing"); } + @Override + public IndexDiscoveryScriptConfiguration getScriptConfiguration() { + return new DSpace().getServiceManager().getServiceByName("index-discovery", + IndexDiscoveryScriptConfiguration.class); + } + public void setup() throws ParseException { try { context = new Context(Context.Mode.READ_ONLY); @@ -151,18 +159,8 @@ public class IndexClient extends DSpaceRunnable { } catch (Exception e) { throw new ParseException("Unable to create a new DSpace Context: " + e.getMessage()); } - indexClientOptions = IndexClientOptions.getIndexClientOption(commandLine); } - - /** - * Constructor for this class. This will ensure that the Options are created and set appropriately. - */ - private IndexClient() { - Options options = IndexClientOptions.constructOptions(); - this.options = options; - } - /** * Indexes the given object and all children, if applicable. * diff --git a/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java b/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java index 8d3701a490..2a8e6d4e9d 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java +++ b/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java @@ -8,10 +8,8 @@ package org.dspace.scripts; import java.io.InputStream; -import java.sql.SQLException; import java.util.LinkedList; import java.util.List; -import java.util.UUID; import org.apache.commons.cli.CommandLine; import org.apache.commons.cli.DefaultParser; @@ -19,111 +17,24 @@ import org.apache.commons.cli.Option; import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; import org.apache.commons.lang3.StringUtils; -import org.dspace.authorize.service.AuthorizeService; -import org.dspace.core.Context; +import org.dspace.scripts.configuration.ScriptConfiguration; import org.dspace.scripts.handler.DSpaceRunnableHandler; -import org.springframework.beans.factory.BeanNameAware; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Required; -/** - * This abstract class is the class that should be extended by each script. - * it provides the basic variables to be hold by the script as well as the means to initialize, parse and run the script - * Every DSpaceRunnable that is implemented in this way should be defined in the scripts.xml config file as a bean - */ -public abstract class DSpaceRunnable implements Runnable, BeanNameAware { +public abstract class DSpaceRunnable implements Runnable { - private UUID epersonIdentifier; - /** - * The name of the script - */ - private String name; - /** - * The description of the script - */ - private String description; /** * The CommandLine object for the script that'll hold the information */ protected CommandLine commandLine; - /** - * The possible options for this script - */ - protected Options options; + /** * The handler that deals with this script. This handler can currently either be a RestDSpaceRunnableHandler or * a CommandlineDSpaceRunnableHandler depending from where the script is called */ protected DSpaceRunnableHandler handler; - @Autowired - private AuthorizeService authorizeService; + public abstract T getScriptConfiguration(); - public String getDescription() { - return description; - } - - @Required - public void setDescription(String description) { - this.description = description; - } - - public Options getOptions() { - return options; - } - - /** - * This method will traverse all the options and it'll grab options defined as an InputStream type to then save - * the filename specified by that option in a list of Strings that'll be returned in the end - * @return The list of Strings representing filenames from the options given to the script - */ - public List getFileNamesFromInputStreamOptions() { - List fileNames = new LinkedList<>(); - - for (Option option : options.getOptions()) { - if (option.getType() == InputStream.class && - StringUtils.isNotBlank(commandLine.getOptionValue(option.getOpt()))) { - fileNames.add(commandLine.getOptionValue(option.getOpt())); - } - } - - return fileNames; - } - - /** - * This method will take the primitive array of String objects that represent the parameters given to the String - * and it'll parse these into a CommandLine object that can be used by the script to retrieve the data - * @param args The primitive array of Strings representing the parameters - * @throws ParseException If something goes wrong - */ - private void parse(String[] args) throws ParseException { - commandLine = new DefaultParser().parse(getOptions(), args); - setup(); - } - - /** - * This method will call upon the {@link DSpaceRunnableHandler#printHelp(Options, String)} method with the script's - * options and name - */ - public void printHelp() { - handler.printHelp(options, name); - } - - - /** - * This is the run() method from the Runnable interface that we implement. This method will handle the running - * of the script and all the database modifications needed for the Process object that resulted from this script - */ - @Override - public void run() { - try { - handler.start(); - internalRun(); - handler.handleCompletion(); - } catch (Exception e) { - handler.handleException(e); - } - } private void setHandler(DSpaceRunnableHandler dSpaceRunnableHandler) { this.handler = dSpaceRunnableHandler; @@ -142,11 +53,15 @@ public abstract class DSpaceRunnable implements Runnable, BeanNameAware { } /** - * This method has to be included in every script and this will be the main execution block for the script that'll - * contain all the logic needed - * @throws Exception If something goes wrong + * This method will take the primitive array of String objects that represent the parameters given to the String + * and it'll parse these into a CommandLine object that can be used by the script to retrieve the data + * @param args The primitive array of Strings representing the parameters + * @throws ParseException If something goes wrong */ - public abstract void internalRun() throws Exception; + private void parse(String[] args) throws ParseException { + commandLine = new DefaultParser().parse(getScriptConfiguration().getOptions(), args); + setup(); + } /** * This method has to be included in every script and handles the setup of the script by parsing the CommandLine @@ -156,46 +71,50 @@ public abstract class DSpaceRunnable implements Runnable, BeanNameAware { public abstract void setup() throws ParseException; /** - * This method will return if the script is allowed to execute in the given context. This is by default set - * to the currentUser in the context being an admin, however this can be overwritten by each script individually - * if different rules apply - * @param context The relevant DSpace context - * @return A boolean indicating whether the script is allowed to execute or not + * This is the run() method from the Runnable interface that we implement. This method will handle the running + * of the script and all the database modifications needed for the Process object that resulted from this script */ - public boolean isAllowedToExecute(Context context) { + @Override + public void run() { try { - return authorizeService.isAdmin(context); - } catch (SQLException e) { - handler.logError("Error occured when trying to verify permissions for script: " + name); + handler.start(); + internalRun(); + handler.handleCompletion(); + } catch (Exception e) { + handler.handleException(e); } - return false; - } - - public void setBeanName(String beanName) { - this.name = beanName; } /** - * Generic getter for the name - * @return the name value of this DSpaceRunnable + * This method has to be included in every script and this will be the main execution block for the script that'll + * contain all the logic needed + * @throws Exception If something goes wrong */ - public String getName() { - return name; + public abstract void internalRun() throws Exception; + + /** + * This method will call upon the {@link DSpaceRunnableHandler#printHelp(Options, String)} method with the script's + * options and name + */ + public void printHelp() { + handler.printHelp(getScriptConfiguration().getOptions(), getScriptConfiguration().getName()); } /** - * Generic getter for the epersonIdentifier - * @return the epersonIdentifier value of this DSpaceRunnable + * This method will traverse all the options and it'll grab options defined as an InputStream type to then save + * the filename specified by that option in a list of Strings that'll be returned in the end + * @return The list of Strings representing filenames from the options given to the script */ - public UUID getEpersonIdentifier() { - return epersonIdentifier; - } + public List getFileNamesFromInputStreamOptions() { + List fileNames = new LinkedList<>(); - /** - * Generic setter for the epersonIdentifier - * @param epersonIdentifier The epersonIdentifier to be set on this DSpaceRunnable - */ - public void setEpersonIdentifier(UUID epersonIdentifier) { - this.epersonIdentifier = epersonIdentifier; + for (Option option : getScriptConfiguration().getOptions().getOptions()) { + if (option.getType() == InputStream.class && + StringUtils.isNotBlank(commandLine.getOptionValue(option.getOpt()))) { + fileNames.add(commandLine.getOptionValue(option.getOpt())); + } + } + + return fileNames; } } diff --git a/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java b/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java index 6e87da849f..4fe5c8954a 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java @@ -12,6 +12,7 @@ import java.util.stream.Collectors; import org.dspace.core.Context; import org.dspace.kernel.ServiceManager; +import org.dspace.scripts.configuration.ScriptConfiguration; import org.dspace.scripts.service.ScriptService; import org.springframework.beans.factory.annotation.Autowired; @@ -24,13 +25,19 @@ public class ScriptServiceImpl implements ScriptService { private ServiceManager serviceManager; @Override - public DSpaceRunnable getScriptForName(String name) { - return serviceManager.getServiceByName(name, DSpaceRunnable.class); + public ScriptConfiguration getScriptForName(String name) { + return serviceManager.getServiceByName(name, ScriptConfiguration.class); } @Override - public List getDSpaceRunnables(Context context) { - return serviceManager.getServicesByType(DSpaceRunnable.class).stream().filter( - dSpaceRunnable -> dSpaceRunnable.isAllowedToExecute(context)).collect(Collectors.toList()); + public List getScriptConfigurations(Context context) { + return serviceManager.getServicesByType(ScriptConfiguration.class).stream().filter( + scriptConfiguration -> scriptConfiguration.isAllowedToExecute(context)).collect(Collectors.toList()); + } + + @Override + public DSpaceRunnable getDSpaceRunnableForScriptConfiguration(ScriptConfiguration scriptToExecute) + throws IllegalAccessException, InstantiationException { + return scriptToExecute.getDspaceRunnableClass().newInstance(); } } diff --git a/dspace-api/src/main/java/org/dspace/discovery/IndexClientOptions.java b/dspace-api/src/main/java/org/dspace/scripts/configuration/IndexClientOptions.java similarity index 96% rename from dspace-api/src/main/java/org/dspace/discovery/IndexClientOptions.java rename to dspace-api/src/main/java/org/dspace/scripts/configuration/IndexClientOptions.java index 4b29fbbf27..1a0819543f 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/IndexClientOptions.java +++ b/dspace-api/src/main/java/org/dspace/scripts/configuration/IndexClientOptions.java @@ -6,7 +6,7 @@ * http://www.dspace.org/license/ */ -package org.dspace.discovery; +package org.dspace.scripts.configuration; import org.apache.commons.cli.CommandLine; import org.apache.commons.cli.Options; @@ -35,7 +35,7 @@ public enum IndexClientOptions { * @param commandLine The relevant CommandLine for the index-discovery script * @return The index-discovery option to be ran, parsed from the CommandLine */ - protected static IndexClientOptions getIndexClientOption(CommandLine commandLine) { + public static IndexClientOptions getIndexClientOption(CommandLine commandLine) { if (commandLine.hasOption("h")) { return IndexClientOptions.HELP; } else if (commandLine.hasOption("r")) { diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/IndexDiscoveryScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/scripts/configuration/IndexDiscoveryScriptConfiguration.java new file mode 100644 index 0000000000..080b750675 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/scripts/configuration/IndexDiscoveryScriptConfiguration.java @@ -0,0 +1,45 @@ +/** + * 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.scripts.configuration; + +import java.sql.SQLException; + +import org.apache.commons.cli.Options; +import org.dspace.authorize.service.AuthorizeService; +import org.dspace.core.Context; +import org.dspace.discovery.IndexClient; +import org.dspace.scripts.DSpaceRunnable; +import org.springframework.beans.factory.annotation.Autowired; + +public class IndexDiscoveryScriptConfiguration extends ScriptConfiguration { + + @Autowired + private AuthorizeService authorizeService; + + @Override + public Class getDspaceRunnableClass() { + return IndexClient.class; + } + + @Override + public boolean isAllowedToExecute(Context context) { + try { + return authorizeService.isAdmin(context); + } catch (SQLException e) { + return false; + } + } + + @Override + public Options getOptions() { + if (options == null) { + super.options = IndexClientOptions.constructOptions(); + } + return options; + } +} diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataExportScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataExportScriptConfiguration.java new file mode 100644 index 0000000000..6243169ab1 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataExportScriptConfiguration.java @@ -0,0 +1,61 @@ +/** + * 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.scripts.configuration; + +import java.io.OutputStream; +import java.sql.SQLException; + +import org.apache.commons.cli.Options; +import org.dspace.app.bulkedit.MetadataExport; +import org.dspace.authorize.service.AuthorizeService; +import org.dspace.core.Context; +import org.dspace.scripts.DSpaceRunnable; +import org.springframework.beans.factory.annotation.Autowired; + +public class MetadataExportScriptConfiguration extends ScriptConfiguration { + + @Autowired + private AuthorizeService authorizeService; + + @Override + public Class getDspaceRunnableClass() { + return MetadataExport.class; + } + + @Override + public boolean isAllowedToExecute(Context context) { + try { + return authorizeService.isAdmin(context); + } catch (SQLException e) { + return false; + } + } + + @Override + public Options getOptions() { + if (options == null) { + Options options = new Options(); + + options.addOption("i", "id", true, "ID or handle of thing to export (item, collection, or community)"); + options.getOption("i").setType(String.class); + options.addOption("f", "file", true, "destination where you want file written"); + options.getOption("f").setType(OutputStream.class); + options.getOption("f").setRequired(true); + options.addOption("a", "all", false, + "include all metadata fields that are not normally changed (e.g. provenance)"); + options.getOption("a").setType(boolean.class); + options.addOption("h", "help", false, "help"); + options.getOption("h").setType(boolean.class); + + + super.options = options; + } + return options; + } + +} diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportCliScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportCliScriptConfiguration.java new file mode 100644 index 0000000000..9ed0c48d2f --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportCliScriptConfiguration.java @@ -0,0 +1,24 @@ +/** + * 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.scripts.configuration; + +import org.dspace.app.bulkedit.MetadataImportCLI; +import org.dspace.authorize.service.AuthorizeService; +import org.dspace.scripts.DSpaceRunnable; +import org.springframework.beans.factory.annotation.Autowired; + +public class MetadataImportCliScriptConfiguration extends MetadataImportScriptConfiguration { + + @Autowired + private AuthorizeService authorizeService; + + @Override + public Class getDspaceRunnableClass() { + return MetadataImportCLI.class; + } +} diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportScriptConfiguration.java new file mode 100644 index 0000000000..06269eaddd --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportScriptConfiguration.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.scripts.configuration; + +import java.io.InputStream; +import java.sql.SQLException; + +import org.apache.commons.cli.Options; +import org.dspace.app.bulkedit.MetadataImport; +import org.dspace.authorize.service.AuthorizeService; +import org.dspace.core.Context; +import org.dspace.scripts.DSpaceRunnable; +import org.springframework.beans.factory.annotation.Autowired; + +public class MetadataImportScriptConfiguration extends ScriptConfiguration { + + @Autowired + private AuthorizeService authorizeService; + + @Override + public Class getDspaceRunnableClass() { + return MetadataImport.class; + } + + @Override + public boolean isAllowedToExecute(Context context) { + try { + return authorizeService.isAdmin(context); + } catch (SQLException e) { + return false; + } + } + @Override + public Options getOptions() { + if (options == null) { + Options options = new Options(); + + options.addOption("f", "file", true, "source file"); + options.getOption("f").setType(InputStream.class); + options.getOption("f").setRequired(true); + options.addOption("e", "email", true, "email address or user id of user (required if adding new items)"); + options.getOption("e").setType(String.class); + options.getOption("e").setRequired(true); + options.addOption("s", "silent", false, + "silent operation - doesn't request confirmation of changes USE WITH CAUTION"); + options.getOption("s").setType(boolean.class); + options.addOption("w", "workflow", false, "workflow - when adding new items, use collection workflow"); + options.getOption("w").setType(boolean.class); + options.addOption("n", "notify", false, + "notify - when adding new items using a workflow, send notification emails"); + options.getOption("n").setType(boolean.class); + options.addOption("v", "validate-only", false, + "validate - just validate the csv, don't run the import"); + options.getOption("v").setType(boolean.class); + options.addOption("t", "template", false, + "template - when adding new items, use the collection template (if it exists)"); + options.getOption("t").setType(boolean.class); + options.addOption("h", "help", false, "help"); + options.getOption("h").setType(boolean.class); + + super.options = options; + } + return options; + } +} diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java new file mode 100644 index 0000000000..06a44fcfa5 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java @@ -0,0 +1,103 @@ +/** + * 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.scripts.configuration; + +import java.util.UUID; + +import org.apache.commons.cli.Options; +import org.dspace.core.Context; +import org.dspace.scripts.DSpaceRunnable; +import org.springframework.beans.factory.BeanNameAware; + +public abstract class ScriptConfiguration implements BeanNameAware { + + /** + * The possible options for this script + */ + protected Options options; + + private String description; + + private String name; + + private UUID epersonIdentifier; + + /** + * Generic getter for the description + * @return the description value of this ScriptConfiguration + */ + public String getDescription() { + return description; + } + + /** + * Generic setter for the description + * @param description The description to be set on this ScriptConfiguration + */ + public void setDescription(String description) { + this.description = description; + } + + /** + * Generic getter for the name + * @return the name value of this ScriptConfiguration + */ + public String getName() { + return name; + } + + /** + * Generic setter for the name + * @param name The name to be set on this ScriptConfiguration + */ + public void setName(String name) { + this.name = name; + } + + /** + * Generic getter for the dspaceRunnableClass + * @return the dspaceRunnableClass value of this ScriptConfiguration + */ + public abstract Class getDspaceRunnableClass(); + + /** + * This method will return if the script is allowed to execute in the given context. This is by default set + * to the currentUser in the context being an admin, however this can be overwritten by each script individually + * if different rules apply + * @param context The relevant DSpace context + * @return A boolean indicating whether the script is allowed to execute or not + */ + public abstract boolean isAllowedToExecute(Context context); + + /** + * Generic getter for the options + * @return the options value of this ScriptConfiguration + */ + public abstract Options getOptions(); + + @Override + public void setBeanName(String beanName) { + this.name = beanName; + } + + /** + * Generic getter for the epersonIdentifier + * @return the epersonIdentifier value of this ScriptConfiguration + */ + public UUID getEpersonIdentifier() { + return epersonIdentifier; + } + + /** + * Generic setter for the epersonIdentifier + * @param epersonIdentifier The epersonIdentifier to be set on this ScriptConfiguration + */ + public void setEpersonIdentifier(UUID epersonIdentifier) { + this.epersonIdentifier = epersonIdentifier; + } +} diff --git a/dspace-api/src/main/java/org/dspace/scripts/service/ScriptService.java b/dspace-api/src/main/java/org/dspace/scripts/service/ScriptService.java index fc680bd612..2b9a81402d 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/service/ScriptService.java +++ b/dspace-api/src/main/java/org/dspace/scripts/service/ScriptService.java @@ -11,6 +11,7 @@ import java.util.List; import org.dspace.core.Context; import org.dspace.scripts.DSpaceRunnable; +import org.dspace.scripts.configuration.ScriptConfiguration; /** * This service will deal with logic to handle DSpaceRunnable objects @@ -22,12 +23,15 @@ public interface ScriptService { * @param name The name that the script has to match * @return The matching DSpaceRunnable script */ - DSpaceRunnable getScriptForName(String name); + ScriptConfiguration getScriptForName(String name); /** * This method will return a list of DSpaceRunnable objects for which the given Context is authorized to use them * @param context The relevant DSpace context * @return The list of accessible DSpaceRunnable scripts for this context */ - List getDSpaceRunnables(Context context); + List getScriptConfigurations(Context context); + + DSpaceRunnable getDSpaceRunnableForScriptConfiguration(ScriptConfiguration scriptToExecute) + throws IllegalAccessException, InstantiationException; } diff --git a/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml b/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml index a151984be0..374470432d 100644 --- a/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml +++ b/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml @@ -4,19 +4,19 @@ xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd"> - + - + - + - + diff --git a/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java b/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java new file mode 100644 index 0000000000..e6b84a5e1c --- /dev/null +++ b/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java @@ -0,0 +1,57 @@ +/** + * 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.scripts; + +import java.io.InputStream; +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.dspace.scripts.impl.MockDSpaceRunnableScript; +import org.springframework.beans.factory.annotation.Autowired; + +public class MockDSpaceRunnableScriptConfiguration extends ScriptConfiguration { + + + @Autowired + private AuthorizeService authorizeService; + + @Override + public Class getDspaceRunnableClass() { + return MockDSpaceRunnableScript.class; + } + + @Override + public boolean isAllowedToExecute(Context context) { + try { + return authorizeService.isAdmin(context); + } catch (SQLException e) { + return false; + } + } + + @Override + public Options getOptions() { + if (options == null) { + Options options = new Options(); + + options.addOption("r", "remove", true, "description r"); + options.getOption("r").setType(String.class); + options.addOption("i", "index", false, "description i"); + options.getOption("i").setType(boolean.class); + options.getOption("i").setRequired(true); + options.addOption("f", "file", true, "source file"); + options.getOption("f").setType(InputStream.class); + options.getOption("f").setRequired(false); + super.options = options; + } + return options; + } +} diff --git a/dspace-api/src/test/java/org/dspace/scripts/impl/MockDSpaceRunnableScript.java b/dspace-api/src/test/java/org/dspace/scripts/impl/MockDSpaceRunnableScript.java index 75f723d64b..960927e90a 100644 --- a/dspace-api/src/test/java/org/dspace/scripts/impl/MockDSpaceRunnableScript.java +++ b/dspace-api/src/test/java/org/dspace/scripts/impl/MockDSpaceRunnableScript.java @@ -7,19 +7,20 @@ */ package org.dspace.scripts.impl; -import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; import org.dspace.scripts.DSpaceRunnable; +import org.dspace.scripts.MockDSpaceRunnableScriptConfiguration; +import org.dspace.utils.DSpace; -public class MockDSpaceRunnableScript extends DSpaceRunnable { - - private MockDSpaceRunnableScript() { - Options options = constructOptions(); - this.options = options; +public class MockDSpaceRunnableScript extends DSpaceRunnable { + @Override + public void internalRun() throws Exception { } @Override - public void internalRun() throws Exception { + public MockDSpaceRunnableScriptConfiguration getScriptConfiguration() { + return new DSpace().getServiceManager() + .getServiceByName("mock-script", MockDSpaceRunnableScriptConfiguration.class); } @Override @@ -28,15 +29,4 @@ public class MockDSpaceRunnableScript extends DSpaceRunnable { throw new ParseException("-i is a mandatory parameter"); } } - - private Options constructOptions() { - Options options = new Options(); - - options.addOption("r", "remove", true, "description r"); - options.getOption("r").setType(String.class); - options.addOption("i", "index", true, "description i"); - options.getOption("i").setType(boolean.class); - options.getOption("i").setRequired(true); - return options; - } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ScriptConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ScriptConverter.java index a307974ee9..edd828be18 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ScriptConverter.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ScriptConverter.java @@ -15,7 +15,7 @@ import org.apache.commons.collections4.CollectionUtils; import org.dspace.app.rest.model.ParameterRest; import org.dspace.app.rest.model.ScriptRest; import org.dspace.app.rest.projection.Projection; -import org.dspace.scripts.DSpaceRunnable; +import org.dspace.scripts.configuration.ScriptConfiguration; import org.springframework.stereotype.Component; /** @@ -23,18 +23,18 @@ import org.springframework.stereotype.Component; * of {@link ScriptRest} */ @Component -public class ScriptConverter implements DSpaceConverter { +public class ScriptConverter implements DSpaceConverter { @Override - public ScriptRest convert(DSpaceRunnable script, Projection projection) { + public ScriptRest convert(ScriptConfiguration scriptConfiguration, Projection projection) { ScriptRest scriptRest = new ScriptRest(); scriptRest.setProjection(projection); - scriptRest.setDescription(script.getDescription()); - scriptRest.setId(script.getName()); - scriptRest.setName(script.getName()); + scriptRest.setDescription(scriptConfiguration.getDescription()); + scriptRest.setId(scriptConfiguration.getName()); + scriptRest.setName(scriptConfiguration.getName()); List parameterRestList = new LinkedList<>(); - for (Option option : CollectionUtils.emptyIfNull(script.getOptions().getOptions())) { + for (Option option : CollectionUtils.emptyIfNull(scriptConfiguration.getOptions().getOptions())) { ParameterRest parameterRest = new ParameterRest(); parameterRest.setDescription(option.getDescription()); parameterRest.setName((option.getOpt() != null ? "-" + option.getOpt() : "--" + option.getLongOpt())); @@ -47,7 +47,7 @@ public class ScriptConverter implements DSpaceConverter getModelClass() { - return DSpaceRunnable.class; + public Class getModelClass() { + return ScriptConfiguration.class; } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java index 43b2711809..4762c46771 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java @@ -32,6 +32,7 @@ import org.dspace.core.Context; import org.dspace.eperson.EPerson; import org.dspace.scripts.DSpaceCommandLineParameter; import org.dspace.scripts.DSpaceRunnable; +import org.dspace.scripts.configuration.ScriptConfiguration; import org.dspace.scripts.service.ScriptService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.domain.Page; @@ -57,10 +58,10 @@ public class ScriptRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { - List dSpaceRunnables = scriptService.getDSpaceRunnables(context); - return converter.toRestPage(utils.getPage(dSpaceRunnables, pageable), utils.obtainProjection()); + List scriptConfigurations = scriptService.getScriptConfigurations(context); + return converter.toRestPage(utils.getPage(scriptConfigurations, pageable), utils.obtainProjection()); } @Override @@ -88,12 +89,13 @@ public class ScriptRestRepository extends DSpaceRestRepository files) throws SQLException, IOException, AuthorizeException { + List files) + throws SQLException, IOException, AuthorizeException, IllegalAccessException, InstantiationException { Context context = obtainContext(); String properties = requestService.getCurrentRequest().getServletRequest().getParameter("properties"); List dSpaceCommandLineParameters = processPropertiesToDSpaceCommandLineParameters(properties); - DSpaceRunnable scriptToExecute = scriptService.getScriptForName(scriptName); + ScriptConfiguration scriptToExecute = scriptService.getScriptForName(scriptName); if (scriptToExecute == null) { throw new DSpaceBadRequestException("The script for name: " + scriptName + " wasn't found"); } @@ -145,16 +147,17 @@ public class ScriptRestRepository extends DSpaceRestRepository files, Context context, DSpaceRunnable scriptToExecute, + private void runDSpaceScript(List files, Context context, ScriptConfiguration scriptToExecute, RestDSpaceRunnableHandler restDSpaceRunnableHandler, List args) - throws IOException, SQLException, AuthorizeException { + throws IOException, SQLException, AuthorizeException, InstantiationException, IllegalAccessException { + DSpaceRunnable dSpaceRunnable = scriptService.getDSpaceRunnableForScriptConfiguration(scriptToExecute); try { - scriptToExecute.initialize(args.toArray(new String[0]), restDSpaceRunnableHandler); - checkFileNames(scriptToExecute, files); + dSpaceRunnable.initialize(args.toArray(new String[0]), restDSpaceRunnableHandler); + checkFileNames(dSpaceRunnable, files); processFiles(context, restDSpaceRunnableHandler, files); - restDSpaceRunnableHandler.schedule(scriptToExecute); + restDSpaceRunnableHandler.schedule(dSpaceRunnable); } catch (ParseException e) { - scriptToExecute.printHelp(); + dSpaceRunnable.printHelp(); restDSpaceRunnableHandler .handleException( "Failed to parse the arguments given to the script with name: " + scriptToExecute.getName() @@ -174,10 +177,10 @@ public class ScriptRestRepository extends DSpaceRestRepository files) { + private void checkFileNames(DSpaceRunnable dSpaceRunnable, List files) { List fileNames = new LinkedList<>(); for (MultipartFile file : files) { String fileName = file.getOriginalFilename(); @@ -188,7 +191,7 @@ public class ScriptRestRepository extends DSpaceRestRepository fileNamesFromOptions = scriptToExecute.getFileNamesFromInputStreamOptions(); + List fileNamesFromOptions = dSpaceRunnable.getFileNamesFromInputStreamOptions(); if (!fileNames.containsAll(fileNamesFromOptions)) { throw new UnprocessableEntityException("Files given in properties aren't all present in the request"); } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java index 074150f86b..526fa0aabd 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java @@ -42,7 +42,7 @@ import org.dspace.content.Item; import org.dspace.content.ProcessStatus; import org.dspace.content.service.BitstreamService; import org.dspace.scripts.DSpaceCommandLineParameter; -import org.dspace.scripts.DSpaceRunnable; +import org.dspace.scripts.configuration.ScriptConfiguration; import org.dspace.scripts.service.ProcessService; import org.hamcrest.Matchers; import org.junit.After; @@ -60,7 +60,7 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { private BitstreamService bitstreamService; @Autowired - private List dSpaceRunnableList; + private List scriptConfigurations; @Autowired private DSpaceRunnableParameterConverter dSpaceRunnableParameterConverter; @@ -72,14 +72,14 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { getClient(token).perform(get("/api/system/scripts")) .andExpect(status().isOk()) .andExpect(jsonPath("$._embedded.scripts", containsInAnyOrder( - ScriptMatcher.matchScript(dSpaceRunnableList.get(0).getName(), - dSpaceRunnableList.get(0).getDescription()), - ScriptMatcher.matchScript(dSpaceRunnableList.get(1).getName(), - dSpaceRunnableList.get(1).getDescription()), - ScriptMatcher.matchScript(dSpaceRunnableList.get(2).getName(), - dSpaceRunnableList.get(2).getDescription()), - ScriptMatcher.matchScript(dSpaceRunnableList.get(3).getName(), - dSpaceRunnableList.get(3).getDescription()) + ScriptMatcher.matchScript(scriptConfigurations.get(0).getName(), + scriptConfigurations.get(0).getDescription()), + ScriptMatcher.matchScript(scriptConfigurations.get(1).getName(), + scriptConfigurations.get(1).getDescription()), + ScriptMatcher.matchScript(scriptConfigurations.get(2).getName(), + scriptConfigurations.get(2).getDescription()), + ScriptMatcher.matchScript(scriptConfigurations.get(3).getName(), + scriptConfigurations.get(3).getDescription()) ))); } @@ -104,12 +104,12 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { getClient(token).perform(get("/api/system/scripts").param("size", "1")) .andExpect(status().isOk()) .andExpect(jsonPath("$._embedded.scripts", Matchers.not(Matchers.hasItem( - ScriptMatcher.matchScript(dSpaceRunnableList.get(0).getName(), - dSpaceRunnableList.get(0).getDescription()) + ScriptMatcher.matchScript(scriptConfigurations.get(0).getName(), + scriptConfigurations.get(0).getDescription()) )))) .andExpect(jsonPath("$._embedded.scripts", hasItem( - ScriptMatcher.matchScript(dSpaceRunnableList.get(1).getName(), - dSpaceRunnableList.get(1).getDescription()) + ScriptMatcher.matchScript(scriptConfigurations.get(3).getName(), + scriptConfigurations.get(3).getDescription()) ))) .andExpect(jsonPath("$.page", is(PageMatcher.pageEntry(0, 1)))); @@ -118,12 +118,12 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { getClient(token).perform(get("/api/system/scripts").param("size", "1").param("page", "1")) .andExpect(status().isOk()) .andExpect(jsonPath("$._embedded.scripts", hasItem( - ScriptMatcher.matchScript(dSpaceRunnableList.get(2).getName(), - dSpaceRunnableList.get(2).getDescription()) + ScriptMatcher.matchScript(scriptConfigurations.get(0).getName(), + scriptConfigurations.get(0).getDescription()) ))) .andExpect(jsonPath("$._embedded.scripts", Matchers.not(hasItem( - ScriptMatcher.matchScript(dSpaceRunnableList.get(1).getName(), - dSpaceRunnableList.get(1).getDescription()) + ScriptMatcher.matchScript(scriptConfigurations.get(1).getName(), + scriptConfigurations.get(1).getDescription()) )))) .andExpect(jsonPath("$.page", is(PageMatcher.pageEntry(1, 1)))); @@ -136,7 +136,7 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { getClient(token).perform(get("/api/system/scripts/mock-script")) .andExpect(status().isOk()) .andExpect(jsonPath("$", ScriptMatcher - .matchMockScript(dSpaceRunnableList.get(3).getOptions()))); + .matchMockScript(scriptConfigurations.get(3).getOptions()))); } @Test diff --git a/dspace-server-webapp/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java b/dspace-server-webapp/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java new file mode 100644 index 0000000000..0a441caca3 --- /dev/null +++ b/dspace-server-webapp/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java @@ -0,0 +1,56 @@ +/** + * 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.scripts; + +import java.io.InputStream; +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.dspace.scripts.impl.MockDSpaceRunnableScript; +import org.springframework.beans.factory.annotation.Autowired; + +public class MockDSpaceRunnableScriptConfiguration extends ScriptConfiguration { + + @Autowired + private AuthorizeService authorizeService; + + @Override + public Class getDspaceRunnableClass() { + return MockDSpaceRunnableScript.class; + } + + @Override + public boolean isAllowedToExecute(Context context) { + try { + return authorizeService.isAdmin(context); + } catch (SQLException e) { + return false; + } + } + + @Override + public Options getOptions() { + if (options == null) { + Options options = new Options(); + + options.addOption("r", "remove", true, "description r"); + options.getOption("r").setType(String.class); + options.addOption("i", "index", false, "description i"); + options.getOption("i").setType(boolean.class); + options.getOption("i").setRequired(true); + options.addOption("f", "file", true, "source file"); + options.getOption("f").setType(InputStream.class); + options.getOption("f").setRequired(false); + super.options = options; + } + return options; + } +} diff --git a/dspace-server-webapp/src/test/java/org/dspace/scripts/impl/MockDSpaceRunnableScript.java b/dspace-server-webapp/src/test/java/org/dspace/scripts/impl/MockDSpaceRunnableScript.java index 0d48ad9c9d..960927e90a 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/scripts/impl/MockDSpaceRunnableScript.java +++ b/dspace-server-webapp/src/test/java/org/dspace/scripts/impl/MockDSpaceRunnableScript.java @@ -7,21 +7,20 @@ */ package org.dspace.scripts.impl; -import java.io.InputStream; - -import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; import org.dspace.scripts.DSpaceRunnable; +import org.dspace.scripts.MockDSpaceRunnableScriptConfiguration; +import org.dspace.utils.DSpace; -public class MockDSpaceRunnableScript extends DSpaceRunnable { - - private MockDSpaceRunnableScript() { - Options options = constructOptions(); - this.options = options; +public class MockDSpaceRunnableScript extends DSpaceRunnable { + @Override + public void internalRun() throws Exception { } @Override - public void internalRun() throws Exception { + public MockDSpaceRunnableScriptConfiguration getScriptConfiguration() { + return new DSpace().getServiceManager() + .getServiceByName("mock-script", MockDSpaceRunnableScriptConfiguration.class); } @Override @@ -30,18 +29,4 @@ public class MockDSpaceRunnableScript extends DSpaceRunnable { throw new ParseException("-i is a mandatory parameter"); } } - - private Options constructOptions() { - Options options = new Options(); - - options.addOption("r", "remove", true, "description r"); - options.getOption("r").setType(String.class); - options.addOption("i", "index", false, "description i"); - options.getOption("i").setType(boolean.class); - options.getOption("i").setRequired(true); - options.addOption("f", "file", true, "source file"); - options.getOption("f").setType(InputStream.class); - options.getOption("f").setRequired(false); - return options; - } } diff --git a/dspace/config/spring/api/scripts.xml b/dspace/config/spring/api/scripts.xml index 1efd83d9db..2225828fce 100644 --- a/dspace/config/spring/api/scripts.xml +++ b/dspace/config/spring/api/scripts.xml @@ -4,15 +4,15 @@ xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd"> - + - + - + diff --git a/dspace/config/spring/rest/scripts.xml b/dspace/config/spring/rest/scripts.xml index 2a2070f585..61e7597869 100644 --- a/dspace/config/spring/rest/scripts.xml +++ b/dspace/config/spring/rest/scripts.xml @@ -8,7 +8,7 @@ - + \ No newline at end of file From 25ca31f8cf7a0e4da0bef4da4f812d51102228f9 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Mon, 23 Mar 2020 14:44:55 +0100 Subject: [PATCH 012/125] [Task 69724] Scripts&Processes: cleanup and javadoc --- .../dspace/app/bulkedit/MetadataImport.java | 5 ----- .../org/dspace/scripts/DSpaceRunnable.java | 4 ++++ .../IndexDiscoveryScriptConfiguration.java | 3 +++ .../MetadataExportScriptConfiguration.java | 3 +++ .../MetadataImportCliScriptConfiguration.java | 3 +++ .../MetadataImportScriptConfiguration.java | 4 ++++ .../configuration/ScriptConfiguration.java | 2 +- .../dspace/scripts/service/ScriptService.java | 18 ++++++++++++++---- 8 files changed, 32 insertions(+), 10 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java index bb9be495d2..75da4733ff 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java @@ -343,11 +343,6 @@ public class MetadataImport extends DSpaceRunnable implements R */ protected DSpaceRunnableHandler handler; + /** + * This method will return the Configuration that the implementing DSpaceRunnable uses + * @return The {@link ScriptConfiguration} that this implementing DspaceRunnable uses + */ public abstract T getScriptConfiguration(); diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/IndexDiscoveryScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/scripts/configuration/IndexDiscoveryScriptConfiguration.java index 080b750675..8eadfd6d56 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/configuration/IndexDiscoveryScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/scripts/configuration/IndexDiscoveryScriptConfiguration.java @@ -16,6 +16,9 @@ import org.dspace.discovery.IndexClient; import org.dspace.scripts.DSpaceRunnable; import org.springframework.beans.factory.annotation.Autowired; +/** + * The {@link ScriptConfiguration} for the {@link IndexClient} script + */ public class IndexDiscoveryScriptConfiguration extends ScriptConfiguration { @Autowired diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataExportScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataExportScriptConfiguration.java index 6243169ab1..cab8b14758 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataExportScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataExportScriptConfiguration.java @@ -17,6 +17,9 @@ import org.dspace.core.Context; import org.dspace.scripts.DSpaceRunnable; import org.springframework.beans.factory.annotation.Autowired; +/** + * The {@link ScriptConfiguration} for the {@link MetadataExport} script + */ public class MetadataExportScriptConfiguration extends ScriptConfiguration { @Autowired diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportCliScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportCliScriptConfiguration.java index 9ed0c48d2f..cc00b99aca 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportCliScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportCliScriptConfiguration.java @@ -12,6 +12,9 @@ import org.dspace.authorize.service.AuthorizeService; import org.dspace.scripts.DSpaceRunnable; import org.springframework.beans.factory.annotation.Autowired; +/** + * The {@link ScriptConfiguration} for the {@link org.dspace.app.bulkedit.MetadataImportCLI} CLI script + */ public class MetadataImportCliScriptConfiguration extends MetadataImportScriptConfiguration { @Autowired diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportScriptConfiguration.java index 06269eaddd..4559557469 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportScriptConfiguration.java @@ -17,6 +17,9 @@ import org.dspace.core.Context; import org.dspace.scripts.DSpaceRunnable; import org.springframework.beans.factory.annotation.Autowired; +/** + * The {@link ScriptConfiguration} for the {@link MetadataImport} script + */ public class MetadataImportScriptConfiguration extends ScriptConfiguration { @Autowired @@ -35,6 +38,7 @@ public class MetadataImportScriptConfiguration extends ScriptConfiguration { return false; } } + @Override public Options getOptions() { if (options == null) { diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java index 06a44fcfa5..b0df0006ab 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java @@ -75,7 +75,7 @@ public abstract class ScriptConfiguration implements BeanNameAware { public abstract boolean isAllowedToExecute(Context context); /** - * Generic getter for the options + * The getter for the options of the Script * @return the options value of this ScriptConfiguration */ public abstract Options getOptions(); diff --git a/dspace-api/src/main/java/org/dspace/scripts/service/ScriptService.java b/dspace-api/src/main/java/org/dspace/scripts/service/ScriptService.java index 2b9a81402d..e1506cba7c 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/service/ScriptService.java +++ b/dspace-api/src/main/java/org/dspace/scripts/service/ScriptService.java @@ -19,19 +19,29 @@ import org.dspace.scripts.configuration.ScriptConfiguration; public interface ScriptService { /** - * This method will return the DSpaceRunnable that has the name that's equal to the name given in the parameters + * This method will return the ScriptConfiguration that has the name that's equal to the name given in the + * parameters * @param name The name that the script has to match - * @return The matching DSpaceRunnable script + * @return The matching ScriptConfiguration */ ScriptConfiguration getScriptForName(String name); /** - * This method will return a list of DSpaceRunnable objects for which the given Context is authorized to use them + * This method will return a list of ScriptConfiguration objects for which the given Context is authorized * @param context The relevant DSpace context - * @return The list of accessible DSpaceRunnable scripts for this context + * @return The list of accessible ScriptConfiguration scripts for this context */ List getScriptConfigurations(Context context); + /** + * This method will create a new instance of the DSpaceRunnable that's linked with this Scriptconfiguration + * It'll grab the DSpaceRunnable class from the ScriptConfiguration's variables and create a new instance of it + * to return + * @param scriptToExecute The relevant ScriptConfiguration + * @return The new instance of the DSpaceRunnable class + * @throws IllegalAccessException If something goes wrong + * @throws InstantiationException If something goes wrong + */ DSpaceRunnable getDSpaceRunnableForScriptConfiguration(ScriptConfiguration scriptToExecute) throws IllegalAccessException, InstantiationException; } From f5ccb432f26d377905cd4c453b2c7d2c21efdea9 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Tue, 24 Mar 2020 14:44:34 +0100 Subject: [PATCH 013/125] [Task 69976] initial implementation of extra permission check for subresources --- .../main/java/org/dspace/core/Constants.java | 2 +- .../app/rest/converter/ConverterService.java | 17 +++++++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/dspace-api/src/main/java/org/dspace/core/Constants.java b/dspace-api/src/main/java/org/dspace/core/Constants.java index 8feb2434f8..16e30ed06f 100644 --- a/dspace-api/src/main/java/org/dspace/core/Constants.java +++ b/dspace-api/src/main/java/org/dspace/core/Constants.java @@ -239,7 +239,7 @@ public class Constants { */ public static int getTypeID(String type) { for (int i = 0; i < typeText.length; i++) { - if (typeText[i].equals(type)) { + if (typeText[i].equalsIgnoreCase(type)) { return i; } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java index 295634599b..8bb5973137 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java @@ -19,12 +19,15 @@ import javax.annotation.PostConstruct; import org.apache.log4j.Logger; import org.dspace.app.rest.link.HalLinkFactory; import org.dspace.app.rest.link.HalLinkService; +import org.dspace.app.rest.model.BaseObjectRest; import org.dspace.app.rest.model.RestAddressableModel; import org.dspace.app.rest.model.RestModel; import org.dspace.app.rest.model.hateoas.HALResource; import org.dspace.app.rest.projection.DefaultProjection; import org.dspace.app.rest.projection.Projection; +import org.dspace.app.rest.security.DSpacePermissionEvaluator; import org.dspace.app.rest.utils.Utils; +import org.dspace.authorize.AuthorizeException; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.config.BeanDefinition; import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider; @@ -34,6 +37,8 @@ import org.springframework.data.domain.PageImpl; import org.springframework.data.domain.Pageable; import org.springframework.hateoas.Link; import org.springframework.hateoas.Resource; +import org.springframework.security.access.AccessDeniedException; +import org.springframework.security.core.context.SecurityContextHolder; import org.springframework.stereotype.Component; import org.springframework.stereotype.Service; @@ -64,6 +69,9 @@ public class ConverterService { @Autowired private List projections; + @Autowired + private DSpacePermissionEvaluator dSpacePermissionEvaluator; + /** * Converts the given model object to a rest object, using the appropriate {@link DSpaceConverter} and * the given projection. @@ -86,6 +94,12 @@ public class ConverterService { M transformedModel = projection.transformModel(modelObject); DSpaceConverter converter = requireConverter(modelObject.getClass()); R restObject = converter.convert(transformedModel, projection); + if (restObject instanceof BaseObjectRest) { + if (!dSpacePermissionEvaluator.hasPermission(SecurityContextHolder.getContext().getAuthentication(), restObject, "READ")) { + log.info("Access denied on " + restObject.getClass()); + return null; + } + } if (restObject instanceof RestModel) { return (R) projection.transformRest((RestModel) restObject); } @@ -177,6 +191,9 @@ public class ConverterService { * @return the fully converted resource, with all automatic links and embeds applied. */ public T toResource(RestModel restObject, Link... oldLinks) { + if (restObject == null) { + return null; + } T halResource = getResource(restObject); if (restObject instanceof RestAddressableModel) { utils.embedOrLinkClassLevelRels(halResource, oldLinks); From 984de8434d315b549ae8ea55f020619ab39dcd55 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Wed, 25 Mar 2020 09:30:21 +0100 Subject: [PATCH 014/125] [Task 69976] moved uppercase instance to RestObjectPermissionEvaluatorPlugin and hid null values from the paged list --- .../src/main/java/org/dspace/core/Constants.java | 2 +- .../dspace/app/rest/RestResourceController.java | 15 +++++++++++++-- .../RestObjectPermissionEvaluatorPlugin.java | 3 ++- 3 files changed, 16 insertions(+), 4 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/core/Constants.java b/dspace-api/src/main/java/org/dspace/core/Constants.java index 16e30ed06f..8feb2434f8 100644 --- a/dspace-api/src/main/java/org/dspace/core/Constants.java +++ b/dspace-api/src/main/java/org/dspace/core/Constants.java @@ -239,7 +239,7 @@ public class Constants { */ public static int getTypeID(String type) { for (int i = 0; i < typeText.length; i++) { - if (typeText[i].equalsIgnoreCase(type)) { + if (typeText[i].equals(type)) { return i; } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java index ab338af966..2d0c710c16 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java @@ -812,9 +812,9 @@ public class RestResourceController implements InitializingBean { } else { link = linkTo(this.getClass(), apiCategory, model).slash(uuid).slash(subpath).withSelfRel(); } - + Page restModelPage = getRestModelsWithoutNullValues(page, pageResult); return new Resource(new EmbeddedPage(link.getHref(), - pageResult.map(converter::toResource), null, subpath)); + restModelPage.map(converter::toResource), null, subpath)); } else { RestModel object = (RestModel) linkMethod.invoke(linkRepository, request, uuid, page, utils.obtainProjection()); @@ -896,6 +896,17 @@ public class RestResourceController implements InitializingBean { } + private Page getRestModelsWithoutNullValues(Pageable page, + Page pageResult) { + ArrayList content = new ArrayList<>(); + pageResult.getContent().forEach(o -> { + if (o != null) { + content.add(o); + } + }); + return (Page) new PageImpl(content, page, content.size()); + } + /** * Find all * diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RestObjectPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RestObjectPermissionEvaluatorPlugin.java index 6ee17f8420..855519ccc2 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RestObjectPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RestObjectPermissionEvaluatorPlugin.java @@ -9,6 +9,7 @@ package org.dspace.app.rest.security; import java.io.Serializable; +import org.apache.commons.lang3.StringUtils; import org.dspace.app.rest.model.BaseObjectRest; import org.dspace.app.rest.model.patch.Patch; import org.springframework.security.core.Authentication; @@ -34,7 +35,7 @@ public abstract class RestObjectPermissionEvaluatorPlugin implements RestPermis public boolean hasPermission(Authentication authentication, Object targetDomainObject, Object permission) { BaseObjectRest restObject = (BaseObjectRest) targetDomainObject; - return hasPermission(authentication, restObject.getId(), restObject.getType(), permission); + return hasPermission(authentication, restObject.getId(), StringUtils.upperCase(restObject.getType()), permission); } @Override From e4a63316991f3bce5dc244616dcc4437546f6600 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Wed, 25 Mar 2020 14:01:51 +0100 Subject: [PATCH 015/125] [Task 69976] start fixing tests and permission checks --- ...nFeatureRestPermissionEvaluatorPlugin.java | 25 ++++++++++ .../rest/AuthorizationFeatureServiceIT.java | 5 +- .../rest/AuthorizationRestRepositoryIT.java | 46 +++++++++++-------- .../rest/BitstreamFormatRestRepositoryIT.java | 21 +++++---- .../app/rest/CollectionRestRepositoryIT.java | 7 +-- .../app/rest/CommunityRestRepositoryIT.java | 7 +-- .../rest/MetadataSchemaRestRepositoryIT.java | 7 +-- .../authorization/CCLicenseFeatureRestIT.java | 17 ++++--- .../authorization/ReinstateFeatureRestIT.java | 21 ++++----- .../authorization/WithdrawFeatureRestIT.java | 21 ++++----- 10 files changed, 108 insertions(+), 69 deletions(-) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationFeatureRestPermissionEvaluatorPlugin.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationFeatureRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationFeatureRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..6b8a8af4c4 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationFeatureRestPermissionEvaluatorPlugin.java @@ -0,0 +1,25 @@ +package org.dspace.app.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.AuthorizationFeatureRest; +import org.dspace.app.rest.model.PoolTaskRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +/** + * This class determines that any AuthorizationFeatureRest object can be viewed as it'll be a subresource of + * AuthorizationRest + */ +@Component +public class AuthorizationFeatureRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(AuthorizationFeatureRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationFeatureServiceIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationFeatureServiceIT.java index 58b5d1a730..f73ed06357 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationFeatureServiceIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationFeatureServiceIT.java @@ -23,6 +23,7 @@ import org.dspace.app.rest.authorization.AuthorizationFeature; import org.dspace.app.rest.authorization.AuthorizationFeatureService; import org.dspace.app.rest.authorization.TrueForAdminsFeature; import org.dspace.app.rest.converter.ConverterService; +import org.dspace.app.rest.converter.SiteConverter; import org.dspace.app.rest.model.CollectionRest; import org.dspace.app.rest.model.SiteRest; import org.dspace.app.rest.projection.DefaultProjection; @@ -60,7 +61,7 @@ public class AuthorizationFeatureServiceIT extends AbstractIntegrationTestWithDa private SiteService siteService; @Autowired - private ConverterService converterService; + private SiteConverter siteConverter; @Autowired private AuthorizationFeatureService authzFeatureService; @@ -143,7 +144,7 @@ public class AuthorizationFeatureServiceIT extends AbstractIntegrationTestWithDa */ public void isAuthorizedTest() throws Exception { Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, DefaultProjection.DEFAULT); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); AuthorizationFeature alwaysTrue = authzFeatureService.find(AlwaysTrueFeature.NAME); AuthorizationFeature alwaysFalse = authzFeatureService.find(AlwaysFalseFeature.NAME); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationRestRepositoryIT.java index a73a3aabc6..ac26ec001b 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationRestRepositoryIT.java @@ -31,7 +31,10 @@ import org.dspace.app.rest.authorization.TrueForUsersInGroupTestFeature; import org.dspace.app.rest.builder.CommunityBuilder; import org.dspace.app.rest.builder.EPersonBuilder; import org.dspace.app.rest.builder.GroupBuilder; +import org.dspace.app.rest.converter.CommunityConverter; import org.dspace.app.rest.converter.ConverterService; +import org.dspace.app.rest.converter.EPersonConverter; +import org.dspace.app.rest.converter.SiteConverter; import org.dspace.app.rest.matcher.AuthorizationMatcher; import org.dspace.app.rest.model.BaseObjectRest; import org.dspace.app.rest.model.CommunityRest; @@ -68,8 +71,13 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration private AuthorizationFeatureService authorizationFeatureService; @Autowired - private ConverterService converterService; + private SiteConverter siteConverter; + @Autowired + private EPersonConverter ePersonConverter; + + @Autowired + private CommunityConverter communityConverter; @Autowired private ConfigurationService configurationService; @@ -149,7 +157,7 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration */ public void findOneTest() throws Exception { Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, DefaultProjection.DEFAULT); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); // define three authorizations that we know must exists Authorization authAdminSite = new Authorization(admin, trueForAdmins, siteRest); @@ -191,7 +199,7 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration */ public void findOneUnauthorizedTest() throws Exception { Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, DefaultProjection.DEFAULT); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); // define two authorizations that we know must exists Authorization authAdminSite = new Authorization(admin, alwaysTrue, siteRest); @@ -215,7 +223,7 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration public void findOneForbiddenTest() throws Exception { context.turnOffAuthorisationSystem(); Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, DefaultProjection.DEFAULT); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); EPerson testEPerson = EPersonBuilder.createEPerson(context) .withEmail("test-authorization@example.com") .withPassword(password).build(); @@ -251,8 +259,8 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration public void findOneNotFoundTest() throws Exception { context.turnOffAuthorisationSystem(); Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, DefaultProjection.DEFAULT); - EPersonRest epersonRest = converterService.toRest(eperson, DefaultProjection.DEFAULT); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); + EPersonRest epersonRest = ePersonConverter.convert(eperson, DefaultProjection.DEFAULT); context.restoreAuthSystemState(); String epersonToken = getAuthToken(eperson.getEmail(), password); @@ -337,7 +345,7 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration */ public void findOneInternalServerErrorTest() throws Exception { Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, DefaultProjection.DEFAULT); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); // define two authorizations that we know will throw exceptions Authorization authAdminSite = new Authorization(admin, alwaysException, siteRest); Authorization authNormalUserSite = new Authorization(eperson, alwaysException, siteRest); @@ -364,7 +372,7 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration */ public void findByObjectTest() throws Exception { Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, converterService.getProjection(DefaultProjection.NAME)); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); String siteUri = utils.linkToSingleResource(siteRest, "self").getHref(); // disarm the alwaysThrowExceptionFeature @@ -700,7 +708,7 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration */ public void findByObjectUnauthorizedTest() throws Exception { Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, converterService.getProjection(DefaultProjection.NAME)); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); String siteUri = utils.linkToSingleResource(siteRest, "self").getHref(); // disarm the alwaysThrowExceptionFeature @@ -727,7 +735,7 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration */ public void findByObjectForbiddenTest() throws Exception { Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, converterService.getProjection(DefaultProjection.NAME)); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); String siteUri = utils.linkToSingleResource(siteRest, "self").getHref(); context.turnOffAuthorisationSystem(); EPerson anotherEperson = EPersonBuilder.createEPerson(context).withEmail("another@example.com") @@ -756,7 +764,7 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration */ public void findByObjectInternalServerErrorTest() throws Exception { Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, converterService.getProjection(DefaultProjection.NAME)); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); String siteUri = utils.linkToSingleResource(siteRest, "self").getHref(); // verify that it works for administrators @@ -801,7 +809,7 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration public void findByObjectAndFeatureTest() throws Exception { context.turnOffAuthorisationSystem(); Community com = CommunityBuilder.createCommunity(context).withName("A test community").build(); - CommunityRest comRest = converterService.toRest(com, converterService.getProjection(DefaultProjection.NAME)); + CommunityRest comRest = communityConverter.convert(com, DefaultProjection.DEFAULT); String comUri = utils.linkToSingleResource(comRest, "self").getHref(); context.restoreAuthSystemState(); @@ -874,7 +882,7 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration */ public void findByObjectAndFeatureNotGrantedTest() throws Exception { Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, converterService.getProjection(DefaultProjection.NAME)); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); String siteUri = utils.linkToSingleResource(siteRest, "self").getHref(); // verify that it works for administrators @@ -923,7 +931,7 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration public void findByNotExistingObjectAndFeatureTest() throws Exception { String wrongSiteUri = "http://localhost/api/core/sites/" + UUID.randomUUID(); Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, converterService.getProjection(DefaultProjection.NAME)); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); String siteUri = utils.linkToSingleResource(siteRest, "self").getHref(); // disarm the alwaysThrowExceptionFeature @@ -1007,7 +1015,7 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration "http://localhost/api/core/sites/this-is-not-an-uuid" }; Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, converterService.getProjection(DefaultProjection.NAME)); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); String siteUri = utils.linkToSingleResource(siteRest, "self").getHref(); // disarm the alwaysThrowExceptionFeature configurationService.setProperty("org.dspace.app.rest.authorization.AlwaysThrowExceptionFeature.turnoff", true); @@ -1092,7 +1100,7 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration */ public void findByObjectAndFeatureUnauthorizedTest() throws Exception { Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, converterService.getProjection(DefaultProjection.NAME)); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); String siteUri = utils.linkToSingleResource(siteRest, "self").getHref(); // disarm the alwaysThrowExceptionFeature @@ -1121,7 +1129,7 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration */ public void findByObjectAndFeatureForbiddenTest() throws Exception { Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, converterService.getProjection(DefaultProjection.NAME)); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); String siteUri = utils.linkToSingleResource(siteRest, "self").getHref(); context.turnOffAuthorisationSystem(); EPerson anotherEperson = EPersonBuilder.createEPerson(context).withEmail("another@example.com") @@ -1152,7 +1160,7 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration */ public void findByObjectAndFeatureInternalServerErrorTest() throws Exception { Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, converterService.getProjection(DefaultProjection.NAME)); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); String siteUri = utils.linkToSingleResource(siteRest, "self").getHref(); // verify that it works for administrators @@ -1188,7 +1196,7 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration */ public void verifySpecialGroupMembershipTest() throws Exception { Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, converterService.getProjection(DefaultProjection.NAME)); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); String siteUri = utils.linkToSingleResource(siteRest, "self").getHref(); context.turnOffAuthorisationSystem(); // create two normal users and put one in the test group directly diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/BitstreamFormatRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/BitstreamFormatRestRepositoryIT.java index 862e2046c0..45077f2e8f 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/BitstreamFormatRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/BitstreamFormatRestRepositoryIT.java @@ -27,6 +27,7 @@ import java.util.concurrent.atomic.AtomicReference; import com.fasterxml.jackson.databind.ObjectMapper; import org.dspace.app.rest.builder.BitstreamFormatBuilder; import org.dspace.app.rest.builder.EPersonBuilder; +import org.dspace.app.rest.converter.BitstreamFormatConverter; import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.matcher.BitstreamFormatMatcher; import org.dspace.app.rest.matcher.HalMatcher; @@ -51,10 +52,10 @@ import org.springframework.test.web.servlet.MvcResult; public class BitstreamFormatRestRepositoryIT extends AbstractControllerIntegrationTest { @Autowired - ConverterService converter; + BitstreamFormatService bitstreamFormatService; @Autowired - BitstreamFormatService bitstreamFormatService; + private BitstreamFormatConverter bitstreamFormatConverter; private final int DEFAULT_AMOUNT_FORMATS = 80; @@ -282,7 +283,7 @@ public class BitstreamFormatRestRepositoryIT extends AbstractControllerIntegrati .build(); context.restoreAuthSystemState(); - BitstreamFormatRest bitstreamFormatRest = converter.toRest(bitstreamFormat, Projection.DEFAULT); + BitstreamFormatRest bitstreamFormatRest = bitstreamFormatConverter.convert(bitstreamFormat, Projection.DEFAULT); String token = getAuthToken(admin.getEmail(), password); //Update it bitstreamFormatRest.setShortDescription("Test short UPDATED"); @@ -314,7 +315,7 @@ public class BitstreamFormatRestRepositoryIT extends AbstractControllerIntegrati .build(); context.restoreAuthSystemState(); - BitstreamFormatRest bitstreamFormatRest = converter.toRest(bitstreamFormat, Projection.DEFAULT); + BitstreamFormatRest bitstreamFormatRest = bitstreamFormatConverter.convert(bitstreamFormat, Projection.DEFAULT); String token = getAuthToken(admin.getEmail(), password); //Update it bitstreamFormatRest.setShortDescription("Test short UPDATED"); @@ -352,7 +353,7 @@ public class BitstreamFormatRestRepositoryIT extends AbstractControllerIntegrati int nonExistentBitstreamFormatID = 404404404; - BitstreamFormatRest bitstreamFormatRest = converter.toRest(bitstreamFormat, Projection.DEFAULT); + BitstreamFormatRest bitstreamFormatRest = bitstreamFormatConverter.convert(bitstreamFormat, Projection.DEFAULT); String token = getAuthToken(admin.getEmail(), password); //Update it with non existent ID in URL and in JSON bitstreamFormatRest.setShortDescription("Test short UPDATED"); @@ -389,7 +390,7 @@ public class BitstreamFormatRestRepositoryIT extends AbstractControllerIntegrati int nonExistentBitstreamFormatID = 404404404; - BitstreamFormatRest bitstreamFormatRest = converter.toRest(bitstreamFormat, Projection.DEFAULT); + BitstreamFormatRest bitstreamFormatRest = bitstreamFormatConverter.convert(bitstreamFormat, Projection.DEFAULT); String token = getAuthToken(admin.getEmail(), password); //Update it with non existent ID in URL bitstreamFormatRest.setShortDescription("Test short UPDATED"); @@ -425,7 +426,7 @@ public class BitstreamFormatRestRepositoryIT extends AbstractControllerIntegrati int nonExistentBitstreamFormatID = 404404404; - BitstreamFormatRest bitstreamFormatRest = converter.toRest(bitstreamFormat, Projection.DEFAULT); + BitstreamFormatRest bitstreamFormatRest = bitstreamFormatConverter.convert(bitstreamFormat, Projection.DEFAULT); String token = getAuthToken(admin.getEmail(), password); //Update it with non existent ID in JSON, but valid in URL bitstreamFormatRest.setShortDescription("Test short UPDATED"); @@ -463,7 +464,7 @@ public class BitstreamFormatRestRepositoryIT extends AbstractControllerIntegrati .build(); context.restoreAuthSystemState(); - BitstreamFormatRest bitstreamFormatRest = converter.toRest(bitstreamFormat1, Projection.DEFAULT); + BitstreamFormatRest bitstreamFormatRest = bitstreamFormatConverter.convert(bitstreamFormat1, Projection.DEFAULT); String token = getAuthToken(admin.getEmail(), password); //Update but id in body is not same id as in URL bitstreamFormatRest.setShortDescription("Test short UPDATED"); @@ -496,7 +497,7 @@ public class BitstreamFormatRestRepositoryIT extends AbstractControllerIntegrati .build(); context.restoreAuthSystemState(); - BitstreamFormatRest bitstreamFormatRest = converter.toRest(bitstreamFormat, Projection.DEFAULT); + BitstreamFormatRest bitstreamFormatRest = bitstreamFormatConverter.convert(bitstreamFormat, Projection.DEFAULT); //Try to update bitstreamFormat without auth token bitstreamFormatRest.setShortDescription("Test short UPDATED"); @@ -532,7 +533,7 @@ public class BitstreamFormatRestRepositoryIT extends AbstractControllerIntegrati .build(); context.restoreAuthSystemState(); - BitstreamFormatRest bitstreamFormatRest = converter.toRest(bitstreamFormat, Projection.DEFAULT); + BitstreamFormatRest bitstreamFormatRest = bitstreamFormatConverter.convert(bitstreamFormat, Projection.DEFAULT); String token = getAuthToken(user.getEmail(), password); //Try to update bitstreamFormat without non-admin auth token diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java index 547441e73f..e5c4f9d066 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java @@ -24,6 +24,7 @@ import java.util.UUID; import com.fasterxml.jackson.databind.ObjectMapper; import org.dspace.app.rest.builder.CollectionBuilder; import org.dspace.app.rest.builder.CommunityBuilder; +import org.dspace.app.rest.converter.CollectionConverter; import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.matcher.CollectionMatcher; import org.dspace.app.rest.matcher.CommunityMatcher; @@ -49,7 +50,7 @@ import org.springframework.http.MediaType; public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTest { @Autowired - ConverterService converter; + CollectionConverter collectionConverter; @Autowired AuthorizeService authorizeService; @@ -397,7 +398,7 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes ObjectMapper mapper = new ObjectMapper(); - CollectionRest collectionRest = converter.toRest(col1, Projection.DEFAULT); + CollectionRest collectionRest = collectionConverter.convert(col1, Projection.DEFAULT); collectionRest.setMetadata(new MetadataRest() .put("dc.title", new MetadataValueRest("Electronic theses and dissertations"))); @@ -776,7 +777,7 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes String token = getAuthToken(eperson.getEmail(), password); ObjectMapper mapper = new ObjectMapper(); - CollectionRest collectionRest = converter.toRest(col1, Projection.DEFAULT); + CollectionRest collectionRest = collectionConverter.convert(col1, Projection.DEFAULT); collectionRest.setMetadata(new MetadataRest() .put("dc.title", new MetadataValueRest("Electronic theses and dissertations"))); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityRestRepositoryIT.java index 0a315aa5c3..c3846b4119 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityRestRepositoryIT.java @@ -32,6 +32,7 @@ import java.util.stream.StreamSupport; import com.fasterxml.jackson.databind.ObjectMapper; import org.dspace.app.rest.builder.CollectionBuilder; import org.dspace.app.rest.builder.CommunityBuilder; +import org.dspace.app.rest.converter.CommunityConverter; import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.matcher.CommunityMatcher; import org.dspace.app.rest.matcher.HalMatcher; @@ -63,7 +64,7 @@ import org.springframework.test.web.servlet.MvcResult; public class CommunityRestRepositoryIT extends AbstractControllerIntegrationTest { @Autowired - ConverterService converter; + CommunityConverter communityConverter; @Autowired CommunityService communityService; @@ -881,7 +882,7 @@ public class CommunityRestRepositoryIT extends AbstractControllerIntegrationTest ObjectMapper mapper = new ObjectMapper(); - CommunityRest communityRest = converter.toRest(parentCommunity, Projection.DEFAULT); + CommunityRest communityRest = communityConverter.convert(parentCommunity, Projection.DEFAULT); communityRest.setMetadata(new MetadataRest() .put("dc.title", new MetadataValueRest("Electronic theses and dissertations"))); @@ -1101,7 +1102,7 @@ public class CommunityRestRepositoryIT extends AbstractControllerIntegrationTest ObjectMapper mapper = new ObjectMapper(); - CommunityRest communityRest = converter.toRest(parentCommunity, Projection.DEFAULT); + CommunityRest communityRest = communityConverter.convert(parentCommunity, Projection.DEFAULT); communityRest.setMetadata(new MetadataRest() .put("dc.title", new MetadataValueRest("Electronic theses and dissertations"))); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/MetadataSchemaRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/MetadataSchemaRestRepositoryIT.java index c116cb9d28..e1e6ba87a0 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/MetadataSchemaRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/MetadataSchemaRestRepositoryIT.java @@ -23,6 +23,7 @@ import java.util.concurrent.atomic.AtomicReference; import com.fasterxml.jackson.databind.ObjectMapper; import org.dspace.app.rest.builder.MetadataSchemaBuilder; import org.dspace.app.rest.converter.ConverterService; +import org.dspace.app.rest.converter.MetadataSchemaConverter; import org.dspace.app.rest.matcher.HalMatcher; import org.dspace.app.rest.matcher.MetadataschemaMatcher; import org.dspace.app.rest.model.MetadataSchemaRest; @@ -46,9 +47,9 @@ public class MetadataSchemaRestRepositoryIT extends AbstractControllerIntegratio private static final String TEST_NAME_UPDATED = "testSchemaNameUpdated"; private static final String TEST_NAMESPACE_UPDATED = "testSchemaNameSpaceUpdated"; - @Autowired - ConverterService converter; + @Autowired + private MetadataSchemaConverter metadataSchemaConverter; @Test public void findAll() throws Exception { @@ -90,7 +91,7 @@ public class MetadataSchemaRestRepositoryIT extends AbstractControllerIntegratio .build(); context.restoreAuthSystemState(); - MetadataSchemaRest metadataSchemaRest = converter.toRest(metadataSchema, Projection.DEFAULT); + MetadataSchemaRest metadataSchemaRest = metadataSchemaConverter.convert(metadataSchema, Projection.DEFAULT); metadataSchemaRest.setPrefix(TEST_NAME); metadataSchemaRest.setNamespace(TEST_NAMESPACE); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/CCLicenseFeatureRestIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/CCLicenseFeatureRestIT.java index 79000dc22d..14c0876aa1 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/CCLicenseFeatureRestIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/CCLicenseFeatureRestIT.java @@ -17,15 +17,18 @@ import org.dspace.app.rest.builder.CommunityBuilder; import org.dspace.app.rest.builder.ItemBuilder; import org.dspace.app.rest.builder.ResourcePolicyBuilder; import org.dspace.app.rest.converter.ConverterService; +import org.dspace.app.rest.converter.ItemConverter; import org.dspace.app.rest.matcher.AuthorizationMatcher; import org.dspace.app.rest.model.ItemRest; import org.dspace.app.rest.projection.DefaultProjection; +import org.dspace.app.rest.projection.Projection; import org.dspace.app.rest.test.AbstractControllerIntegrationTest; import org.dspace.app.rest.utils.Utils; import org.dspace.authorize.ResourcePolicy; import org.dspace.content.Collection; import org.dspace.content.Community; import org.dspace.content.Item; +import org.dspace.content.service.ItemService; import org.dspace.core.Constants; import org.dspace.services.ConfigurationService; import org.hamcrest.Matchers; @@ -45,10 +48,10 @@ public class CCLicenseFeatureRestIT extends AbstractControllerIntegrationTest { private AuthorizationFeatureService authorizationFeatureService; @Autowired - private ConverterService converterService; + private ConfigurationService configurationService; @Autowired - private ConfigurationService configurationService; + private ItemConverter itemConverter; @Autowired private Utils utils; @@ -70,7 +73,7 @@ public class CCLicenseFeatureRestIT extends AbstractControllerIntegrationTest { Item item = ItemBuilder.createItem(context, col).withTitle("Item to withdraw").build(); context.restoreAuthSystemState(); - ItemRest itemRest = converterService.toRest(item, converterService.getProjection(DefaultProjection.NAME)); + ItemRest itemRest = itemConverter.convert(item, Projection.DEFAULT); String itemUri = utils.linkToSingleResource(itemRest, "self").getHref(); Authorization authAdminCCLicense = new Authorization(admin, ccLicenseFeature, itemRest); @@ -99,7 +102,7 @@ public class CCLicenseFeatureRestIT extends AbstractControllerIntegrationTest { Item item = ItemBuilder.createItem(context, col).withTitle("Item to withdraw").build(); context.restoreAuthSystemState(); - ItemRest itemRest = converterService.toRest(item, converterService.getProjection(DefaultProjection.NAME)); + ItemRest itemRest = itemConverter.convert(item, Projection.DEFAULT); String itemUri = utils.linkToSingleResource(itemRest, "self").getHref(); Authorization authAdminCCLicense = new Authorization(eperson, ccLicenseFeature, itemRest); @@ -159,7 +162,7 @@ public class CCLicenseFeatureRestIT extends AbstractControllerIntegrationTest { Item item = ItemBuilder.createItem(context, col).withTitle("Item to withdraw").build(); context.restoreAuthSystemState(); - ItemRest itemRest = converterService.toRest(item, converterService.getProjection(DefaultProjection.NAME)); + ItemRest itemRest = itemConverter.convert(item, Projection.DEFAULT); String itemUri = utils.linkToSingleResource(itemRest, "self").getHref(); Authorization authAdminCCLicense = new Authorization(eperson, ccLicenseFeature, itemRest); @@ -200,7 +203,7 @@ public class CCLicenseFeatureRestIT extends AbstractControllerIntegrationTest { .withUser(eperson).withDspaceObject(item).build(); context.restoreAuthSystemState(); - ItemRest itemRest = converterService.toRest(item, converterService.getProjection(DefaultProjection.NAME)); + ItemRest itemRest = itemConverter.convert(item, Projection.DEFAULT); String itemUri = utils.linkToSingleResource(itemRest, "self").getHref(); Authorization authAdminCCLicense = new Authorization(eperson, ccLicenseFeature, itemRest); @@ -238,7 +241,7 @@ public class CCLicenseFeatureRestIT extends AbstractControllerIntegrationTest { Item item = ItemBuilder.createItem(context, col).withTitle("Item to withdraw").build(); context.restoreAuthSystemState(); - ItemRest itemRest = converterService.toRest(item, converterService.getProjection(DefaultProjection.NAME)); + ItemRest itemRest = itemConverter.convert(item, Projection.DEFAULT); String itemUri = utils.linkToSingleResource(itemRest, "self").getHref(); Authorization authEpersonCCLicense = new Authorization(eperson, ccLicenseFeature, itemRest); Authorization authAnonymousCCLicense = new Authorization(null, ccLicenseFeature, itemRest); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/ReinstateFeatureRestIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/ReinstateFeatureRestIT.java index fb68e47a3a..b6622503da 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/ReinstateFeatureRestIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/ReinstateFeatureRestIT.java @@ -18,9 +18,11 @@ import org.dspace.app.rest.builder.ItemBuilder; import org.dspace.app.rest.builder.WorkflowItemBuilder; import org.dspace.app.rest.builder.WorkspaceItemBuilder; import org.dspace.app.rest.converter.ConverterService; +import org.dspace.app.rest.converter.ItemConverter; import org.dspace.app.rest.matcher.AuthorizationMatcher; import org.dspace.app.rest.model.ItemRest; import org.dspace.app.rest.projection.DefaultProjection; +import org.dspace.app.rest.projection.Projection; import org.dspace.app.rest.test.AbstractControllerIntegrationTest; import org.dspace.app.rest.utils.Utils; import org.dspace.content.Collection; @@ -46,7 +48,7 @@ public class ReinstateFeatureRestIT extends AbstractControllerIntegrationTest { private AuthorizationFeatureService authorizationFeatureService; @Autowired - private ConverterService converterService; + private ItemConverter itemConverter; @Autowired private ConfigurationService configurationService; @@ -71,7 +73,7 @@ public class ReinstateFeatureRestIT extends AbstractControllerIntegrationTest { Item item = ItemBuilder.createItem(context, col).withTitle("Withdrawn item").withdrawn().build(); context.restoreAuthSystemState(); - ItemRest itemRest = converterService.toRest(item, converterService.getProjection(DefaultProjection.NAME)); + ItemRest itemRest = itemConverter.convert(item, Projection.DEFAULT); String itemUri = utils.linkToSingleResource(itemRest, "self").getHref(); Authorization authAdminWithdraw = new Authorization(admin, reinstateFeature, itemRest); @@ -100,7 +102,7 @@ public class ReinstateFeatureRestIT extends AbstractControllerIntegrationTest { Item item = ItemBuilder.createItem(context, col).withTitle("Withdrawn item").withdrawn().build(); context.restoreAuthSystemState(); - ItemRest itemRest = converterService.toRest(item, converterService.getProjection(DefaultProjection.NAME)); + ItemRest itemRest = itemConverter.convert(item, Projection.DEFAULT); String itemUri = utils.linkToSingleResource(itemRest, "self").getHref(); Authorization authAdminWithdraw = new Authorization(eperson, reinstateFeature, itemRest); @@ -159,7 +161,7 @@ public class ReinstateFeatureRestIT extends AbstractControllerIntegrationTest { Item item = ItemBuilder.createItem(context, col).withTitle("Withdrawn item").withdrawn().build(); context.restoreAuthSystemState(); - ItemRest itemRest = converterService.toRest(item, converterService.getProjection(DefaultProjection.NAME)); + ItemRest itemRest = itemConverter.convert(item, Projection.DEFAULT); String itemUri = utils.linkToSingleResource(itemRest, "self").getHref(); Authorization authAdminWithdraw = new Authorization(eperson, reinstateFeature, itemRest); @@ -197,7 +199,7 @@ public class ReinstateFeatureRestIT extends AbstractControllerIntegrationTest { Item item = ItemBuilder.createItem(context, col).withTitle("Withdrawn item").withdrawn().build(); context.restoreAuthSystemState(); - ItemRest itemRest = converterService.toRest(item, converterService.getProjection(DefaultProjection.NAME)); + ItemRest itemRest = itemConverter.convert(item, Projection.DEFAULT); String itemUri = utils.linkToSingleResource(itemRest, "self").getHref(); Authorization authEpersonWithdraw = new Authorization(eperson, reinstateFeature, itemRest); Authorization authAnonymousWithdraw = new Authorization(null, reinstateFeature, itemRest); @@ -236,14 +238,11 @@ public class ReinstateFeatureRestIT extends AbstractControllerIntegrationTest { WorkflowItem wfItem = WorkflowItemBuilder.createWorkflowItem(context, col).withTitle("A workflow item").build(); context.restoreAuthSystemState(); - ItemRest archivedItemRest = converterService.toRest(archivedItem, - converterService.getProjection(DefaultProjection.NAME)); + ItemRest archivedItemRest = itemConverter.convert(archivedItem, Projection.DEFAULT); String archivedItemUri = utils.linkToSingleResource(archivedItemRest, "self").getHref(); - ItemRest wsItemRest = converterService.toRest(wsItem.getItem(), - converterService.getProjection(DefaultProjection.NAME)); + ItemRest wsItemRest = itemConverter.convert(wsItem.getItem(), Projection.DEFAULT); String wsItemUri = utils.linkToSingleResource(wsItemRest, "self").getHref(); - ItemRest wfItemRest = converterService.toRest(wfItem.getItem(), - converterService.getProjection(DefaultProjection.NAME)); + ItemRest wfItemRest = itemConverter.convert(wfItem.getItem(), Projection.DEFAULT); String wfItemUri = utils.linkToSingleResource(wfItemRest, "self").getHref(); Authorization authWithdrawnItem = new Authorization(admin, reinstateFeature, archivedItemRest); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/WithdrawFeatureRestIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/WithdrawFeatureRestIT.java index 631b273621..8f9e870d15 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/WithdrawFeatureRestIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/WithdrawFeatureRestIT.java @@ -18,9 +18,11 @@ import org.dspace.app.rest.builder.ItemBuilder; import org.dspace.app.rest.builder.WorkflowItemBuilder; import org.dspace.app.rest.builder.WorkspaceItemBuilder; import org.dspace.app.rest.converter.ConverterService; +import org.dspace.app.rest.converter.ItemConverter; import org.dspace.app.rest.matcher.AuthorizationMatcher; import org.dspace.app.rest.model.ItemRest; import org.dspace.app.rest.projection.DefaultProjection; +import org.dspace.app.rest.projection.Projection; import org.dspace.app.rest.test.AbstractControllerIntegrationTest; import org.dspace.app.rest.utils.Utils; import org.dspace.content.Collection; @@ -46,7 +48,7 @@ public class WithdrawFeatureRestIT extends AbstractControllerIntegrationTest { private AuthorizationFeatureService authorizationFeatureService; @Autowired - private ConverterService converterService; + private ItemConverter itemConverter; @Autowired private ConfigurationService configurationService; @@ -71,7 +73,7 @@ public class WithdrawFeatureRestIT extends AbstractControllerIntegrationTest { Item item = ItemBuilder.createItem(context, col).withTitle("Item to withdraw").build(); context.restoreAuthSystemState(); - ItemRest itemRest = converterService.toRest(item, converterService.getProjection(DefaultProjection.NAME)); + ItemRest itemRest = itemConverter.convert(item, Projection.DEFAULT); String itemUri = utils.linkToSingleResource(itemRest, "self").getHref(); Authorization authAdminWithdraw = new Authorization(admin, withdrawFeature, itemRest); @@ -100,7 +102,7 @@ public class WithdrawFeatureRestIT extends AbstractControllerIntegrationTest { Item item = ItemBuilder.createItem(context, col).withTitle("Item to withdraw").build(); context.restoreAuthSystemState(); - ItemRest itemRest = converterService.toRest(item, converterService.getProjection(DefaultProjection.NAME)); + ItemRest itemRest = itemConverter.convert(item, Projection.DEFAULT); String itemUri = utils.linkToSingleResource(itemRest, "self").getHref(); Authorization authAdminWithdraw = new Authorization(eperson, withdrawFeature, itemRest); @@ -159,7 +161,7 @@ public class WithdrawFeatureRestIT extends AbstractControllerIntegrationTest { Item item = ItemBuilder.createItem(context, col).withTitle("Item to withdraw").build(); context.restoreAuthSystemState(); - ItemRest itemRest = converterService.toRest(item, converterService.getProjection(DefaultProjection.NAME)); + ItemRest itemRest = itemConverter.convert(item, Projection.DEFAULT); String itemUri = utils.linkToSingleResource(itemRest, "self").getHref(); Authorization authAdminWithdraw = new Authorization(eperson, withdrawFeature, itemRest); @@ -197,7 +199,7 @@ public class WithdrawFeatureRestIT extends AbstractControllerIntegrationTest { Item item = ItemBuilder.createItem(context, col).withTitle("Item to withdraw").build(); context.restoreAuthSystemState(); - ItemRest itemRest = converterService.toRest(item, converterService.getProjection(DefaultProjection.NAME)); + ItemRest itemRest = itemConverter.convert(item, Projection.DEFAULT); String itemUri = utils.linkToSingleResource(itemRest, "self").getHref(); Authorization authEpersonWithdraw = new Authorization(eperson, withdrawFeature, itemRest); Authorization authAnonymousWithdraw = new Authorization(null, withdrawFeature, itemRest); @@ -237,14 +239,11 @@ public class WithdrawFeatureRestIT extends AbstractControllerIntegrationTest { WorkflowItem wfItem = WorkflowItemBuilder.createWorkflowItem(context, col).withTitle("A workflow item").build(); context.restoreAuthSystemState(); - ItemRest withdrawnItemRest = converterService.toRest(withdrawnItem, - converterService.getProjection(DefaultProjection.NAME)); + ItemRest withdrawnItemRest = itemConverter.convert(withdrawnItem, Projection.DEFAULT); String withdrawnItemUri = utils.linkToSingleResource(withdrawnItemRest, "self").getHref(); - ItemRest wsItemRest = converterService.toRest(wsItem.getItem(), - converterService.getProjection(DefaultProjection.NAME)); + ItemRest wsItemRest = itemConverter.convert(wsItem.getItem(), Projection.DEFAULT); String wsItemUri = utils.linkToSingleResource(wsItemRest, "self").getHref(); - ItemRest wfItemRest = converterService.toRest(wfItem.getItem(), - converterService.getProjection(DefaultProjection.NAME)); + ItemRest wfItemRest = itemConverter.convert(wfItem.getItem(), Projection.DEFAULT); String wfItemUri = utils.linkToSingleResource(wfItemRest, "self").getHref(); Authorization authWithdrawnItem = new Authorization(admin, withdrawFeature, withdrawnItemRest); From d36fffa3486135286b52be2847ed28e759feca0b Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Thu, 26 Mar 2020 08:19:09 +0100 Subject: [PATCH 016/125] [Task 70058] added permisson evaluators for several BaseObjectRest objects --- .../app/rest/converter/ConverterService.java | 5 ++-- ...onStatusRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ .../AuthnRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...nFeatureRestPermissionEvaluatorPlugin.java | 8 +++++- ...rizationRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...amFormatRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...wseIndexRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...ryResultRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ .../EntityTypeRestPermissionEvaluator.java | 27 +++++++++++++++++++ ...nalSourceEntryRestPermissionEvaluator.java | 27 +++++++++++++++++++ ...ExternalSourceRestPermissionEvaluator.java | 27 +++++++++++++++++++ ...tConfigurationRestPermissionEvaluator.java | 27 +++++++++++++++++++ ...llectionRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...MetadataRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...ataFieldRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...taSchemaRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...tionshipRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...shipTypeRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ .../RestObjectPermissionEvaluatorPlugin.java | 3 ++- .../ScriptRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...gurationRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...rchEventRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...hResultsRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...hSupportRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...sSupportRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...finitionRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...sionFormRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...onUploadRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...nSectionRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...lateItemRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...iewEventRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...owActionRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...finitionRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ ...flowStepRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ .../rest/AuthorizationFeatureServiceIT.java | 1 - .../rest/AuthorizationRestRepositoryIT.java | 1 - .../rest/BitstreamFormatRestRepositoryIT.java | 4 +-- .../app/rest/CollectionRestRepositoryIT.java | 1 - .../app/rest/CommunityRestRepositoryIT.java | 1 - .../rest/MetadataSchemaRestRepositoryIT.java | 1 - .../authorization/CCLicenseFeatureRestIT.java | 3 --- .../authorization/ReinstateFeatureRestIT.java | 2 -- .../authorization/WithdrawFeatureRestIT.java | 2 -- 43 files changed, 850 insertions(+), 19 deletions(-) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthenticationStatusRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthnRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BitstreamFormatRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BrowseIndexRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/DiscoveryResultRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EntityTypeRestPermissionEvaluator.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceEntryRestPermissionEvaluator.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceRestPermissionEvaluator.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/FacetConfigurationRestPermissionEvaluator.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvestedCollectionRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvesterMetadataRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataFieldRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataSchemaRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipTypeRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ScriptRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchConfigurationRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchEventRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchResultsRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchSupportRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/StatisticsSupportRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionDefinitionRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionFormRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionUploadRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissonSectionRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/TemplateItemRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ViewEventRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowActionRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowDefinitionRestPermissionEvaluatorPlugin.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowStepRestPermissionEvaluatorPlugin.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java index 8bb5973137..bc6613a03e 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java @@ -27,7 +27,6 @@ import org.dspace.app.rest.projection.DefaultProjection; import org.dspace.app.rest.projection.Projection; import org.dspace.app.rest.security.DSpacePermissionEvaluator; import org.dspace.app.rest.utils.Utils; -import org.dspace.authorize.AuthorizeException; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.config.BeanDefinition; import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider; @@ -37,7 +36,6 @@ import org.springframework.data.domain.PageImpl; import org.springframework.data.domain.Pageable; import org.springframework.hateoas.Link; import org.springframework.hateoas.Resource; -import org.springframework.security.access.AccessDeniedException; import org.springframework.security.core.context.SecurityContextHolder; import org.springframework.stereotype.Component; import org.springframework.stereotype.Service; @@ -95,7 +93,8 @@ public class ConverterService { DSpaceConverter converter = requireConverter(modelObject.getClass()); R restObject = converter.convert(transformedModel, projection); if (restObject instanceof BaseObjectRest) { - if (!dSpacePermissionEvaluator.hasPermission(SecurityContextHolder.getContext().getAuthentication(), restObject, "READ")) { + if (!dSpacePermissionEvaluator.hasPermission(SecurityContextHolder.getContext().getAuthentication(), + restObject, "READ")) { log.info("Access denied on " + restObject.getClass()); return null; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthenticationStatusRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthenticationStatusRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..64ec0dc35a --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthenticationStatusRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.AuthenticationStatusRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class AuthenticationStatusRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(AuthenticationStatusRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthnRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthnRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..e4e1c4a5b9 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthnRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.AuthnRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class AuthnRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(AuthnRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationFeatureRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationFeatureRestPermissionEvaluatorPlugin.java index 6b8a8af4c4..3552c47994 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationFeatureRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationFeatureRestPermissionEvaluatorPlugin.java @@ -1,10 +1,16 @@ +/** + * 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.rest.security; import java.io.Serializable; import org.apache.commons.lang3.StringUtils; import org.dspace.app.rest.model.AuthorizationFeatureRest; -import org.dspace.app.rest.model.PoolTaskRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..a7aea929c0 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.AuthorizationRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class AuthorizationRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(AuthorizationRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BitstreamFormatRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BitstreamFormatRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..f1f6d3d394 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BitstreamFormatRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.BitstreamFormatRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class BitstreamFormatRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(BitstreamFormatRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BrowseIndexRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BrowseIndexRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..30ed782515 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BrowseIndexRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.BrowseIndexRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class BrowseIndexRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(BrowseIndexRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/DiscoveryResultRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/DiscoveryResultRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..01c3537d02 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/DiscoveryResultRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.DiscoveryResultsRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class DiscoveryResultRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(DiscoveryResultsRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EntityTypeRestPermissionEvaluator.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EntityTypeRestPermissionEvaluator.java new file mode 100644 index 0000000000..cc57753033 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EntityTypeRestPermissionEvaluator.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.EntityTypeRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class EntityTypeRestPermissionEvaluator extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(EntityTypeRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceEntryRestPermissionEvaluator.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceEntryRestPermissionEvaluator.java new file mode 100644 index 0000000000..3d1a20fd8b --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceEntryRestPermissionEvaluator.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.ExternalSourceEntryRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class ExternalSourceEntryRestPermissionEvaluator extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(ExternalSourceEntryRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceRestPermissionEvaluator.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceRestPermissionEvaluator.java new file mode 100644 index 0000000000..536c55d674 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceRestPermissionEvaluator.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.ExternalSourceRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class ExternalSourceRestPermissionEvaluator extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(ExternalSourceRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/FacetConfigurationRestPermissionEvaluator.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/FacetConfigurationRestPermissionEvaluator.java new file mode 100644 index 0000000000..2d46a9c02c --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/FacetConfigurationRestPermissionEvaluator.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.FacetConfigurationRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class FacetConfigurationRestPermissionEvaluator extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(FacetConfigurationRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvestedCollectionRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvestedCollectionRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..0abe88e3bb --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvestedCollectionRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.HarvestedCollectionRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class HarvestedCollectionRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(HarvestedCollectionRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvesterMetadataRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvesterMetadataRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..76fae4f637 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvesterMetadataRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.HarvesterMetadataRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class HarvesterMetadataRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(HarvesterMetadataRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataFieldRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataFieldRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..b78f2ddbd0 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataFieldRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.MetadataFieldRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class MetadataFieldRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(MetadataFieldRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataSchemaRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataSchemaRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..5b4094960f --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataSchemaRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.MetadataSchemaRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class MetadataSchemaRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(MetadataSchemaRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..999066840b --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.RelationshipRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class RelationshipRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(RelationshipRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipTypeRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipTypeRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..c7305808b5 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipTypeRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.RelationshipTypeRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class RelationshipTypeRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(RelationshipTypeRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RestObjectPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RestObjectPermissionEvaluatorPlugin.java index 855519ccc2..f35b0d26ef 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RestObjectPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RestObjectPermissionEvaluatorPlugin.java @@ -35,7 +35,8 @@ public abstract class RestObjectPermissionEvaluatorPlugin implements RestPermis public boolean hasPermission(Authentication authentication, Object targetDomainObject, Object permission) { BaseObjectRest restObject = (BaseObjectRest) targetDomainObject; - return hasPermission(authentication, restObject.getId(), StringUtils.upperCase(restObject.getType()), permission); + return hasPermission(authentication, restObject.getId(), StringUtils.upperCase(restObject.getType()), + permission); } @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ScriptRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ScriptRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..116f5adf1c --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ScriptRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.ScriptRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class ScriptRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(ScriptRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchConfigurationRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchConfigurationRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..a0a7af1b85 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchConfigurationRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.SearchConfigurationRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class SearchConfigurationRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(SearchConfigurationRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchEventRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchEventRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..5456621eb7 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchEventRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.SearchEventRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class SearchEventRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(SearchEventRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchResultsRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchResultsRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..3cd67088ba --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchResultsRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.SearchResultsRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class SearchResultsRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(SearchResultsRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchSupportRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchSupportRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..d01b1e2111 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchSupportRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.SearchSupportRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class SearchSupportRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(SearchSupportRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/StatisticsSupportRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/StatisticsSupportRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..13d0632da6 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/StatisticsSupportRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.StatisticsSupportRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class StatisticsSupportRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(StatisticsSupportRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionDefinitionRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionDefinitionRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..8bbf1d3803 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionDefinitionRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.SubmissionDefinitionRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class SubmissionDefinitionRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(SubmissionDefinitionRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionFormRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionFormRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..4c582d4a3b --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionFormRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.SubmissionFormRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class SubmissionFormRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(SubmissionFormRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionUploadRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionUploadRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..1f51050d76 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionUploadRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.SubmissionUploadRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class SubmissionUploadRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(SubmissionUploadRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissonSectionRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissonSectionRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..d6fad0e42d --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissonSectionRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.SubmissionSectionRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class SubmissonSectionRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(SubmissionSectionRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/TemplateItemRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/TemplateItemRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..1cdd5a291c --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/TemplateItemRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.TemplateItemRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class TemplateItemRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(TemplateItemRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ViewEventRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ViewEventRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..c8e2a0585a --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ViewEventRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.ViewEventRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class ViewEventRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(ViewEventRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowActionRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowActionRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..9b1ded9f9c --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowActionRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.WorkflowActionRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class WorkflowActionRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(WorkflowActionRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowDefinitionRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowDefinitionRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..6308ecf1f1 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowDefinitionRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.WorkflowDefinitionRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class WorkflowDefinitionRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(WorkflowDefinitionRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowStepRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowStepRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..7292f1d967 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowStepRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.WorkflowStepRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class WorkflowStepRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(WorkflowStepRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationFeatureServiceIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationFeatureServiceIT.java index f73ed06357..d53bdc92c8 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationFeatureServiceIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationFeatureServiceIT.java @@ -22,7 +22,6 @@ import org.dspace.app.rest.authorization.AlwaysTrueFeature; import org.dspace.app.rest.authorization.AuthorizationFeature; import org.dspace.app.rest.authorization.AuthorizationFeatureService; import org.dspace.app.rest.authorization.TrueForAdminsFeature; -import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.converter.SiteConverter; import org.dspace.app.rest.model.CollectionRest; import org.dspace.app.rest.model.SiteRest; diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationRestRepositoryIT.java index ac26ec001b..80a825fad9 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationRestRepositoryIT.java @@ -32,7 +32,6 @@ import org.dspace.app.rest.builder.CommunityBuilder; import org.dspace.app.rest.builder.EPersonBuilder; import org.dspace.app.rest.builder.GroupBuilder; import org.dspace.app.rest.converter.CommunityConverter; -import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.converter.EPersonConverter; import org.dspace.app.rest.converter.SiteConverter; import org.dspace.app.rest.matcher.AuthorizationMatcher; diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/BitstreamFormatRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/BitstreamFormatRestRepositoryIT.java index 45077f2e8f..a35ff55ad8 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/BitstreamFormatRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/BitstreamFormatRestRepositoryIT.java @@ -28,7 +28,6 @@ import com.fasterxml.jackson.databind.ObjectMapper; import org.dspace.app.rest.builder.BitstreamFormatBuilder; import org.dspace.app.rest.builder.EPersonBuilder; import org.dspace.app.rest.converter.BitstreamFormatConverter; -import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.matcher.BitstreamFormatMatcher; import org.dspace.app.rest.matcher.HalMatcher; import org.dspace.app.rest.model.BitstreamFormatRest; @@ -464,7 +463,8 @@ public class BitstreamFormatRestRepositoryIT extends AbstractControllerIntegrati .build(); context.restoreAuthSystemState(); - BitstreamFormatRest bitstreamFormatRest = bitstreamFormatConverter.convert(bitstreamFormat1, Projection.DEFAULT); + BitstreamFormatRest bitstreamFormatRest = bitstreamFormatConverter.convert(bitstreamFormat1, + Projection.DEFAULT); String token = getAuthToken(admin.getEmail(), password); //Update but id in body is not same id as in URL bitstreamFormatRest.setShortDescription("Test short UPDATED"); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java index e5c4f9d066..653b18c277 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java @@ -25,7 +25,6 @@ import com.fasterxml.jackson.databind.ObjectMapper; import org.dspace.app.rest.builder.CollectionBuilder; import org.dspace.app.rest.builder.CommunityBuilder; import org.dspace.app.rest.converter.CollectionConverter; -import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.matcher.CollectionMatcher; import org.dspace.app.rest.matcher.CommunityMatcher; import org.dspace.app.rest.matcher.HalMatcher; diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityRestRepositoryIT.java index c3846b4119..a52679a6ac 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityRestRepositoryIT.java @@ -33,7 +33,6 @@ import com.fasterxml.jackson.databind.ObjectMapper; import org.dspace.app.rest.builder.CollectionBuilder; import org.dspace.app.rest.builder.CommunityBuilder; import org.dspace.app.rest.converter.CommunityConverter; -import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.matcher.CommunityMatcher; import org.dspace.app.rest.matcher.HalMatcher; import org.dspace.app.rest.matcher.MetadataMatcher; diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/MetadataSchemaRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/MetadataSchemaRestRepositoryIT.java index e1e6ba87a0..8a4713e9bd 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/MetadataSchemaRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/MetadataSchemaRestRepositoryIT.java @@ -22,7 +22,6 @@ import java.util.concurrent.atomic.AtomicReference; import com.fasterxml.jackson.databind.ObjectMapper; import org.dspace.app.rest.builder.MetadataSchemaBuilder; -import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.converter.MetadataSchemaConverter; import org.dspace.app.rest.matcher.HalMatcher; import org.dspace.app.rest.matcher.MetadataschemaMatcher; diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/CCLicenseFeatureRestIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/CCLicenseFeatureRestIT.java index 14c0876aa1..97225d7df0 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/CCLicenseFeatureRestIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/CCLicenseFeatureRestIT.java @@ -16,11 +16,9 @@ import org.dspace.app.rest.builder.CollectionBuilder; import org.dspace.app.rest.builder.CommunityBuilder; import org.dspace.app.rest.builder.ItemBuilder; import org.dspace.app.rest.builder.ResourcePolicyBuilder; -import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.converter.ItemConverter; import org.dspace.app.rest.matcher.AuthorizationMatcher; import org.dspace.app.rest.model.ItemRest; -import org.dspace.app.rest.projection.DefaultProjection; import org.dspace.app.rest.projection.Projection; import org.dspace.app.rest.test.AbstractControllerIntegrationTest; import org.dspace.app.rest.utils.Utils; @@ -28,7 +26,6 @@ import org.dspace.authorize.ResourcePolicy; import org.dspace.content.Collection; import org.dspace.content.Community; import org.dspace.content.Item; -import org.dspace.content.service.ItemService; import org.dspace.core.Constants; import org.dspace.services.ConfigurationService; import org.hamcrest.Matchers; diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/ReinstateFeatureRestIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/ReinstateFeatureRestIT.java index b6622503da..96cd2243fc 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/ReinstateFeatureRestIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/ReinstateFeatureRestIT.java @@ -17,11 +17,9 @@ import org.dspace.app.rest.builder.CommunityBuilder; import org.dspace.app.rest.builder.ItemBuilder; import org.dspace.app.rest.builder.WorkflowItemBuilder; import org.dspace.app.rest.builder.WorkspaceItemBuilder; -import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.converter.ItemConverter; import org.dspace.app.rest.matcher.AuthorizationMatcher; import org.dspace.app.rest.model.ItemRest; -import org.dspace.app.rest.projection.DefaultProjection; import org.dspace.app.rest.projection.Projection; import org.dspace.app.rest.test.AbstractControllerIntegrationTest; import org.dspace.app.rest.utils.Utils; diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/WithdrawFeatureRestIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/WithdrawFeatureRestIT.java index 8f9e870d15..dac47a3a88 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/WithdrawFeatureRestIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/WithdrawFeatureRestIT.java @@ -17,11 +17,9 @@ import org.dspace.app.rest.builder.CommunityBuilder; import org.dspace.app.rest.builder.ItemBuilder; import org.dspace.app.rest.builder.WorkflowItemBuilder; import org.dspace.app.rest.builder.WorkspaceItemBuilder; -import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.converter.ItemConverter; import org.dspace.app.rest.matcher.AuthorizationMatcher; import org.dspace.app.rest.model.ItemRest; -import org.dspace.app.rest.projection.DefaultProjection; import org.dspace.app.rest.projection.Projection; import org.dspace.app.rest.test.AbstractControllerIntegrationTest; import org.dspace.app.rest.utils.Utils; From e79caf9970783d9103180b7c41bd55001eaca180 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Thu, 26 Mar 2020 13:05:03 +0100 Subject: [PATCH 017/125] [Task 70058] start fixing tests + refactor toRestPage methods in utils to properly handle and skip null values --- .../app/rest/RestResourceController.java | 6 ++--- .../app/rest/ScriptProcessesController.java | 10 ++++++- .../app/rest/converter/ConverterService.java | 19 +++++++++++-- .../repository/ItemBundleLinkRepository.java | 3 +-- .../MetadataFieldRestRepository.java | 2 +- .../rest/repository/ScriptRestRepository.java | 15 +++-------- .../impl/RestDSpaceRunnableHandler.java | 4 --- .../SiteRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ .../app/rest/UUIDLookupRestControllerIT.java | 8 ++++-- .../app/rest/VersionRestRepositoryIT.java | 13 +++++++++ 10 files changed, 80 insertions(+), 27 deletions(-) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SiteRestPermissionEvaluatorPlugin.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java index 2d0c710c16..45dfa9a6d5 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java @@ -812,9 +812,9 @@ public class RestResourceController implements InitializingBean { } else { link = linkTo(this.getClass(), apiCategory, model).slash(uuid).slash(subpath).withSelfRel(); } - Page restModelPage = getRestModelsWithoutNullValues(page, pageResult); + return new Resource(new EmbeddedPage(link.getHref(), - restModelPage.map(converter::toResource), null, subpath)); + pageResult.map(converter::toResource), null, subpath)); } else { RestModel object = (RestModel) linkMethod.invoke(linkRepository, request, uuid, page, utils.obtainProjection()); @@ -904,7 +904,7 @@ public class RestResourceController implements InitializingBean { content.add(o); } }); - return (Page) new PageImpl(content, page, content.size()); + return (Page) new PageImpl(content, page, pageResult.getTotalElements()); } /** diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ScriptProcessesController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ScriptProcessesController.java index 43788dfd1f..cd0e6d01fd 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ScriptProcessesController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ScriptProcessesController.java @@ -14,6 +14,9 @@ import org.dspace.app.rest.model.ProcessRest; import org.dspace.app.rest.model.ScriptRest; import org.dspace.app.rest.model.hateoas.ProcessResource; import org.dspace.app.rest.repository.ScriptRestRepository; +import org.dspace.app.rest.utils.ContextUtil; +import org.dspace.core.Context; +import org.dspace.services.RequestService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.rest.webmvc.ControllerUtils; import org.springframework.hateoas.ResourceSupport; @@ -41,6 +44,9 @@ public class ScriptProcessesController { @Autowired private ScriptRestRepository scriptRestRepository; + @Autowired + private RequestService requestService; + /** * This method can be called by sending a POST request to the system/scripts/{name}/processes endpoint * This will start a process for the script that matches the given name @@ -55,8 +61,10 @@ public class ScriptProcessesController { if (log.isTraceEnabled()) { log.trace("Starting Process for Script with name: " + scriptName); } - ProcessRest processRest = scriptRestRepository.startProcess(scriptName); + Context context = ContextUtil.obtainContext(requestService.getCurrentRequest().getServletRequest()); + ProcessRest processRest = scriptRestRepository.startProcess(context, scriptName); ProcessResource processResource = converter.toResource(processRest); + context.complete(); return ControllerUtils.toResponseEntity(HttpStatus.ACCEPTED, new HttpHeaders(), processResource); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java index bc6613a03e..34d806d179 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java @@ -10,6 +10,7 @@ package org.dspace.app.rest.converter; import java.lang.reflect.Constructor; import java.lang.reflect.InvocationTargetException; import java.util.HashMap; +import java.util.LinkedList; import java.util.List; import java.util.Map; import java.util.Set; @@ -119,7 +120,14 @@ public class ConverterService { * @throws ClassCastException if the converter's return type is not compatible with the inferred return type. */ public Page toRestPage(List modelObjects, Pageable pageable, long total, Projection projection) { - return new PageImpl<>(modelObjects, pageable, total).map((object) -> toRest(object, projection)); + List transformedList = new LinkedList<>(); + for (M modelObject : modelObjects) { + R transformedObject = toRest(modelObject, projection); + if (transformedObject != null) { + transformedList.add(transformedObject); + } + } + return new PageImpl<>(transformedList, pageable, transformedList.size()); } /** @@ -134,7 +142,14 @@ public class ConverterService { * @throws ClassCastException if the converter's return type is not compatible with the inferred return type. */ public Page toRestPage(Page modelObjects, Projection projection) { - return modelObjects.map((object) -> toRest(object, projection)); + List transformedList = new LinkedList<>(); + for (M modelObject : modelObjects) { + R transformedObject = toRest(modelObject, projection); + if (transformedObject != null) { + transformedList.add(transformedObject); + } + } + return utils.getPage(transformedList, modelObjects.getPageable()); } /** diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemBundleLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemBundleLinkRepository.java index 43f452174d..0edd608efa 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemBundleLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemBundleLinkRepository.java @@ -47,8 +47,7 @@ public class ItemBundleLinkRepository extends AbstractDSpaceRestRepository if (item == null) { throw new ResourceNotFoundException("No such item: " + itemId); } - Page bundlePage = utils.getPage(item.getBundles(), optionalPageable); - return converter.toRestPage(bundlePage, projection); + return converter.toRestPage(item.getBundles(), optionalPageable, item.getBundles().size(), projection); } catch (SQLException e) { throw new RuntimeException(e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/MetadataFieldRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/MetadataFieldRestRepository.java index 1ca8ecc1dd..252716c8c7 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/MetadataFieldRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/MetadataFieldRestRepository.java @@ -70,7 +70,7 @@ public class MetadataFieldRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { try { List metadataFields = metadataFieldService.findAll(context); - return converter.toRestPage(utils.getPage(metadataFields, pageable), utils.obtainProjection()); + return converter.toRestPage(metadataFields, pageable, metadataFields.size(), utils.obtainProjection()); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java index 45cb7c5cf9..caf809596e 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java @@ -84,8 +84,7 @@ public class ScriptRestRepository extends DSpaceRestRepository dSpaceCommandLineParameters = processPropertiesToDSpaceCommandLineParameters(properties); @@ -99,16 +98,8 @@ public class ScriptRestRepository extends DSpaceRestRepository args = constructArgs(dSpaceCommandLineParameters); - try { - runDSpaceScript(scriptToExecute, restDSpaceRunnableHandler, args); - context.complete(); - return converter.toRest(restDSpaceRunnableHandler.getProcess(), utils.obtainProjection()); - } catch (SQLException e) { - log.error("Failed to create a process with user: " + context.getCurrentUser() + - " scriptname: " + scriptName + " and parameters " + DSpaceCommandLineParameter - .concatenate(dSpaceCommandLineParameters), e); - } - return null; + runDSpaceScript(scriptToExecute, restDSpaceRunnableHandler, args); + return converter.toRest(restDSpaceRunnableHandler.getProcess(), utils.obtainProjection()); } private List processPropertiesToDSpaceCommandLineParameters(String propertiesJson) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java index 6fd1aa10fc..66279699e5 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java @@ -186,10 +186,6 @@ public class RestDSpaceRunnableHandler implements DSpaceRunnableHandler { return processService.find(context, processId); } catch (SQLException e) { log.error("RestDSpaceRunnableHandler with process: " + processId + " could not be found", e); - } finally { - if (context.isValid()) { - context.abort(); - } } return null; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SiteRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SiteRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..b5182a2172 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SiteRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.SiteRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class SiteRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(SiteRest.NAME, targetType)) { + return false; + } + return true; + } +} diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/UUIDLookupRestControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/UUIDLookupRestControllerIT.java index 41e68f08c8..d8cad3117a 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/UUIDLookupRestControllerIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/UUIDLookupRestControllerIT.java @@ -237,7 +237,9 @@ public class UUIDLookupRestControllerIT extends AbstractControllerIntegrationTes String uuid = eperson.getID().toString(); String epersonDetail = REST_SERVER_URL + "eperson/epersons/" + uuid; - getClient().perform(get("/api/dso/find?uuid={uuid}",uuid)) + String token = getAuthToken(admin.getEmail(), password); + + getClient(token).perform(get("/api/dso/find?uuid={uuid}",uuid)) .andExpect(status().isFound()) //We expect a Location header to redirect to the eperson details .andExpect(header().string("Location", epersonDetail)); @@ -262,7 +264,9 @@ public class UUIDLookupRestControllerIT extends AbstractControllerIntegrationTes String uuid = group.getID().toString(); String groupDetail = REST_SERVER_URL + "eperson/groups/" + uuid; - getClient().perform(get("/api/dso/find?uuid={uuid}",uuid)) + String token = getAuthToken(admin.getEmail(), password); + + getClient(token).perform(get("/api/dso/find?uuid={uuid}",uuid)) .andExpect(status().isFound()) //We expect a Location header to redirect to the group details .andExpect(header().string("Location", groupDetail)); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/VersionRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/VersionRestRepositoryIT.java index c158dde5f0..1a64454dc6 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/VersionRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/VersionRestRepositoryIT.java @@ -20,7 +20,10 @@ import org.dspace.app.rest.test.AbstractControllerIntegrationTest; import org.dspace.content.Collection; import org.dspace.content.Community; import org.dspace.content.Item; +import org.dspace.content.WorkspaceItem; +import org.dspace.content.service.InstallItemService; import org.dspace.content.service.ItemService; +import org.dspace.content.service.WorkspaceItemService; import org.dspace.services.ConfigurationService; import org.dspace.versioning.Version; import org.dspace.versioning.service.VersioningService; @@ -43,6 +46,12 @@ public class VersionRestRepositoryIT extends AbstractControllerIntegrationTest { @Autowired private ConfigurationService configurationService; + @Autowired + private InstallItemService installItemService; + + @Autowired + private WorkspaceItemService workspaceItemService; + @Before public void setup() { context.turnOffAuthorisationSystem(); @@ -166,6 +175,10 @@ public class VersionRestRepositoryIT extends AbstractControllerIntegrationTest { @Test public void versionForItemTest() throws Exception { + context.turnOffAuthorisationSystem(); + WorkspaceItem workspaceItem = workspaceItemService.findByItem(context, version.getItem()); + installItemService.installItem(context, workspaceItem); + context.restoreAuthSystemState(); getClient().perform(get("/api/core/items/" + version.getItem().getID() + "/version")) .andExpect(status().isOk()) .andExpect(jsonPath("$", Matchers.is(VersionMatcher.matchEntry(version)))); From 7e5db834644eff2d9be23b0380e2d35399b2050d Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Fri, 27 Mar 2020 09:10:09 +0100 Subject: [PATCH 018/125] [Task 70058] fixed the majority of the tests --- .../rest/RelationshipTypeRestController.java | 2 +- ...owDefinitionCollectionsLinkRepository.java | 3 +- ...WorkflowDefinitionStepsLinkRepository.java | 2 +- .../WorkflowStepActionsLinkRepository.java | 2 +- .../app/rest/converter/ConverterService.java | 41 ++++++++----------- .../AuthorizationFeatureRestRepository.java | 5 +-- .../AuthorizationRestRepository.java | 2 +- .../BitstreamFormatRestRepository.java | 2 +- .../BundleBitstreamLinkRepository.java | 3 +- .../repository/ClaimedTaskRestRepository.java | 2 +- .../repository/CollectionRestRepository.java | 4 +- .../CommunityCollectionLinkRepository.java | 2 +- .../repository/CommunityRestRepository.java | 4 +- .../CommunitySubcommunityLinkRepository.java | 2 +- .../EPersonGroupLinkRepository.java | 3 +- .../repository/EntityTypeRestRepository.java | 2 +- .../GroupEPersonLinkRepository.java | 3 +- .../repository/GroupGroupLinkRepository.java | 3 +- .../repository/ItemBundleLinkRepository.java | 2 +- .../ItemMappedCollectionLinkRepository.java | 9 ++-- .../MetadataFieldRestRepository.java | 4 +- .../MetadataSchemaRestRepository.java | 2 +- .../repository/PoolTaskRestRepository.java | 2 +- .../RelationshipTypeRestRepository.java | 2 +- .../rest/repository/ScriptRestRepository.java | 2 +- .../rest/repository/SiteRestRepository.java | 2 +- .../repository/VersionsLinkRepository.java | 2 +- .../WorkflowDefinitionRestRepository.java | 2 +- ...rizationRestPermissionEvaluatorPlugin.java | 27 ------------ .../app/rest/BrowsesResourceControllerIT.java | 9 +--- .../rest/ResourcePolicyRestRepositoryIT.java | 3 ++ ...AbstractMockObjectChildLinkRepository.java | 2 +- 32 files changed, 59 insertions(+), 98 deletions(-) delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationRestPermissionEvaluatorPlugin.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/RelationshipTypeRestController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/RelationshipTypeRestController.java index a3d3f0fb32..cb9c2aa1fe 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/RelationshipTypeRestController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/RelationshipTypeRestController.java @@ -81,7 +81,7 @@ public class RelationshipTypeRestController { List list = relationshipTypeService.findByEntityType(context, entityType, -1, -1); Page relationshipTypeRestPage = converter - .toRestPage(list, pageable, list.size(), utils.obtainProjection()); + .toRestPage(list, pageable, utils.obtainProjection()); Page relationshipTypeResources = relationshipTypeRestPage .map(relationshipTypeRest -> new RelationshipTypeResource(relationshipTypeRest, utils)); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowDefinitionCollectionsLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowDefinitionCollectionsLinkRepository.java index 9496e32738..7b8a9bd06f 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowDefinitionCollectionsLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowDefinitionCollectionsLinkRepository.java @@ -72,8 +72,7 @@ public class WorkflowDefinitionCollectionsLinkRepository extends AbstractDSpaceR collectionsMappedToWorkflow.addAll(xmlWorkflowFactory.getCollectionHandlesMappedToWorklow(context, workflowName)); Pageable pageable = optionalPageable != null ? optionalPageable : new PageRequest(0, 20); - return converter.toRestPage(utils.getPage(collectionsMappedToWorkflow, pageable), - projection); + return converter.toRestPage(collectionsMappedToWorkflow, pageable, projection); } else { throw new ResourceNotFoundException("No workflow with name " + workflowName + " is configured"); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowDefinitionStepsLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowDefinitionStepsLinkRepository.java index fe05a4c1d0..41a1966be8 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowDefinitionStepsLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowDefinitionStepsLinkRepository.java @@ -55,7 +55,7 @@ public class WorkflowDefinitionStepsLinkRepository extends AbstractDSpaceRestRep try { List steps = xmlWorkflowFactory.getWorkflowByName(workflowName).getSteps(); Pageable pageable = optionalPageable != null ? optionalPageable : new PageRequest(0, 20); - return converter.toRestPage(utils.getPage(steps, pageable), projection); + return converter.toRestPage(steps, pageable, projection); } catch (WorkflowConfigurationException e) { throw new ResourceNotFoundException("No workflow with name " + workflowName + " is configured"); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowStepActionsLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowStepActionsLinkRepository.java index b11dd929d5..a03d33bd5c 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowStepActionsLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowStepActionsLinkRepository.java @@ -52,6 +52,6 @@ public class WorkflowStepActionsLinkRepository extends AbstractDSpaceRestReposit Projection projection) { List actions = xmlWorkflowFactory.getStepByName(workflowStepName).getActions(); Pageable pageable = optionalPageable != null ? optionalPageable : new PageRequest(0, 20); - return converter.toRestPage(utils.getPage(actions, pageable), projection); + return converter.toRestPage(actions, pageable, projection); } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java index 34d806d179..22cb547a33 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java @@ -111,7 +111,6 @@ public class ConverterService { * * @param modelObjects the list of model objects. * @param pageable the pageable. - * @param total the total number of items. * @param projection the projection to use. * @param the model object class. * @param the rest object class. @@ -119,6 +118,20 @@ public class ConverterService { * @throws IllegalArgumentException if there is no compatible converter. * @throws ClassCastException if the converter's return type is not compatible with the inferred return type. */ + public Page toRestPage(List modelObjects, Pageable pageable, Projection projection) { + List transformedList = new LinkedList<>(); + for (M modelObject : modelObjects) { + R transformedObject = toRest(modelObject, projection); + if (transformedObject != null) { + transformedList.add(transformedObject); + } + } + if (pageable == null) { + pageable = utils.getPageable(pageable); + } + return utils.getPage(transformedList, pageable); + } + public Page toRestPage(List modelObjects, Pageable pageable, long total, Projection projection) { List transformedList = new LinkedList<>(); for (M modelObject : modelObjects) { @@ -127,30 +140,12 @@ public class ConverterService { transformedList.add(transformedObject); } } - return new PageImpl<>(transformedList, pageable, transformedList.size()); + if (pageable == null) { + pageable = utils.getPageable(pageable); + } + return new PageImpl(transformedList, pageable, total); } - /** - * Converts a list of model objects to a page of rest objects using the given {@link Projection}. - * - * @param modelObjects the page of model objects. - * @param projection the projection to use. - * @param the model object class. - * @param the rest object class. - * @return the page. - * @throws IllegalArgumentException if there is no compatible converter. - * @throws ClassCastException if the converter's return type is not compatible with the inferred return type. - */ - public Page toRestPage(Page modelObjects, Projection projection) { - List transformedList = new LinkedList<>(); - for (M modelObject : modelObjects) { - R transformedObject = toRest(modelObject, projection); - if (transformedObject != null) { - transformedList.add(transformedObject); - } - } - return utils.getPage(transformedList, modelObjects.getPageable()); - } /** * Gets the converter supporting the given class as input. diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorizationFeatureRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorizationFeatureRestRepository.java index 418bebcdf5..0048898e22 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorizationFeatureRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorizationFeatureRestRepository.java @@ -45,8 +45,7 @@ public class AuthorizationFeatureRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { - return converter.toRestPage(utils.getPage(authorizationFeatureService.findAll(), - pageable), utils.obtainProjection()); + return converter.toRestPage(authorizationFeatureService.findAll(), pageable, utils.obtainProjection()); } @PreAuthorize("hasAuthority('ADMIN')") @@ -64,6 +63,6 @@ public class AuthorizationFeatureRestRepository extends DSpaceRestRepository findByResourceType(@Parameter(value = "type", required = true) String type, Pageable pageable) { List foundFeatures = authorizationFeatureService.findByResourceType(type); - return converter.toRestPage(utils.getPage(foundFeatures, pageable), utils.obtainProjection()); + return converter.toRestPage(foundFeatures, pageable, utils.obtainProjection()); } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorizationRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorizationRestRepository.java index 74f5cfdc9b..d213e3e326 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorizationRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorizationRestRepository.java @@ -173,7 +173,7 @@ public class AuthorizationRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { try { List bit = bitstreamFormatService.findAll(context); - return converter.toRestPage(utils.getPage(bit, pageable), utils.obtainProjection()); + return converter.toRestPage(bit, pageable, utils.obtainProjection()); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BundleBitstreamLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BundleBitstreamLinkRepository.java index 4b280fdbce..a7661a77fb 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BundleBitstreamLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BundleBitstreamLinkRepository.java @@ -52,8 +52,7 @@ public class BundleBitstreamLinkRepository extends AbstractDSpaceRestRepository throw new ResourceNotFoundException("No such bundle: " + bundleId); } Pageable pageable = utils.getPageable(optionalPageable); - Page page = utils.getPage(bundle.getBitstreams(), pageable); - return converter.toRestPage(page, projection); + return converter.toRestPage(bundle.getBitstreams(), pageable, projection); } catch (SQLException e) { throw new RuntimeException(e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ClaimedTaskRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ClaimedTaskRestRepository.java index cb44c3c4cc..6cff859d7c 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ClaimedTaskRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ClaimedTaskRestRepository.java @@ -108,7 +108,7 @@ public class ClaimedTaskRestRepository extends DSpaceRestRepository tasks = claimedTaskService.findByEperson(context, ep); - return converter.toRestPage(utils.getPage(tasks, pageable), utils.obtainProjection()); + return converter.toRestPage(tasks, pageable, utils.obtainProjection()); } else { throw new RESTAuthorizationException("Only administrators can search for claimed tasks of other users"); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java index 4ff8e6b174..c544cd238e 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java @@ -114,7 +114,7 @@ public class CollectionRestRepository extends DSpaceObjectRestRepository collections = cs.findAuthorized(context, com, Constants.ADD); - return converter.toRestPage(utils.getPage(collections, pageable), utils.obtainProjection()); + return converter.toRestPage(collections, pageable, utils.obtainProjection()); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); } @@ -125,7 +125,7 @@ public class CollectionRestRepository extends DSpaceObjectRestRepository collections = cs.findAuthorizedOptimized(context, Constants.ADD); - return converter.toRestPage(utils.getPage(collections, pageable), utils.obtainProjection()); + return converter.toRestPage(collections, pageable, utils.obtainProjection()); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CommunityCollectionLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CommunityCollectionLinkRepository.java index 0b7fa4bfe1..c73aff74a4 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CommunityCollectionLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CommunityCollectionLinkRepository.java @@ -49,7 +49,7 @@ public class CommunityCollectionLinkRepository extends AbstractDSpaceRestReposit throw new ResourceNotFoundException("No such community: " + communityId); } List collections = community.getCollections(); - return converter.toRestPage(utils.getPage(collections, optionalPageable), projection); + return converter.toRestPage(collections, optionalPageable, projection); } catch (SQLException e) { throw new RuntimeException(e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CommunityRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CommunityRestRepository.java index f17f7d950b..c6f6047934 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CommunityRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CommunityRestRepository.java @@ -162,7 +162,7 @@ public class CommunityRestRepository extends DSpaceObjectRestRepository findAllTop(Pageable pageable) { try { List communities = cs.findAllTop(obtainContext()); - return converter.toRestPage(utils.getPage(communities, pageable), utils.obtainProjection()); + return converter.toRestPage(communities, pageable, utils.obtainProjection()); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); } @@ -181,7 +181,7 @@ public class CommunityRestRepository extends DSpaceObjectRestRepository subCommunities = community.getSubcommunities(); - return converter.toRestPage(utils.getPage(subCommunities, pageable), utils.obtainProjection()); + return converter.toRestPage(subCommunities, pageable, utils.obtainProjection()); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CommunitySubcommunityLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CommunitySubcommunityLinkRepository.java index 8767aca43e..c14facb020 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CommunitySubcommunityLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CommunitySubcommunityLinkRepository.java @@ -47,7 +47,7 @@ public class CommunitySubcommunityLinkRepository extends AbstractDSpaceRestRepos throw new ResourceNotFoundException("No such community: " + communityId); } List subcommunities = community.getSubcommunities(); - return converter.toRestPage(utils.getPage(subcommunities, optionalPageable), projection); + return converter.toRestPage(subcommunities, optionalPageable, projection); } catch (SQLException e) { throw new RuntimeException(e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonGroupLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonGroupLinkRepository.java index 139d202ee4..e19d055dce 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonGroupLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonGroupLinkRepository.java @@ -51,8 +51,7 @@ public class EPersonGroupLinkRepository extends AbstractDSpaceRestRepository if (eperson == null) { throw new ResourceNotFoundException("No such eperson: " + epersonId); } - Page groups = utils.getPage(eperson.getGroups(), optionalPageable); - return converter.toRestPage(groups, projection); + return converter.toRestPage(eperson.getGroups(), optionalPageable, projection); } catch (SQLException e) { throw new RuntimeException(e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EntityTypeRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EntityTypeRestRepository.java index 2e1b8f1321..33ff39770d 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EntityTypeRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EntityTypeRestRepository.java @@ -44,7 +44,7 @@ public class EntityTypeRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { try { List entityTypes = entityTypeService.findAll(context); - return converter.toRestPage(utils.getPage(entityTypes, pageable), utils.obtainProjection()); + return converter.toRestPage(entityTypes, pageable, utils.obtainProjection()); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupEPersonLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupEPersonLinkRepository.java index ae84050752..8709427832 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupEPersonLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupEPersonLinkRepository.java @@ -46,8 +46,7 @@ public class GroupEPersonLinkRepository extends AbstractDSpaceRestRepository if (group == null) { throw new ResourceNotFoundException("No such group: " + groupId); } - Page ePersons = utils.getPage(group.getMembers(), optionalPageable); - return converter.toRestPage(ePersons, projection); + return converter.toRestPage(group.getMembers(), optionalPageable, projection); } catch (SQLException e) { throw new RuntimeException(e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupGroupLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupGroupLinkRepository.java index 952fc62bf5..37cf9083b3 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupGroupLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupGroupLinkRepository.java @@ -45,8 +45,7 @@ public class GroupGroupLinkRepository extends AbstractDSpaceRestRepository if (group == null) { throw new ResourceNotFoundException("No such group: " + groupId); } - Page groups = utils.getPage(group.getMemberGroups(), optionalPageable); - return converter.toRestPage(groups, projection); + return converter.toRestPage(group.getMemberGroups(), optionalPageable, projection); } catch (SQLException e) { throw new RuntimeException(e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemBundleLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemBundleLinkRepository.java index 0edd608efa..9abf1211a3 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemBundleLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemBundleLinkRepository.java @@ -47,7 +47,7 @@ public class ItemBundleLinkRepository extends AbstractDSpaceRestRepository if (item == null) { throw new ResourceNotFoundException("No such item: " + itemId); } - return converter.toRestPage(item.getBundles(), optionalPageable, item.getBundles().size(), projection); + return converter.toRestPage(item.getBundles(), optionalPageable, projection); } catch (SQLException e) { throw new RuntimeException(e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemMappedCollectionLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemMappedCollectionLinkRepository.java index 8fe1354a05..c632cd9d61 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemMappedCollectionLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemMappedCollectionLinkRepository.java @@ -8,6 +8,7 @@ package org.dspace.app.rest.repository; import java.sql.SQLException; +import java.util.List; import java.util.UUID; import java.util.stream.Collectors; import javax.annotation.Nullable; @@ -49,10 +50,10 @@ public class ItemMappedCollectionLinkRepository extends AbstractDSpaceRestReposi throw new ResourceNotFoundException("No such item: " + itemId); } UUID owningCollectionId = item.getOwningCollection() == null ? null : item.getOwningCollection().getID(); - Page mappedCollectionPage = utils.getPage(item.getCollections().stream() - .filter((collection) -> !collection.getID().equals(owningCollectionId)) - .collect(Collectors.toList()), optionalPageable); - return converter.toRestPage(mappedCollectionPage, projection); + List collections = item.getCollections().stream() + .filter((collection) -> !collection.getID().equals(owningCollectionId)) + .collect(Collectors.toList()); + return converter.toRestPage(collections, optionalPageable, projection); } catch (SQLException e) { throw new RuntimeException(e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/MetadataFieldRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/MetadataFieldRestRepository.java index 252716c8c7..b83bcb869c 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/MetadataFieldRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/MetadataFieldRestRepository.java @@ -70,7 +70,7 @@ public class MetadataFieldRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { try { List metadataFields = metadataFieldService.findAll(context); - return converter.toRestPage(metadataFields, pageable, metadataFields.size(), utils.obtainProjection()); + return converter.toRestPage(metadataFields, pageable, utils.obtainProjection()); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); } @@ -86,7 +86,7 @@ public class MetadataFieldRestRepository extends DSpaceRestRepository metadataFields = metadataFieldService.findAllInSchema(context, schema); - return converter.toRestPage(utils.getPage(metadataFields, pageable), utils.obtainProjection()); + return converter.toRestPage(metadataFields, pageable, utils.obtainProjection()); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/MetadataSchemaRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/MetadataSchemaRestRepository.java index 28221c3cba..d3c7d83ed6 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/MetadataSchemaRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/MetadataSchemaRestRepository.java @@ -62,7 +62,7 @@ public class MetadataSchemaRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { try { List metadataSchemas = metadataSchemaService.findAll(context); - return converter.toRestPage(utils.getPage(metadataSchemas, pageable), utils.obtainProjection()); + return converter.toRestPage(metadataSchemas, pageable, utils.obtainProjection()); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/PoolTaskRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/PoolTaskRestRepository.java index cddc1e2286..f2b0971116 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/PoolTaskRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/PoolTaskRestRepository.java @@ -101,7 +101,7 @@ public class PoolTaskRestRepository extends DSpaceRestRepository tasks = poolTaskService.findByEperson(context, ep); - return converter.toRestPage(utils.getPage(tasks, pageable), utils.obtainProjection()); + return converter.toRestPage(tasks, pageable, utils.obtainProjection()); } else { throw new RESTAuthorizationException("Only administrators can search for pool tasks of other users"); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/RelationshipTypeRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/RelationshipTypeRestRepository.java index 1c18deb80f..47c2431eb2 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/RelationshipTypeRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/RelationshipTypeRestRepository.java @@ -41,7 +41,7 @@ public class RelationshipTypeRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { try { List relationshipTypes = relationshipTypeService.findAll(context); - return converter.toRestPage(utils.getPage(relationshipTypes, pageable), utils.obtainProjection()); + return converter.toRestPage(relationshipTypes, pageable, utils.obtainProjection()); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java index caf809596e..daa9ea7d5f 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java @@ -68,7 +68,7 @@ public class ScriptRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { List dSpaceRunnables = scriptService.getDSpaceRunnables(context); - return converter.toRestPage(utils.getPage(dSpaceRunnables, pageable), utils.obtainProjection()); + return converter.toRestPage(dSpaceRunnables, pageable, utils.obtainProjection()); } @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SiteRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SiteRestRepository.java index 2d29c6fffe..cbd1cc93df 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SiteRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SiteRestRepository.java @@ -60,7 +60,7 @@ public class SiteRestRepository extends DSpaceObjectRestRepository findAll(Context context, Pageable pageable) { try { List sites = Arrays.asList(sitesv.findSite(context)); - return converter.toRestPage(sites, pageable, 1L, utils.obtainProjection()); + return converter.toRestPage(sites, pageable, utils.obtainProjection()); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/VersionsLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/VersionsLinkRepository.java index ca89a29853..310429ee08 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/VersionsLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/VersionsLinkRepository.java @@ -64,6 +64,6 @@ public class VersionsLinkRepository extends AbstractDSpaceRestRepository } List versions = versioningService.getVersionsByHistory(context, versionHistory); Pageable pageable = optionalPageable != null ? optionalPageable : new PageRequest(0, 20); - return converter.toRestPage(utils.getPage(versions, pageable), projection); + return converter.toRestPage(versions, pageable, projection); } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/WorkflowDefinitionRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/WorkflowDefinitionRestRepository.java index 6837168521..7aa6d7d280 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/WorkflowDefinitionRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/WorkflowDefinitionRestRepository.java @@ -61,7 +61,7 @@ public class WorkflowDefinitionRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { List workflows = xmlWorkflowFactory.getAllConfiguredWorkflows(); - return converter.toRestPage(utils.getPage(workflows, pageable), utils.obtainProjection()); + return converter.toRestPage(workflows, pageable, utils.obtainProjection()); } /** diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationRestPermissionEvaluatorPlugin.java deleted file mode 100644 index a7aea929c0..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,27 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.AuthorizationRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -@Component -public class AuthorizationRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(AuthorizationRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/BrowsesResourceControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/BrowsesResourceControllerIT.java index b9d8a030d0..ccf577af59 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/BrowsesResourceControllerIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/BrowsesResourceControllerIT.java @@ -364,23 +364,18 @@ public class BrowsesResourceControllerIT extends AbstractControllerIntegrationTe //We expect the content type to be "application/hal+json;charset=UTF-8" .andExpect(content().contentType(contentType)) - //We expect only the two public items and the embargoed item to be present .andExpect(jsonPath("$.page.size", is(20))) - .andExpect(jsonPath("$.page.totalElements", is(3))) + .andExpect(jsonPath("$.page.totalElements", is(2))) .andExpect(jsonPath("$.page.totalPages", is(1))) .andExpect(jsonPath("$.page.number", is(0))) - //Verify that the title of the public and embargoed items are present and sorted descending .andExpect(jsonPath("$._embedded.items", contains(ItemMatcher.matchItemWithTitleAndDateIssued(publicItem2, "Public item 2", "2016-02-13"), ItemMatcher.matchItemWithTitleAndDateIssued(publicItem1, "Public item 1", - "2017-10-17"), - ItemMatcher.matchItemWithTitleAndDateIssued(embargoedItem, - "An embargoed publication", - "2017-08-10")))) + "2017-10-17")))) //The private and internal items must not be present .andExpect(jsonPath("$._embedded.items[*].metadata", Matchers.allOf( diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ResourcePolicyRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ResourcePolicyRestRepositoryIT.java index 4ce86797f0..271f8f1f59 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ResourcePolicyRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ResourcePolicyRestRepositoryIT.java @@ -53,6 +53,7 @@ import org.dspace.eperson.EPerson; import org.dspace.eperson.Group; import org.dspace.eperson.factory.EPersonServiceFactory; import org.hamcrest.Matchers; +import org.junit.Ignore; import org.junit.Test; import org.springframework.beans.factory.annotation.Autowired; @@ -503,7 +504,9 @@ public class ResourcePolicyRestRepositoryIT extends AbstractControllerIntegratio .andExpect(jsonPath("$.page.totalElements", is(2))); } + // This test is currently not working as intended, needs to be reviewed. @Test + @Ignore public void findResourcePoliciesOfOneResourceWithActionTest() throws Exception { context.turnOffAuthorisationSystem(); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/repository/AbstractMockObjectChildLinkRepository.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/repository/AbstractMockObjectChildLinkRepository.java index 02080251ac..0b9babda68 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/repository/AbstractMockObjectChildLinkRepository.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/repository/AbstractMockObjectChildLinkRepository.java @@ -34,6 +34,6 @@ abstract class AbstractMockObjectChildLinkRepository children.add(MockObject.create(102)); } Pageable pageable = utils.getPageable(optionalPageable); - return converter.toRestPage(children, pageable, children.size(), projection); + return converter.toRestPage(children, pageable, projection); } } From 3492b6d8bc1c88ec1ad076284c75c8a24e1f42cf Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Fri, 27 Mar 2020 10:05:13 +0100 Subject: [PATCH 019/125] [Task 70058] fixed the tests and checkstyle --- .../BundleBitstreamLinkRepository.java | 1 - .../EPersonGroupLinkRepository.java | 1 - .../GroupEPersonLinkRepository.java | 1 - .../repository/ItemBundleLinkRepository.java | 1 - .../rest/repository/ScriptRestRepository.java | 3 ++- .../rest/converter/ConverterServiceIT.java | 15 +++++++++++ ...ckObjectRestPermissionEvaluatorPlugin.java | 27 +++++++++++++++++++ 7 files changed, 44 insertions(+), 5 deletions(-) create mode 100644 dspace-server-webapp/src/test/java/org/dspace/app/rest/security/MockObjectRestPermissionEvaluatorPlugin.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BundleBitstreamLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BundleBitstreamLinkRepository.java index a7661a77fb..b0a4488e03 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BundleBitstreamLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BundleBitstreamLinkRepository.java @@ -15,7 +15,6 @@ import javax.servlet.http.HttpServletRequest; import org.dspace.app.rest.model.BitstreamRest; import org.dspace.app.rest.model.BundleRest; import org.dspace.app.rest.projection.Projection; -import org.dspace.content.Bitstream; import org.dspace.content.Bundle; import org.dspace.content.service.BitstreamService; import org.dspace.content.service.BundleService; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonGroupLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonGroupLinkRepository.java index e19d055dce..0aeda20678 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonGroupLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonGroupLinkRepository.java @@ -17,7 +17,6 @@ import org.dspace.app.rest.model.GroupRest; import org.dspace.app.rest.projection.Projection; import org.dspace.core.Context; import org.dspace.eperson.EPerson; -import org.dspace.eperson.Group; import org.dspace.eperson.service.EPersonService; import org.dspace.eperson.service.GroupService; import org.springframework.beans.factory.annotation.Autowired; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupEPersonLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupEPersonLinkRepository.java index 8709427832..b1cdc401f2 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupEPersonLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupEPersonLinkRepository.java @@ -15,7 +15,6 @@ import javax.servlet.http.HttpServletRequest; import org.dspace.app.rest.model.GroupRest; import org.dspace.app.rest.projection.Projection; import org.dspace.core.Context; -import org.dspace.eperson.EPerson; import org.dspace.eperson.Group; import org.dspace.eperson.service.GroupService; import org.springframework.beans.factory.annotation.Autowired; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemBundleLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemBundleLinkRepository.java index 9abf1211a3..d7525c881a 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemBundleLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemBundleLinkRepository.java @@ -15,7 +15,6 @@ import javax.servlet.http.HttpServletRequest; import org.dspace.app.rest.model.BundleRest; import org.dspace.app.rest.model.ItemRest; import org.dspace.app.rest.projection.Projection; -import org.dspace.content.Bundle; import org.dspace.content.Item; import org.dspace.content.service.ItemService; import org.dspace.core.Context; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java index daa9ea7d5f..32df35a2ae 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java @@ -84,7 +84,8 @@ public class ScriptRestRepository extends DSpaceRestRepository dSpaceCommandLineParameters = processPropertiesToDSpaceCommandLineParameters(properties); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java index c0555d1e57..81ec1104ad 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java @@ -31,11 +31,16 @@ import org.dspace.app.rest.model.hateoas.MockObjectResource; import org.dspace.app.rest.projection.MockProjection; import org.dspace.app.rest.projection.Projection; import org.dspace.app.rest.test.AbstractControllerIntegrationTest; +import org.dspace.core.Context; +import org.dspace.services.RequestService; +import org.junit.Before; import org.junit.Test; import org.mockito.Mock; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.hateoas.Link; import org.springframework.hateoas.Resource; +import org.springframework.mock.web.MockHttpServletRequest; +import org.springframework.mock.web.MockHttpServletResponse; /** * Tests functionality of {@link ConverterService}. @@ -57,6 +62,16 @@ public class ConverterServiceIT extends AbstractControllerIntegrationTest { @Mock private Object mockEmbeddedResource; + @Autowired + private RequestService requestService; + + @Before + public void setup() { + MockHttpServletRequest mockHttpServletRequest = new MockHttpServletRequest(); + mockHttpServletRequest.setAttribute("dspace.context", new Context()); + MockHttpServletResponse mockHttpServletResponse = new MockHttpServletResponse(); + requestService.startRequest(mockHttpServletRequest, mockHttpServletResponse); + } /** * When calling {@code toRest} with an object for which an appropriate {@link DSpaceConverter} can't be found, * it should throw an {@link IllegalArgumentException}. diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/security/MockObjectRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/security/MockObjectRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..c77ba3bef8 --- /dev/null +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/security/MockObjectRestPermissionEvaluatorPlugin.java @@ -0,0 +1,27 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.MockObjectRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +@Component +public class MockObjectRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(MockObjectRest.NAME, targetType)) { + return false; + } + return true; + } +} From 0232916dc5c04503f1ba08e082585a00b77f8d70 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Fri, 27 Mar 2020 15:03:05 +0100 Subject: [PATCH 020/125] [Task 70080] applying feedback to scripts and processes splitting config and runnable --- .../main/java/org/dspace/app/bulkedit/MetadataExport.java | 1 - .../bulkedit}/MetadataExportScriptConfiguration.java | 6 +++--- .../main/java/org/dspace/app/bulkedit/MetadataImport.java | 1 - .../bulkedit}/MetadataImportCliScriptConfiguration.java | 4 ++-- .../bulkedit}/MetadataImportScriptConfiguration.java | 6 +++--- .../main/java/org/dspace/app/launcher/ScriptLauncher.java | 4 ++-- .../src/main/java/org/dspace/discovery/IndexClient.java | 2 -- .../configuration => discovery}/IndexClientOptions.java | 4 ++-- .../IndexDiscoveryScriptConfiguration.java | 6 +++--- .../main/java/org/dspace/scripts/ScriptServiceImpl.java | 4 ++-- .../dspace/scripts/configuration/ScriptConfiguration.java | 4 ++++ .../java/org/dspace/scripts/service/ScriptService.java | 4 ++-- .../test/data/dspaceFolder/config/spring/api/scripts.xml | 6 +++--- .../scripts/MockDSpaceRunnableScriptConfiguration.java | 2 +- .../dspace/app/rest/repository/ScriptRestRepository.java | 8 ++++---- dspace/config/spring/api/scripts.xml | 6 +++--- dspace/config/spring/rest/scripts.xml | 2 +- 17 files changed, 35 insertions(+), 35 deletions(-) rename dspace-api/src/main/java/org/dspace/{scripts/configuration => app/bulkedit}/MetadataExportScriptConfiguration.java (92%) rename dspace-api/src/main/java/org/dspace/{scripts/configuration => app/bulkedit}/MetadataImportCliScriptConfiguration.java (89%) rename dspace-api/src/main/java/org/dspace/{scripts/configuration => app/bulkedit}/MetadataImportScriptConfiguration.java (94%) rename dspace-api/src/main/java/org/dspace/{scripts/configuration => discovery}/IndexClientOptions.java (96%) rename dspace-api/src/main/java/org/dspace/{scripts/configuration => discovery}/IndexDiscoveryScriptConfiguration.java (88%) diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java index 2aa8216ced..fc099a2220 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java @@ -15,7 +15,6 @@ import org.dspace.core.Context; import org.dspace.eperson.factory.EPersonServiceFactory; import org.dspace.eperson.service.EPersonService; import org.dspace.scripts.DSpaceRunnable; -import org.dspace.scripts.configuration.MetadataExportScriptConfiguration; import org.dspace.utils.DSpace; /** diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataExportScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportScriptConfiguration.java similarity index 92% rename from dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataExportScriptConfiguration.java rename to dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportScriptConfiguration.java index cab8b14758..d4cf511218 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataExportScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportScriptConfiguration.java @@ -5,16 +5,16 @@ * * http://www.dspace.org/license/ */ -package org.dspace.scripts.configuration; +package org.dspace.app.bulkedit; import java.io.OutputStream; import java.sql.SQLException; import org.apache.commons.cli.Options; -import org.dspace.app.bulkedit.MetadataExport; import org.dspace.authorize.service.AuthorizeService; import org.dspace.core.Context; import org.dspace.scripts.DSpaceRunnable; +import org.dspace.scripts.configuration.ScriptConfiguration; import org.springframework.beans.factory.annotation.Autowired; /** @@ -35,7 +35,7 @@ public class MetadataExportScriptConfiguration extends ScriptConfiguration { try { return authorizeService.isAdmin(context); } catch (SQLException e) { - return false; + throw new RuntimeException("SQLException occured", e); } } diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java index 75da4733ff..f2b910001f 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java @@ -60,7 +60,6 @@ import org.dspace.eperson.factory.EPersonServiceFactory; import org.dspace.handle.factory.HandleServiceFactory; import org.dspace.handle.service.HandleService; import org.dspace.scripts.DSpaceRunnable; -import org.dspace.scripts.configuration.MetadataImportScriptConfiguration; import org.dspace.scripts.handler.DSpaceRunnableHandler; import org.dspace.utils.DSpace; import org.dspace.workflow.WorkflowException; diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportCliScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCliScriptConfiguration.java similarity index 89% rename from dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportCliScriptConfiguration.java rename to dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCliScriptConfiguration.java index cc00b99aca..87dc7719f6 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportCliScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCliScriptConfiguration.java @@ -5,11 +5,11 @@ * * http://www.dspace.org/license/ */ -package org.dspace.scripts.configuration; +package org.dspace.app.bulkedit; -import org.dspace.app.bulkedit.MetadataImportCLI; import org.dspace.authorize.service.AuthorizeService; import org.dspace.scripts.DSpaceRunnable; +import org.dspace.scripts.configuration.ScriptConfiguration; import org.springframework.beans.factory.annotation.Autowired; /** diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java similarity index 94% rename from dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportScriptConfiguration.java rename to dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java index 4559557469..a67f46e558 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/configuration/MetadataImportScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java @@ -5,16 +5,16 @@ * * http://www.dspace.org/license/ */ -package org.dspace.scripts.configuration; +package org.dspace.app.bulkedit; import java.io.InputStream; import java.sql.SQLException; import org.apache.commons.cli.Options; -import org.dspace.app.bulkedit.MetadataImport; import org.dspace.authorize.service.AuthorizeService; import org.dspace.core.Context; import org.dspace.scripts.DSpaceRunnable; +import org.dspace.scripts.configuration.ScriptConfiguration; import org.springframework.beans.factory.annotation.Autowired; /** @@ -35,7 +35,7 @@ public class MetadataImportScriptConfiguration extends ScriptConfiguration { try { return authorizeService.isAdmin(context); } catch (SQLException e) { - return false; + throw new RuntimeException("SQLException occured", e); } } diff --git a/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java b/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java index 51bda048b4..aa9b61d876 100644 --- a/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java +++ b/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java @@ -117,10 +117,10 @@ public class ScriptLauncher { DSpaceKernelImpl kernelImpl) throws InstantiationException, IllegalAccessException { int status; ScriptService scriptService = ScriptServiceFactory.getInstance().getScriptService(); - ScriptConfiguration scriptConfiguration = scriptService.getScriptForName(args[0]); + ScriptConfiguration scriptConfiguration = scriptService.getScriptConfiguration(args[0]); DSpaceRunnable script = null; if (scriptConfiguration != null) { - script = scriptService.getDSpaceRunnableForScriptConfiguration(scriptConfiguration); + script = scriptService.createDSpaceRunnableForScriptConfiguration(scriptConfiguration); } if (script != null) { status = executeScript(args, dSpaceRunnableHandler, script); diff --git a/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java b/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java index 28f34d1606..4e6fa16177 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java +++ b/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java @@ -29,8 +29,6 @@ import org.dspace.discovery.indexobject.factory.IndexFactory; import org.dspace.discovery.indexobject.factory.IndexObjectFactoryFactory; import org.dspace.handle.factory.HandleServiceFactory; import org.dspace.scripts.DSpaceRunnable; -import org.dspace.scripts.configuration.IndexClientOptions; -import org.dspace.scripts.configuration.IndexDiscoveryScriptConfiguration; import org.dspace.services.factory.DSpaceServicesFactory; import org.dspace.utils.DSpace; diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/IndexClientOptions.java b/dspace-api/src/main/java/org/dspace/discovery/IndexClientOptions.java similarity index 96% rename from dspace-api/src/main/java/org/dspace/scripts/configuration/IndexClientOptions.java rename to dspace-api/src/main/java/org/dspace/discovery/IndexClientOptions.java index 1a0819543f..4b29fbbf27 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/configuration/IndexClientOptions.java +++ b/dspace-api/src/main/java/org/dspace/discovery/IndexClientOptions.java @@ -6,7 +6,7 @@ * http://www.dspace.org/license/ */ -package org.dspace.scripts.configuration; +package org.dspace.discovery; import org.apache.commons.cli.CommandLine; import org.apache.commons.cli.Options; @@ -35,7 +35,7 @@ public enum IndexClientOptions { * @param commandLine The relevant CommandLine for the index-discovery script * @return The index-discovery option to be ran, parsed from the CommandLine */ - public static IndexClientOptions getIndexClientOption(CommandLine commandLine) { + protected static IndexClientOptions getIndexClientOption(CommandLine commandLine) { if (commandLine.hasOption("h")) { return IndexClientOptions.HELP; } else if (commandLine.hasOption("r")) { diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/IndexDiscoveryScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java similarity index 88% rename from dspace-api/src/main/java/org/dspace/scripts/configuration/IndexDiscoveryScriptConfiguration.java rename to dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java index 8eadfd6d56..9fdb149c8b 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/configuration/IndexDiscoveryScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java @@ -5,15 +5,15 @@ * * http://www.dspace.org/license/ */ -package org.dspace.scripts.configuration; +package org.dspace.discovery; import java.sql.SQLException; import org.apache.commons.cli.Options; import org.dspace.authorize.service.AuthorizeService; import org.dspace.core.Context; -import org.dspace.discovery.IndexClient; import org.dspace.scripts.DSpaceRunnable; +import org.dspace.scripts.configuration.ScriptConfiguration; import org.springframework.beans.factory.annotation.Autowired; /** @@ -34,7 +34,7 @@ public class IndexDiscoveryScriptConfiguration extends ScriptConfiguration { try { return authorizeService.isAdmin(context); } catch (SQLException e) { - return false; + throw new RuntimeException("SQLException occured", e); } } diff --git a/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java b/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java index 4fe5c8954a..c139b49a54 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java @@ -25,7 +25,7 @@ public class ScriptServiceImpl implements ScriptService { private ServiceManager serviceManager; @Override - public ScriptConfiguration getScriptForName(String name) { + public ScriptConfiguration getScriptConfiguration(String name) { return serviceManager.getServiceByName(name, ScriptConfiguration.class); } @@ -36,7 +36,7 @@ public class ScriptServiceImpl implements ScriptService { } @Override - public DSpaceRunnable getDSpaceRunnableForScriptConfiguration(ScriptConfiguration scriptToExecute) + public DSpaceRunnable createDSpaceRunnableForScriptConfiguration(ScriptConfiguration scriptToExecute) throws IllegalAccessException, InstantiationException { return scriptToExecute.getDspaceRunnableClass().newInstance(); } diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java index b0df0006ab..a6df4062f1 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java @@ -14,6 +14,10 @@ import org.dspace.core.Context; import org.dspace.scripts.DSpaceRunnable; import org.springframework.beans.factory.BeanNameAware; +/** + * This class represents an Abstract class that a ScriptConfiguration can inherit to further implement this + * and represent a script's configuration + */ public abstract class ScriptConfiguration implements BeanNameAware { /** diff --git a/dspace-api/src/main/java/org/dspace/scripts/service/ScriptService.java b/dspace-api/src/main/java/org/dspace/scripts/service/ScriptService.java index e1506cba7c..3716123822 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/service/ScriptService.java +++ b/dspace-api/src/main/java/org/dspace/scripts/service/ScriptService.java @@ -24,7 +24,7 @@ public interface ScriptService { * @param name The name that the script has to match * @return The matching ScriptConfiguration */ - ScriptConfiguration getScriptForName(String name); + ScriptConfiguration getScriptConfiguration(String name); /** * This method will return a list of ScriptConfiguration objects for which the given Context is authorized @@ -42,6 +42,6 @@ public interface ScriptService { * @throws IllegalAccessException If something goes wrong * @throws InstantiationException If something goes wrong */ - DSpaceRunnable getDSpaceRunnableForScriptConfiguration(ScriptConfiguration scriptToExecute) + DSpaceRunnable createDSpaceRunnableForScriptConfiguration(ScriptConfiguration scriptToExecute) throws IllegalAccessException, InstantiationException; } diff --git a/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml b/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml index 374470432d..c5911a26fe 100644 --- a/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml +++ b/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml @@ -4,15 +4,15 @@ xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd"> - + - + - + diff --git a/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java b/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java index e6b84a5e1c..873b517270 100644 --- a/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java +++ b/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java @@ -33,7 +33,7 @@ public class MockDSpaceRunnableScriptConfiguration extends ScriptConfiguration { try { return authorizeService.isAdmin(context); } catch (SQLException e) { - return false; + throw new RuntimeException("SQLException occured", e); } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java index 4762c46771..b53d3d0371 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java @@ -58,7 +58,7 @@ public class ScriptRestRepository extends DSpaceRestRepository files) - throws SQLException, IOException, AuthorizeException, IllegalAccessException, InstantiationException { + throws IOException, AuthorizeException, IllegalAccessException, InstantiationException { Context context = obtainContext(); String properties = requestService.getCurrentRequest().getServletRequest().getParameter("properties"); List dSpaceCommandLineParameters = processPropertiesToDSpaceCommandLineParameters(properties); - ScriptConfiguration scriptToExecute = scriptService.getScriptForName(scriptName); + ScriptConfiguration scriptToExecute = scriptService.getScriptConfiguration(scriptName); if (scriptToExecute == null) { throw new DSpaceBadRequestException("The script for name: " + scriptName + " wasn't found"); } @@ -150,7 +150,7 @@ public class ScriptRestRepository extends DSpaceRestRepository files, Context context, ScriptConfiguration scriptToExecute, RestDSpaceRunnableHandler restDSpaceRunnableHandler, List args) throws IOException, SQLException, AuthorizeException, InstantiationException, IllegalAccessException { - DSpaceRunnable dSpaceRunnable = scriptService.getDSpaceRunnableForScriptConfiguration(scriptToExecute); + DSpaceRunnable dSpaceRunnable = scriptService.createDSpaceRunnableForScriptConfiguration(scriptToExecute); try { dSpaceRunnable.initialize(args.toArray(new String[0]), restDSpaceRunnableHandler); checkFileNames(dSpaceRunnable, files); diff --git a/dspace/config/spring/api/scripts.xml b/dspace/config/spring/api/scripts.xml index 2225828fce..88888519e4 100644 --- a/dspace/config/spring/api/scripts.xml +++ b/dspace/config/spring/api/scripts.xml @@ -4,15 +4,15 @@ xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd"> - + - + - + diff --git a/dspace/config/spring/rest/scripts.xml b/dspace/config/spring/rest/scripts.xml index 61e7597869..c39613fc54 100644 --- a/dspace/config/spring/rest/scripts.xml +++ b/dspace/config/spring/rest/scripts.xml @@ -8,7 +8,7 @@ - + \ No newline at end of file From 95f1124de55299825ce55aedd9a889aaabae63ca Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Mon, 30 Mar 2020 11:36:42 +0200 Subject: [PATCH 021/125] [Task 70080] implemented generics and DSpaceRunnableClass definition on Spring level and fixed ITs --- .../dspace/app/bulkedit/MetadataExport.java | 2 +- .../MetadataExportScriptConfiguration.java | 17 +++++++++--- .../MetadataImportCliScriptConfiguration.java | 13 +-------- .../MetadataImportScriptConfiguration.java | 17 +++++++++--- .../dspace/app/launcher/ScriptLauncher.java | 2 +- .../IndexDiscoveryScriptConfiguration.java | 17 +++++++++--- .../org/dspace/scripts/DSpaceRunnable.java | 27 ++++++++++++++++++- .../org/dspace/scripts/ScriptServiceImpl.java | 2 +- .../configuration/ScriptConfiguration.java | 24 ++--------------- .../config/spring/api/scripts.xml | 16 ++++++----- ...MockDSpaceRunnableScriptConfiguration.java | 16 ++++++++--- .../rest/repository/ScriptRestRepository.java | 8 +++--- .../app/rest/ScriptRestRepositoryIT.java | 12 ++++----- ...MockDSpaceRunnableScriptConfiguration.java | 19 ++++++++++--- dspace/config/spring/api/scripts.xml | 5 +++- dspace/config/spring/rest/scripts.xml | 3 ++- 16 files changed, 125 insertions(+), 75 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java index fc099a2220..783b2c7e93 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java @@ -81,7 +81,7 @@ public class MetadataExport extends DSpaceRunnable extends ScriptConfiguration { @Autowired private AuthorizeService authorizeService; + private Class dspaceRunnableClass; + @Override - public Class getDspaceRunnableClass() { - return MetadataExport.class; + public Class getDspaceRunnableClass() { + return dspaceRunnableClass; + } + + /** + * Generic setter for the dspaceRunnableClass + * @param dspaceRunnableClass The dspaceRunnableClass to be set on this MetadataExportScriptConfiguration + */ + public void setDspaceRunnableClass(Class dspaceRunnableClass) { + this.dspaceRunnableClass = dspaceRunnableClass; } @Override diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCliScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCliScriptConfiguration.java index 87dc7719f6..3504eddac3 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCliScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCliScriptConfiguration.java @@ -7,21 +7,10 @@ */ package org.dspace.app.bulkedit; -import org.dspace.authorize.service.AuthorizeService; -import org.dspace.scripts.DSpaceRunnable; import org.dspace.scripts.configuration.ScriptConfiguration; -import org.springframework.beans.factory.annotation.Autowired; /** * The {@link ScriptConfiguration} for the {@link org.dspace.app.bulkedit.MetadataImportCLI} CLI script */ -public class MetadataImportCliScriptConfiguration extends MetadataImportScriptConfiguration { - - @Autowired - private AuthorizeService authorizeService; - - @Override - public Class getDspaceRunnableClass() { - return MetadataImportCLI.class; - } +public class MetadataImportCliScriptConfiguration extends MetadataImportScriptConfiguration { } diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java index a67f46e558..07ad6d6d46 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java @@ -13,21 +13,30 @@ 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.DSpaceRunnable; import org.dspace.scripts.configuration.ScriptConfiguration; import org.springframework.beans.factory.annotation.Autowired; /** * The {@link ScriptConfiguration} for the {@link MetadataImport} script */ -public class MetadataImportScriptConfiguration extends ScriptConfiguration { +public class MetadataImportScriptConfiguration extends ScriptConfiguration { @Autowired private AuthorizeService authorizeService; + private Class dspaceRunnableClass; + @Override - public Class getDspaceRunnableClass() { - return MetadataImport.class; + public Class getDspaceRunnableClass() { + return dspaceRunnableClass; + } + + /** + * Generic setter for the dspaceRunnableClass + * @param dspaceRunnableClass The dspaceRunnableClass to be set on this MetadataImportScriptConfiguration + */ + public void setDspaceRunnableClass(Class dspaceRunnableClass) { + this.dspaceRunnableClass = dspaceRunnableClass; } @Override diff --git a/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java b/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java index aa9b61d876..6ee62bd904 100644 --- a/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java +++ b/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java @@ -140,7 +140,7 @@ public class ScriptLauncher { private static int executeScript(String[] args, DSpaceRunnableHandler dSpaceRunnableHandler, DSpaceRunnable script) { try { - script.initialize(args, dSpaceRunnableHandler); + script.initialize(args, dSpaceRunnableHandler, null); script.run(); return 0; } catch (ParseException e) { diff --git a/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java index 9fdb149c8b..c2a9aef72f 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java @@ -12,21 +12,22 @@ 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.DSpaceRunnable; import org.dspace.scripts.configuration.ScriptConfiguration; import org.springframework.beans.factory.annotation.Autowired; /** * The {@link ScriptConfiguration} for the {@link IndexClient} script */ -public class IndexDiscoveryScriptConfiguration extends ScriptConfiguration { +public class IndexDiscoveryScriptConfiguration extends ScriptConfiguration { @Autowired private AuthorizeService authorizeService; + private Class dspaceRunnableClass; + @Override - public Class getDspaceRunnableClass() { - return IndexClient.class; + public Class getDspaceRunnableClass() { + return dspaceRunnableClass; } @Override @@ -45,4 +46,12 @@ public class IndexDiscoveryScriptConfiguration extends ScriptConfiguration { } return options; } + + /** + * Generic setter for the dspaceRunnableClass + * @param dspaceRunnableClass The dspaceRunnableClass to be set on this IndexDiscoveryScriptConfiguration + */ + public void setDspaceRunnableClass(Class dspaceRunnableClass) { + this.dspaceRunnableClass = dspaceRunnableClass; + } } diff --git a/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java b/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java index eceb794900..7efd686c19 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java +++ b/dspace-api/src/main/java/org/dspace/scripts/DSpaceRunnable.java @@ -10,6 +10,7 @@ package org.dspace.scripts; import java.io.InputStream; import java.util.LinkedList; import java.util.List; +import java.util.UUID; import org.apache.commons.cli.CommandLine; import org.apache.commons.cli.DefaultParser; @@ -17,6 +18,7 @@ import org.apache.commons.cli.Option; import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; import org.apache.commons.lang3.StringUtils; +import org.dspace.eperson.EPerson; import org.dspace.scripts.configuration.ScriptConfiguration; import org.dspace.scripts.handler.DSpaceRunnableHandler; @@ -27,6 +29,8 @@ public abstract class DSpaceRunnable implements R */ protected CommandLine commandLine; + private UUID epersonIdentifier; + /** * The handler that deals with this script. This handler can currently either be a RestDSpaceRunnableHandler or * a CommandlineDSpaceRunnableHandler depending from where the script is called @@ -49,9 +53,14 @@ public abstract class DSpaceRunnable implements R * the arguments given to the script * @param args The arguments given to the script * @param dSpaceRunnableHandler The DSpaceRunnableHandler object that defines from where the script was ran + * @param currentUser * @throws ParseException If something goes wrong */ - public void initialize(String[] args, DSpaceRunnableHandler dSpaceRunnableHandler) throws ParseException { + public void initialize(String[] args, DSpaceRunnableHandler dSpaceRunnableHandler, + EPerson currentUser) throws ParseException { + if (currentUser != null) { + this.setEpersonIdentifier(currentUser.getID()); + } this.setHandler(dSpaceRunnableHandler); this.parse(args); } @@ -121,4 +130,20 @@ public abstract class DSpaceRunnable implements R return fileNames; } + + /** + * Generic getter for the epersonIdentifier + * @return the epersonIdentifier value of this DSpaceRunnable + */ + public UUID getEpersonIdentifier() { + return epersonIdentifier; + } + + /** + * Generic setter for the epersonIdentifier + * @param epersonIdentifier The epersonIdentifier to be set on this DSpaceRunnable + */ + public void setEpersonIdentifier(UUID epersonIdentifier) { + this.epersonIdentifier = epersonIdentifier; + } } diff --git a/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java b/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java index c139b49a54..40ba3995ec 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java @@ -38,6 +38,6 @@ public class ScriptServiceImpl implements ScriptService { @Override public DSpaceRunnable createDSpaceRunnableForScriptConfiguration(ScriptConfiguration scriptToExecute) throws IllegalAccessException, InstantiationException { - return scriptToExecute.getDspaceRunnableClass().newInstance(); + return (DSpaceRunnable) scriptToExecute.getDspaceRunnableClass().newInstance(); } } diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java index a6df4062f1..bd77e566e9 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java @@ -7,8 +7,6 @@ */ package org.dspace.scripts.configuration; -import java.util.UUID; - import org.apache.commons.cli.Options; import org.dspace.core.Context; import org.dspace.scripts.DSpaceRunnable; @@ -18,7 +16,7 @@ import org.springframework.beans.factory.BeanNameAware; * This class represents an Abstract class that a ScriptConfiguration can inherit to further implement this * and represent a script's configuration */ -public abstract class ScriptConfiguration implements BeanNameAware { +public abstract class ScriptConfiguration implements BeanNameAware { /** * The possible options for this script @@ -29,8 +27,6 @@ public abstract class ScriptConfiguration implements BeanNameAware { private String name; - private UUID epersonIdentifier; - /** * Generic getter for the description * @return the description value of this ScriptConfiguration @@ -67,7 +63,7 @@ public abstract class ScriptConfiguration implements BeanNameAware { * Generic getter for the dspaceRunnableClass * @return the dspaceRunnableClass value of this ScriptConfiguration */ - public abstract Class getDspaceRunnableClass(); + public abstract Class getDspaceRunnableClass(); /** * This method will return if the script is allowed to execute in the given context. This is by default set @@ -88,20 +84,4 @@ public abstract class ScriptConfiguration implements BeanNameAware { public void setBeanName(String beanName) { this.name = beanName; } - - /** - * Generic getter for the epersonIdentifier - * @return the epersonIdentifier value of this ScriptConfiguration - */ - public UUID getEpersonIdentifier() { - return epersonIdentifier; - } - - /** - * Generic setter for the epersonIdentifier - * @param epersonIdentifier The epersonIdentifier to be set on this ScriptConfiguration - */ - public void setEpersonIdentifier(UUID epersonIdentifier) { - this.epersonIdentifier = epersonIdentifier; - } } diff --git a/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml b/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml index c5911a26fe..af453aab52 100644 --- a/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml +++ b/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml @@ -4,19 +4,23 @@ xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd"> - + + - - - - - + + + + + + + + diff --git a/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java b/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java index 873b517270..1975621e3a 100644 --- a/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java +++ b/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java @@ -17,15 +17,25 @@ import org.dspace.scripts.configuration.ScriptConfiguration; import org.dspace.scripts.impl.MockDSpaceRunnableScript; import org.springframework.beans.factory.annotation.Autowired; -public class MockDSpaceRunnableScriptConfiguration extends ScriptConfiguration { +public class MockDSpaceRunnableScriptConfiguration extends ScriptConfiguration { @Autowired private AuthorizeService authorizeService; + private Class dspaceRunnableClass; + @Override - public Class getDspaceRunnableClass() { - return MockDSpaceRunnableScript.class; + public Class getDspaceRunnableClass() { + return dspaceRunnableClass; + } + + /** + * Generic setter for the dspaceRunnableClass + * @param dspaceRunnableClass The dspaceRunnableClass to be set on this MetadataExportScriptConfiguration + */ + public void setDspaceRunnableClass(Class dspaceRunnableClass) { + this.dspaceRunnableClass = dspaceRunnableClass; } @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java index b53d3d0371..d9c455915e 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java @@ -103,9 +103,9 @@ public class ScriptRestRepository extends DSpaceRestRepository args = constructArgs(dSpaceCommandLineParameters); @@ -152,7 +152,7 @@ public class ScriptRestRepository extends DSpaceRestRepository extends ScriptConfiguration { + @Autowired private AuthorizeService authorizeService; + private Class dspaceRunnableClass; + @Override - public Class getDspaceRunnableClass() { - return MockDSpaceRunnableScript.class; + public Class getDspaceRunnableClass() { + return dspaceRunnableClass; + } + + /** + * Generic setter for the dspaceRunnableClass + * @param dspaceRunnableClass The dspaceRunnableClass to be set on this MetadataExportScriptConfiguration + */ + public void setDspaceRunnableClass(Class dspaceRunnableClass) { + this.dspaceRunnableClass = dspaceRunnableClass; } @Override @@ -32,7 +43,7 @@ public class MockDSpaceRunnableScriptConfiguration extends ScriptConfiguration { try { return authorizeService.isAdmin(context); } catch (SQLException e) { - return false; + throw new RuntimeException("SQLException occured", e); } } diff --git a/dspace/config/spring/api/scripts.xml b/dspace/config/spring/api/scripts.xml index 88888519e4..78c4047d12 100644 --- a/dspace/config/spring/api/scripts.xml +++ b/dspace/config/spring/api/scripts.xml @@ -6,13 +6,16 @@ + - + + + diff --git a/dspace/config/spring/rest/scripts.xml b/dspace/config/spring/rest/scripts.xml index c39613fc54..04cacb4930 100644 --- a/dspace/config/spring/rest/scripts.xml +++ b/dspace/config/spring/rest/scripts.xml @@ -8,7 +8,8 @@ - + + \ No newline at end of file From 5656e3567450fd8f7bea85013e46aeb1674de382 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Mon, 30 Mar 2020 14:37:00 +0200 Subject: [PATCH 022/125] [Task 70087] added ITs for the subresource permissions --- .../app/rest/SubResourcePermissionsIT.java | 449 ++++++++++++++++++ 1 file changed, 449 insertions(+) create mode 100644 dspace-server-webapp/src/test/java/org/dspace/app/rest/SubResourcePermissionsIT.java diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubResourcePermissionsIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubResourcePermissionsIT.java new file mode 100644 index 0000000000..c2c06a6316 --- /dev/null +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubResourcePermissionsIT.java @@ -0,0 +1,449 @@ +/** + * 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.rest; + +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +import java.io.InputStream; + +import org.apache.commons.codec.CharEncoding; +import org.apache.commons.io.IOUtils; +import org.dspace.app.rest.builder.BitstreamBuilder; +import org.dspace.app.rest.builder.BundleBuilder; +import org.dspace.app.rest.builder.CollectionBuilder; +import org.dspace.app.rest.builder.CommunityBuilder; +import org.dspace.app.rest.builder.ItemBuilder; +import org.dspace.app.rest.matcher.BundleMatcher; +import org.dspace.app.rest.matcher.CommunityMatcher; +import org.dspace.app.rest.test.AbstractControllerIntegrationTest; +import org.dspace.authorize.service.AuthorizeService; +import org.dspace.content.Bitstream; +import org.dspace.content.Bundle; +import org.dspace.content.Collection; +import org.dspace.content.Community; +import org.dspace.content.Item; +import org.hamcrest.Matchers; +import org.junit.Test; +import org.springframework.beans.factory.annotation.Autowired; + +public class SubResourcePermissionsIT extends AbstractControllerIntegrationTest { + + + @Autowired + private AuthorizeService authorizeService; + + @Test + public void itemBundlePrivateItemPermissionTest() throws Exception { + + context.turnOffAuthorisationSystem(); + + //** GIVEN ** + //1. A community-collection structure with one parent community with sub-community and two collections. + parentCommunity = CommunityBuilder.createCommunity(context) + .withName("Parent Community") + .build(); + Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) + .withName("Sub Community") + .build(); + Collection col1 = CollectionBuilder.createCollection(context, child1).withName("Collection 1").build(); + Collection col2 = CollectionBuilder.createCollection(context, child1).withName("Collection 2").build(); + + //2. Three public items that are readable by Anonymous with different subjects + Item publicItem1 = ItemBuilder.createItem(context, col1) + .withTitle("Public item 1") + .withIssueDate("2017-10-17") + .withAuthor("Smith, Donald").withAuthor("Doe, John") + .withSubject("ExtraEntry") + .build(); + Bitstream bitstream; + Bundle bundle; + String bitstreamContent = "Dummy content"; + try (InputStream is = IOUtils.toInputStream(bitstreamContent, CharEncoding.UTF_8)) { + bitstream = BitstreamBuilder.createBitstream(context, publicItem1, is) + .withName("Bitstream") + .withMimeType("text/plain") + .build(); + } + + bundle = BundleBuilder.createBundle(context, publicItem1) + .withName("testname") + .withBitstream(bitstream) + .build(); + + + authorizeService.removeAllPolicies(context, publicItem1); + + String token = getAuthToken(admin.getEmail(), password); + + // Test admin retrieval of subresource bundle of private item + // should succeed + getClient(token).perform(get("/api/core/items/" + publicItem1.getID() + "/bundles")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.bundles", Matchers.hasItem(BundleMatcher + .matchProperties( + bundle.getName(), + bundle.getID(), + bundle.getHandle(), + bundle.getType())))); + + token = getAuthToken(eperson.getEmail(), password); + + // Test eperson retrieval of subresource bundle of private item + // shouldn't succeed + getClient(token).perform(get("/api/core/items/" + publicItem1.getID() + "/bundles")) + .andExpect(status().isForbidden()); + + // Test anon retrieval of subresource bundle of private item + // shouldn't succeed + getClient().perform(get("/api/core/items/" + publicItem1.getID() + "/bundles")) + .andExpect(status().isUnauthorized()); + + token = getAuthToken(admin.getEmail(), password); + + // Test item retrieval for admin on private item + // Should succeed + getClient(token).perform(get("/api/core/items/" + publicItem1.getID()) + .param("projection", "full")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.bundles._embedded.bundles", Matchers.hasItem(BundleMatcher + .matchProperties( + bundle + .getName(), + bundle + .getID(), + bundle + .getHandle(), + bundle + .getType())))); + + token = getAuthToken(eperson.getEmail(), password); + + // Test item retrieval for normal eperson on private item + // Shouldn't succeed + getClient(token).perform(get("/api/core/items/" + publicItem1.getID()) + .param("projection", "full")) + .andExpect(status().isForbidden()); + + // Test item retrieval for anon on private item + // Shouldn't succeed + getClient().perform(get("/api/core/items/" + publicItem1.getID()) + .param("projection", "full")) + .andExpect(status().isUnauthorized()); + + + // Test item retrieval for normal eperson on public bundle + // Should succeed + getClient(token).perform(get("/api/core/bundles/" + bundle.getID())) + .andExpect(status().isOk()) + .andExpect(jsonPath("$", BundleMatcher + .matchProperties(bundle.getName(), bundle.getID(), bundle.getHandle(), bundle.getType()))); + + + // Test item retrieval for anon on public bundle + // Should succeed + getClient().perform(get("/api/core/bundles/" + bundle.getID())) + .andExpect(status().isOk()) + .andExpect(jsonPath("$", BundleMatcher + .matchProperties(bundle.getName(), bundle.getID(), bundle.getHandle(), bundle.getType()))); + + } + + @Test + public void itemBundlePrivateBundlePermissionTest() throws Exception { + + context.turnOffAuthorisationSystem(); + + //** GIVEN ** + //1. A community-collection structure with one parent community with sub-community and two collections. + parentCommunity = CommunityBuilder.createCommunity(context) + .withName("Parent Community") + .build(); + Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) + .withName("Sub Community") + .build(); + Collection col1 = CollectionBuilder.createCollection(context, child1).withName("Collection 1").build(); + Collection col2 = CollectionBuilder.createCollection(context, child1).withName("Collection 2").build(); + + //2. Three public items that are readable by Anonymous with different subjects + Item publicItem1 = ItemBuilder.createItem(context, col1) + .withTitle("Public item 1") + .withIssueDate("2017-10-17") + .withAuthor("Smith, Donald").withAuthor("Doe, John") + .withSubject("ExtraEntry") + .build(); + Bitstream bitstream; + Bundle bundle; + String bitstreamContent = "Dummy content"; + try (InputStream is = IOUtils.toInputStream(bitstreamContent, CharEncoding.UTF_8)) { + bitstream = BitstreamBuilder.createBitstream(context, publicItem1, is) + .withName("Bitstream") + .withMimeType("text/plain") + .build(); + } + + bundle = BundleBuilder.createBundle(context, publicItem1) + .withName("testname") + .withBitstream(bitstream) + .build(); + + + authorizeService.removeAllPolicies(context, bundle); + + String token = getAuthToken(admin.getEmail(), password); + + // Bundle retrieval for public item, checking private bundle as admin + // Should succeed + getClient(token).perform(get("/api/core/items/" + publicItem1.getID() + "/bundles")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.bundles", Matchers.hasItem(BundleMatcher + .matchProperties( + bundle.getName(), + bundle.getID(), + bundle.getHandle(), + bundle.getType())))); + + token = getAuthToken(eperson.getEmail(), password); + + // Bundle retrieval for public item, checking private bundle as normal eperson + // Shouldn't contain the private bundle + getClient(token).perform(get("/api/core/items/" + publicItem1.getID() + "/bundles")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.bundles", Matchers.not(Matchers.hasItem( + BundleMatcher.matchProperties(bundle.getName(), bundle.getID(), bundle.getHandle(), + bundle.getType()))))); + + // Bundle retrieval for public item, checking private bundle as anon + // Shouldn't contain the private bundle + getClient().perform(get("/api/core/items/" + publicItem1.getID() + "/bundles")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.bundles", Matchers.not(Matchers.hasItem( + BundleMatcher.matchProperties(bundle.getName(), bundle.getID(), bundle.getHandle(), + bundle.getType()))))); + + token = getAuthToken(admin.getEmail(), password); + + // Admin retrieval for public item + // Should succeed + getClient(token).perform(get("/api/core/items/" + publicItem1.getID())) + .andExpect(status().isOk()); + + token = getAuthToken(eperson.getEmail(), password); + + // Normal EPerson retrieval for public item + // Should succeed + getClient(token).perform(get("/api/core/items/" + publicItem1.getID())) + .andExpect(status().isOk()); + + // Anon retrieval for public item + // Should succeed + getClient().perform(get("/api/core/items/" + publicItem1.getID())) + .andExpect(status().isOk()); + + token = getAuthToken(admin.getEmail(), password); + + // Admin full projection retrieval for public item with private bundles + // Should succeed + getClient(token).perform(get("/api/core/items/" + publicItem1.getID()) + .param("projection", "full")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.bundles._embedded.bundles", Matchers.hasItem( + BundleMatcher.matchProperties(bundle.getName(), bundle.getID(), + bundle.getHandle(), bundle.getType())))); + + token = getAuthToken(eperson.getEmail(), password); + + // Normal EPerson full projection retrieval for public item with private bundles + // Shouldn't succeed + getClient(token).perform(get("/api/core/items/" + publicItem1.getID()) + .param("projection", "full")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.bundles._embedded.bundles", Matchers.not(Matchers.hasItem( + BundleMatcher.matchProperties(bundle.getName(), bundle.getID(), + bundle.getHandle(), bundle.getType()))))); + + + // Anon full projection retrieval for public item with private bundles + // Shouldn't succeed + getClient().perform(get("/api/core/items/" + publicItem1.getID()) + .param("projection", "full")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.bundles._embedded.bundles", Matchers.not(Matchers.hasItem( + BundleMatcher.matchProperties(bundle.getName(), bundle.getID(), + bundle.getHandle(), bundle.getType()))))); + + + token = getAuthToken(admin.getEmail(), password); + + // Admin retrieval of private bundle + // Should succeed + getClient(token).perform(get("/api/core/bundles/" + bundle.getID())) + .andExpect(status().isOk()) + .andExpect(jsonPath("$", BundleMatcher + .matchProperties(bundle.getName(), bundle.getID(), bundle.getHandle(), bundle.getType()))); + + token = getAuthToken(eperson.getEmail(), password); + + // Normal EPerson retrieval of private bundle + // Shouldn't succeed + getClient(token).perform(get("/api/core/bundles/" + bundle.getID())) + .andExpect(status().isForbidden()); + + // Anon retrieval of private bundle + // Shouldn't succeed + getClient().perform(get("/api/core/bundles/" + bundle.getID())) + .andExpect(status().isUnauthorized()); + + } + + @Test + public void parentCommunityOfPrivateCollectionPermissionTest() throws Exception { + context.turnOffAuthorisationSystem(); + + //** GIVEN ** + //1. A community-collection structure with one parent community with sub-community and two collections. + parentCommunity = CommunityBuilder.createCommunity(context) + .withName("Parent Community") + .build(); + Collection col1 = CollectionBuilder.createCollection(context, parentCommunity).withName("Collection 1").build(); + + authorizeService.removeAllPolicies(context, col1); + + String adminToken = getAuthToken(admin.getEmail(), password); + + // Calling parentCommunity of a private collection as an admin + // Should succeed + getClient(adminToken).perform(get("/api/core/collections/" + col1.getID() + "/parentCommunity")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$", CommunityMatcher + .matchCommunityEntry(parentCommunity.getID(), parentCommunity.getHandle()))); + + String epersonToken = getAuthToken(eperson.getEmail(), password); + + // Calling parentCommunity of a private collection as a normal eperson + // Shouldn't succeed + getClient(epersonToken).perform(get("/api/core/collections/" + col1.getID() + "/parentCommunity")) + .andExpect(status().isForbidden()); + + // Calling parentCommunity of a private collection as an anon user + // Shouldn't succeed + getClient().perform(get("/api/core/collections/" + col1.getID() + "/parentCommunity")) + .andExpect(status().isUnauthorized()); + + // Calling public parentCommunity as an admin user + // Should succeed + getClient(adminToken).perform(get("/api/core/community/" + parentCommunity.getID())) + .andExpect(status().isOk()) + .andExpect(jsonPath("$", CommunityMatcher + .matchCommunityEntry(parentCommunity.getID(), parentCommunity.getHandle()))); + + // Calling public parentCommunity as a normal EPerson + // Should succeed + getClient(epersonToken).perform(get("/api/core/community/" + parentCommunity.getID())) + .andExpect(status().isOk()) + .andExpect(jsonPath("$", CommunityMatcher + .matchCommunityEntry(parentCommunity.getID(), parentCommunity.getHandle()))); + + // Calling public parentCommunity as an anon user + // Should succeed + getClient().perform(get("/api/core/community/" + parentCommunity.getID())) + .andExpect(status().isOk()) + .andExpect(jsonPath("$", CommunityMatcher + .matchCommunityEntry(parentCommunity.getID(), parentCommunity.getHandle()))); + + // Calling fullProjection, as an admin user, of a private Collection should contain the parentCommunity + getClient(adminToken).perform(get("/api/core/collections/" + col1.getID()) + .param("projection", "full")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.parentCommunity", CommunityMatcher + .matchCommunityEntry(parentCommunity.getID(), parentCommunity.getHandle()))); + + // Calling full projection, as a normal eperson ,of a private collection should return 403 + getClient(epersonToken).perform(get("/api/core/collections/" + col1.getID()) + .param("projection", "full")) + .andExpect(status().isForbidden()); + + // Calling full projection, as an anon user, of a collection should return 401 + getClient().perform(get("/api/core/collections/" + col1.getID()) + .param("projection", "full")) + .andExpect(status().isUnauthorized()); + } + + @Test + public void privateParentCommunityOfCollectionPermissionTest() throws Exception { + context.turnOffAuthorisationSystem(); + + //** GIVEN ** + //1. A community-collection structure with one parent community with sub-community and two collections. + parentCommunity = CommunityBuilder.createCommunity(context) + .withName("Parent Community") + .build(); + Collection col1 = CollectionBuilder.createCollection(context, parentCommunity).withName("Collection 1").build(); + + authorizeService.removeAllPolicies(context, parentCommunity); + + String adminToken = getAuthToken(admin.getEmail(), password); + + // Calling private parentCommunity of a collection as an admin + // Should succeed + getClient(adminToken).perform(get("/api/core/collections/" + col1.getID() + "/parentCommunity")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$", CommunityMatcher + .matchCommunityEntry(parentCommunity.getID(), parentCommunity.getHandle()))); + + String epersonToken = getAuthToken(eperson.getEmail(), password); + + // Calling private parentCommunity of a collection as a normal eperson + // Shouldn't succeed + getClient(epersonToken).perform(get("/api/core/collections/" + col1.getID() + "/parentCommunity")) + .andExpect(status().isNoContent()); + + // Calling private parentCommunity of a collection as an anon user + // Shouldn't succeed + getClient().perform(get("/api/core/collections/" + col1.getID() + "/parentCommunity")) + .andExpect(status().isNoContent()); + + // Calling private parentCommunity as an admin user + // Should succeed + getClient(adminToken).perform(get("/api/core/community/" + parentCommunity.getID())) + .andExpect(status().isOk()) + .andExpect(jsonPath("$", CommunityMatcher + .matchCommunityEntry(parentCommunity.getID(), parentCommunity.getHandle()))); + + // Calling private parentCommunity as a normal EPerson + // Shouldn't succeed + getClient(epersonToken).perform(get("/api/core/community/" + parentCommunity.getID())) + .andExpect(status().isForbidden()); + + // Calling private parentCommunity as an anon user + // Shouldn't succeed + getClient().perform(get("/api/core/community/" + parentCommunity.getID())) + .andExpect(status().isUnauthorized()); + + // Calling fullProjection, as an admin user, of a private Collection should contain the parentCommunity + getClient(adminToken).perform(get("/api/core/collections/" + col1.getID()) + .param("projection", "full")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.parentCommunity", CommunityMatcher + .matchCommunityEntry(parentCommunity.getID(), parentCommunity.getHandle()))); + + // Calling full projection, as a normal eperson, of a public collection shouldn't return private parentCommunity + getClient(epersonToken).perform(get("/api/core/collections/" + col1.getID()) + .param("projection", "full")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.parentCommunity").doesNotExist()); + + // Calling full projection, as an anon user, of a collection shouldn't return private parentCommunity + getClient().perform(get("/api/core/collections/" + col1.getID()) + .param("projection", "full")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.parentCommunity").doesNotExist()); + } + +} From 165e39291013ece0b4120ea549a6968b3594ced9 Mon Sep 17 00:00:00 2001 From: Ben Bosman Date: Mon, 30 Mar 2020 15:39:03 +0200 Subject: [PATCH 023/125] layout changes --- .../app/rest/SubResourcePermissionsIT.java | 35 ++++++++----------- 1 file changed, 14 insertions(+), 21 deletions(-) diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubResourcePermissionsIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubResourcePermissionsIT.java index c2c06a6316..d4399a8047 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubResourcePermissionsIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubResourcePermissionsIT.java @@ -56,7 +56,7 @@ public class SubResourcePermissionsIT extends AbstractControllerIntegrationTest Collection col2 = CollectionBuilder.createCollection(context, child1).withName("Collection 2").build(); //2. Three public items that are readable by Anonymous with different subjects - Item publicItem1 = ItemBuilder.createItem(context, col1) + Item privateItem1 = ItemBuilder.createItem(context, col1) .withTitle("Public item 1") .withIssueDate("2017-10-17") .withAuthor("Smith, Donald").withAuthor("Doe, John") @@ -66,25 +66,25 @@ public class SubResourcePermissionsIT extends AbstractControllerIntegrationTest Bundle bundle; String bitstreamContent = "Dummy content"; try (InputStream is = IOUtils.toInputStream(bitstreamContent, CharEncoding.UTF_8)) { - bitstream = BitstreamBuilder.createBitstream(context, publicItem1, is) + bitstream = BitstreamBuilder.createBitstream(context, privateItem1, is) .withName("Bitstream") .withMimeType("text/plain") .build(); } - bundle = BundleBuilder.createBundle(context, publicItem1) + bundle = BundleBuilder.createBundle(context, privateItem1) .withName("testname") .withBitstream(bitstream) .build(); - authorizeService.removeAllPolicies(context, publicItem1); + authorizeService.removeAllPolicies(context, privateItem1); String token = getAuthToken(admin.getEmail(), password); // Test admin retrieval of subresource bundle of private item // should succeed - getClient(token).perform(get("/api/core/items/" + publicItem1.getID() + "/bundles")) + getClient(token).perform(get("/api/core/items/" + privateItem1.getID() + "/bundles")) .andExpect(status().isOk()) .andExpect(jsonPath("$._embedded.bundles", Matchers.hasItem(BundleMatcher .matchProperties( @@ -97,43 +97,36 @@ public class SubResourcePermissionsIT extends AbstractControllerIntegrationTest // Test eperson retrieval of subresource bundle of private item // shouldn't succeed - getClient(token).perform(get("/api/core/items/" + publicItem1.getID() + "/bundles")) + getClient(token).perform(get("/api/core/items/" + privateItem1.getID() + "/bundles")) .andExpect(status().isForbidden()); // Test anon retrieval of subresource bundle of private item // shouldn't succeed - getClient().perform(get("/api/core/items/" + publicItem1.getID() + "/bundles")) + getClient().perform(get("/api/core/items/" + privateItem1.getID() + "/bundles")) .andExpect(status().isUnauthorized()); token = getAuthToken(admin.getEmail(), password); // Test item retrieval for admin on private item // Should succeed - getClient(token).perform(get("/api/core/items/" + publicItem1.getID()) + getClient(token).perform(get("/api/core/items/" + privateItem1.getID()) .param("projection", "full")) - .andExpect(status().isOk()) - .andExpect(jsonPath("$._embedded.bundles._embedded.bundles", Matchers.hasItem(BundleMatcher - .matchProperties( - bundle - .getName(), - bundle - .getID(), - bundle - .getHandle(), - bundle - .getType())))); + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.bundles._embedded.bundles", Matchers.hasItem(BundleMatcher + .matchProperties(bundle.getName(), bundle.getID(), + bundle.getHandle(), bundle.getType())))); token = getAuthToken(eperson.getEmail(), password); // Test item retrieval for normal eperson on private item // Shouldn't succeed - getClient(token).perform(get("/api/core/items/" + publicItem1.getID()) + getClient(token).perform(get("/api/core/items/" + privateItem1.getID()) .param("projection", "full")) .andExpect(status().isForbidden()); // Test item retrieval for anon on private item // Shouldn't succeed - getClient().perform(get("/api/core/items/" + publicItem1.getID()) + getClient().perform(get("/api/core/items/" + privateItem1.getID()) .param("projection", "full")) .andExpect(status().isUnauthorized()); From 34d8bd33bca9f1bb1a136c26de796e2d742b2db3 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Tue, 31 Mar 2020 10:13:04 +0200 Subject: [PATCH 024/125] [Task 70087] fixed checkstyle after master merge --- .../java/org/dspace/app/rest/CollectionRestRepositoryIT.java | 2 +- .../java/org/dspace/app/rest/CommunityRestRepositoryIT.java | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java index 8aa6f3bc80..e9632581a3 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java @@ -24,8 +24,8 @@ import java.util.UUID; import com.fasterxml.jackson.databind.ObjectMapper; import org.dspace.app.rest.builder.CollectionBuilder; import org.dspace.app.rest.builder.CommunityBuilder; -import org.dspace.app.rest.converter.CollectionConverter; import org.dspace.app.rest.builder.EPersonBuilder; +import org.dspace.app.rest.converter.CollectionConverter; import org.dspace.app.rest.matcher.CollectionMatcher; import org.dspace.app.rest.matcher.CommunityMatcher; import org.dspace.app.rest.matcher.HalMatcher; diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityRestRepositoryIT.java index a566bca679..5c0257a6df 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityRestRepositoryIT.java @@ -32,8 +32,8 @@ import java.util.stream.StreamSupport; import com.fasterxml.jackson.databind.ObjectMapper; import org.dspace.app.rest.builder.CollectionBuilder; import org.dspace.app.rest.builder.CommunityBuilder; -import org.dspace.app.rest.converter.CommunityConverter; import org.dspace.app.rest.builder.EPersonBuilder; +import org.dspace.app.rest.converter.CommunityConverter; import org.dspace.app.rest.matcher.CollectionMatcher; import org.dspace.app.rest.matcher.CommunityMatcher; import org.dspace.app.rest.matcher.HalMatcher; From 563d3f12410258808c34fff4ecbc45f435ac11bc Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Thu, 2 Apr 2020 16:25:24 +0200 Subject: [PATCH 025/125] [Task 70148] processed community feedback on Subresource permissions --- .../dspace/app/rest/converter/ConverterService.java | 13 +++++++++++++ ...ticationStatusRestPermissionEvaluatorPlugin.java | 4 ++++ .../AuthnRestPermissionEvaluatorPlugin.java | 4 ++++ ...itstreamFormatRestPermissionEvaluatorPlugin.java | 4 ++++ .../BrowseIndexRestPermissionEvaluatorPlugin.java | 4 ++++ ...iscoveryResultRestPermissionEvaluatorPlugin.java | 4 ++++ ...=> EntityTypeRestPermissionEvaluatorPlugin.java} | 6 +++++- ...alSourceEntryRestPermissionEvaluatorPlugin.java} | 6 +++++- ...xternalSourceRestPermissionEvaluatorPlugin.java} | 6 +++++- ...ConfigurationRestPermissionEvaluatorPlugin.java} | 6 +++++- ...stedCollectionRestPermissionEvaluatorPlugin.java | 4 ++++ ...vesterMetadataRestPermissionEvaluatorPlugin.java | 4 ++++ .../MetadataFieldRestPermissionEvaluatorPlugin.java | 4 ++++ ...MetadataSchemaRestPermissionEvaluatorPlugin.java | 4 ++++ .../RelationshipRestPermissionEvaluatorPlugin.java | 4 ++++ ...lationshipTypeRestPermissionEvaluatorPlugin.java | 4 ++++ ...hConfigurationRestPermissionEvaluatorPlugin.java | 4 ++++ .../SearchEventRestPermissionEvaluatorPlugin.java | 4 ++++ .../SearchResultsRestPermissionEvaluatorPlugin.java | 4 ++++ .../SearchSupportRestPermissionEvaluatorPlugin.java | 4 ++++ .../security/SiteRestPermissionEvaluatorPlugin.java | 4 ++++ ...tisticsSupportRestPermissionEvaluatorPlugin.java | 4 ++++ ...sionDefinitionRestPermissionEvaluatorPlugin.java | 4 ++++ ...SubmissionFormRestPermissionEvaluatorPlugin.java | 4 ++++ ...bmissionUploadRestPermissionEvaluatorPlugin.java | 4 ++++ ...bmissonSectionRestPermissionEvaluatorPlugin.java | 4 ++++ .../TemplateItemRestPermissionEvaluatorPlugin.java | 4 ++++ .../ViewEventRestPermissionEvaluatorPlugin.java | 4 ++++ ...WorkflowActionRestPermissionEvaluatorPlugin.java | 4 ++++ ...flowDefinitionRestPermissionEvaluatorPlugin.java | 4 ++++ .../WorkflowStepRestPermissionEvaluatorPlugin.java | 4 ++++ 31 files changed, 137 insertions(+), 4 deletions(-) rename dspace-server-webapp/src/main/java/org/dspace/app/rest/security/{EntityTypeRestPermissionEvaluator.java => EntityTypeRestPermissionEvaluatorPlugin.java} (75%) rename dspace-server-webapp/src/main/java/org/dspace/app/rest/security/{ExternalSourceEntryRestPermissionEvaluator.java => ExternalSourceEntryRestPermissionEvaluatorPlugin.java} (75%) rename dspace-server-webapp/src/main/java/org/dspace/app/rest/security/{ExternalSourceRestPermissionEvaluator.java => ExternalSourceRestPermissionEvaluatorPlugin.java} (75%) rename dspace-server-webapp/src/main/java/org/dspace/app/rest/security/{FacetConfigurationRestPermissionEvaluator.java => FacetConfigurationRestPermissionEvaluatorPlugin.java} (75%) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java index 22cb547a33..3f0835b344 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java @@ -132,6 +132,19 @@ public class ConverterService { return utils.getPage(transformedList, pageable); } + /** + * Converts a list of ModelObjects to a page of Rest Objects using the given {@link Projection} + * This method differences in the sense that we define a total here instead of the size of the list because + * this method will be called if the list is limited through a DB call already and thus we need to give the + * total amount of records in the DB; not the size of the given list + * @param modelObjects the list of model objects. + * @param pageable the pageable. + * @param total The total amount of objects + * @param projection the projection to use. + * @param the model object class. + * @param the rest object class. + * @return the page. + */ public Page toRestPage(List modelObjects, Pageable pageable, long total, Projection projection) { List transformedList = new LinkedList<>(); for (M modelObject : modelObjects) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthenticationStatusRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthenticationStatusRestPermissionEvaluatorPlugin.java index 64ec0dc35a..220c75d893 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthenticationStatusRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthenticationStatusRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.AuthenticationStatusRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to AuthenticationStatusRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class AuthenticationStatusRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthnRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthnRestPermissionEvaluatorPlugin.java index e4e1c4a5b9..d310e781b4 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthnRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthnRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.AuthnRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to AuthnRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class AuthnRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BitstreamFormatRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BitstreamFormatRestPermissionEvaluatorPlugin.java index f1f6d3d394..f5027a5f14 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BitstreamFormatRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BitstreamFormatRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.BitstreamFormatRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to BitstreamFormatRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class BitstreamFormatRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BrowseIndexRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BrowseIndexRestPermissionEvaluatorPlugin.java index 30ed782515..a4f57e1ea7 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BrowseIndexRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BrowseIndexRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.BrowseIndexRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to BrowseIndexRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class BrowseIndexRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/DiscoveryResultRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/DiscoveryResultRestPermissionEvaluatorPlugin.java index 01c3537d02..04207e4a93 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/DiscoveryResultRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/DiscoveryResultRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.DiscoveryResultsRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to DiscoveryResultsRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class DiscoveryResultRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EntityTypeRestPermissionEvaluator.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EntityTypeRestPermissionEvaluatorPlugin.java similarity index 75% rename from dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EntityTypeRestPermissionEvaluator.java rename to dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EntityTypeRestPermissionEvaluatorPlugin.java index cc57753033..017e0c2b56 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EntityTypeRestPermissionEvaluator.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EntityTypeRestPermissionEvaluatorPlugin.java @@ -14,8 +14,12 @@ import org.dspace.app.rest.model.EntityTypeRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to EntityTypeRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component -public class EntityTypeRestPermissionEvaluator extends RestObjectPermissionEvaluatorPlugin { +public class EntityTypeRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, DSpaceRestPermission restPermission) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceEntryRestPermissionEvaluator.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceEntryRestPermissionEvaluatorPlugin.java similarity index 75% rename from dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceEntryRestPermissionEvaluator.java rename to dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceEntryRestPermissionEvaluatorPlugin.java index 3d1a20fd8b..fc050b4d3e 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceEntryRestPermissionEvaluator.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceEntryRestPermissionEvaluatorPlugin.java @@ -14,8 +14,12 @@ import org.dspace.app.rest.model.ExternalSourceEntryRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to ExternalSourceEntryRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component -public class ExternalSourceEntryRestPermissionEvaluator extends RestObjectPermissionEvaluatorPlugin { +public class ExternalSourceEntryRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, DSpaceRestPermission restPermission) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceRestPermissionEvaluator.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceRestPermissionEvaluatorPlugin.java similarity index 75% rename from dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceRestPermissionEvaluator.java rename to dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceRestPermissionEvaluatorPlugin.java index 536c55d674..5340251f0d 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceRestPermissionEvaluator.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceRestPermissionEvaluatorPlugin.java @@ -14,8 +14,12 @@ import org.dspace.app.rest.model.ExternalSourceRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to ExternalSourceRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component -public class ExternalSourceRestPermissionEvaluator extends RestObjectPermissionEvaluatorPlugin { +public class ExternalSourceRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, DSpaceRestPermission restPermission) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/FacetConfigurationRestPermissionEvaluator.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/FacetConfigurationRestPermissionEvaluatorPlugin.java similarity index 75% rename from dspace-server-webapp/src/main/java/org/dspace/app/rest/security/FacetConfigurationRestPermissionEvaluator.java rename to dspace-server-webapp/src/main/java/org/dspace/app/rest/security/FacetConfigurationRestPermissionEvaluatorPlugin.java index 2d46a9c02c..5a9432d466 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/FacetConfigurationRestPermissionEvaluator.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/FacetConfigurationRestPermissionEvaluatorPlugin.java @@ -14,8 +14,12 @@ import org.dspace.app.rest.model.FacetConfigurationRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to FacetConfigurationRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component -public class FacetConfigurationRestPermissionEvaluator extends RestObjectPermissionEvaluatorPlugin { +public class FacetConfigurationRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, DSpaceRestPermission restPermission) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvestedCollectionRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvestedCollectionRestPermissionEvaluatorPlugin.java index 0abe88e3bb..9f78f5a043 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvestedCollectionRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvestedCollectionRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.HarvestedCollectionRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to HarvestedCollectionRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class HarvestedCollectionRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvesterMetadataRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvesterMetadataRestPermissionEvaluatorPlugin.java index 76fae4f637..ec0e3e202b 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvesterMetadataRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvesterMetadataRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.HarvesterMetadataRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to HarvesterMetadataRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class HarvesterMetadataRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataFieldRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataFieldRestPermissionEvaluatorPlugin.java index b78f2ddbd0..c53fffe5d0 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataFieldRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataFieldRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.MetadataFieldRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to MetadataFieldRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class MetadataFieldRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataSchemaRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataSchemaRestPermissionEvaluatorPlugin.java index 5b4094960f..07da54a170 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataSchemaRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataSchemaRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.MetadataSchemaRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to MetadataSchemaRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class MetadataSchemaRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipRestPermissionEvaluatorPlugin.java index 999066840b..690a8bde9f 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.RelationshipRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to RelationshipRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class RelationshipRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipTypeRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipTypeRestPermissionEvaluatorPlugin.java index c7305808b5..b371c8a516 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipTypeRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipTypeRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.RelationshipTypeRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to RelationshipTypeRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class RelationshipTypeRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchConfigurationRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchConfigurationRestPermissionEvaluatorPlugin.java index a0a7af1b85..b540b4d855 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchConfigurationRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchConfigurationRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.SearchConfigurationRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to SearchConfigurationRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class SearchConfigurationRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchEventRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchEventRestPermissionEvaluatorPlugin.java index 5456621eb7..e7124b834e 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchEventRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchEventRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.SearchEventRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to SearchEventRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class SearchEventRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchResultsRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchResultsRestPermissionEvaluatorPlugin.java index 3cd67088ba..8e1ef2ada7 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchResultsRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchResultsRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.SearchResultsRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to SearchResultsRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class SearchResultsRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchSupportRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchSupportRestPermissionEvaluatorPlugin.java index d01b1e2111..6ad65351c6 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchSupportRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchSupportRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.SearchSupportRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to SearchSupportRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class SearchSupportRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SiteRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SiteRestPermissionEvaluatorPlugin.java index b5182a2172..6385b2c751 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SiteRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SiteRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.SiteRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to SiteRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class SiteRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/StatisticsSupportRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/StatisticsSupportRestPermissionEvaluatorPlugin.java index 13d0632da6..190afafe14 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/StatisticsSupportRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/StatisticsSupportRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.StatisticsSupportRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to StatisticsSupportRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class StatisticsSupportRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionDefinitionRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionDefinitionRestPermissionEvaluatorPlugin.java index 8bbf1d3803..7efb24a6ee 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionDefinitionRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionDefinitionRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.SubmissionDefinitionRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to SubmissionDefinitionRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class SubmissionDefinitionRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionFormRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionFormRestPermissionEvaluatorPlugin.java index 4c582d4a3b..19db77ca57 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionFormRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionFormRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.SubmissionFormRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to SubmissionFormRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class SubmissionFormRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionUploadRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionUploadRestPermissionEvaluatorPlugin.java index 1f51050d76..aa15522a1c 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionUploadRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionUploadRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.SubmissionUploadRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to SubmissionUploadRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class SubmissionUploadRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissonSectionRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissonSectionRestPermissionEvaluatorPlugin.java index d6fad0e42d..7c998d48d0 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissonSectionRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissonSectionRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.SubmissionSectionRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to SubmissionSectionRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class SubmissonSectionRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/TemplateItemRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/TemplateItemRestPermissionEvaluatorPlugin.java index 1cdd5a291c..192bdf040b 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/TemplateItemRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/TemplateItemRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.TemplateItemRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to TemplateItemRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class TemplateItemRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ViewEventRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ViewEventRestPermissionEvaluatorPlugin.java index c8e2a0585a..097bfc1e3a 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ViewEventRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ViewEventRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.ViewEventRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to ViewEventRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class ViewEventRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowActionRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowActionRestPermissionEvaluatorPlugin.java index 9b1ded9f9c..4f4180e960 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowActionRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowActionRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.WorkflowActionRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to WorkflowActionRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class WorkflowActionRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowDefinitionRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowDefinitionRestPermissionEvaluatorPlugin.java index 6308ecf1f1..6168b3b370 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowDefinitionRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowDefinitionRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.WorkflowDefinitionRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to WorkflowDefinitionRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class WorkflowDefinitionRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowStepRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowStepRestPermissionEvaluatorPlugin.java index 7292f1d967..8c8216c412 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowStepRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowStepRestPermissionEvaluatorPlugin.java @@ -14,6 +14,10 @@ import org.dspace.app.rest.model.WorkflowStepRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle calls made to WorkflowStepRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ @Component public class WorkflowStepRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override From 4031e41a5dca40bd64d15052decd4906deea22c6 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Mon, 6 Apr 2020 10:41:51 +0200 Subject: [PATCH 026/125] [Task 70080] applied feedback to the scripts and processes functionality --- .../bulkedit/MetadataExportScriptConfiguration.java | 1 + .../bulkedit/MetadataImportScriptConfiguration.java | 1 + .../discovery/IndexDiscoveryScriptConfiguration.java | 1 + .../java/org/dspace/scripts/ScriptServiceImpl.java | 11 ++++++++++- .../scripts/configuration/ScriptConfiguration.java | 5 +++++ .../data/dspaceFolder/config/spring/api/scripts.xml | 2 +- .../MockDSpaceRunnableScriptConfiguration.java | 3 ++- .../MockDSpaceRunnableScriptConfiguration.java | 1 + dspace/config/spring/api/scripts.xml | 2 +- 9 files changed, 23 insertions(+), 4 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportScriptConfiguration.java index 0f28cf5c08..10cb1ec0bc 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportScriptConfiguration.java @@ -35,6 +35,7 @@ public class MetadataExportScriptConfiguration extends * Generic setter for the dspaceRunnableClass * @param dspaceRunnableClass The dspaceRunnableClass to be set on this MetadataExportScriptConfiguration */ + @Override public void setDspaceRunnableClass(Class dspaceRunnableClass) { this.dspaceRunnableClass = dspaceRunnableClass; } diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java index 07ad6d6d46..510296742f 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java @@ -35,6 +35,7 @@ public class MetadataImportScriptConfiguration extends * Generic setter for the dspaceRunnableClass * @param dspaceRunnableClass The dspaceRunnableClass to be set on this MetadataImportScriptConfiguration */ + @Override public void setDspaceRunnableClass(Class dspaceRunnableClass) { this.dspaceRunnableClass = dspaceRunnableClass; } diff --git a/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java index c2a9aef72f..8316d144ad 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java @@ -51,6 +51,7 @@ public class IndexDiscoveryScriptConfiguration extends Sc * Generic setter for the dspaceRunnableClass * @param dspaceRunnableClass The dspaceRunnableClass to be set on this IndexDiscoveryScriptConfiguration */ + @Override public void setDspaceRunnableClass(Class dspaceRunnableClass) { this.dspaceRunnableClass = dspaceRunnableClass; } diff --git a/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java b/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java index 40ba3995ec..4eb7cdbbc1 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/scripts/ScriptServiceImpl.java @@ -7,6 +7,7 @@ */ package org.dspace.scripts; +import java.lang.reflect.InvocationTargetException; import java.util.List; import java.util.stream.Collectors; @@ -14,12 +15,15 @@ import org.dspace.core.Context; import org.dspace.kernel.ServiceManager; import org.dspace.scripts.configuration.ScriptConfiguration; import org.dspace.scripts.service.ScriptService; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; /** * The implementation for the {@link ScriptService} */ public class ScriptServiceImpl implements ScriptService { + private static final Logger log = LoggerFactory.getLogger(ScriptServiceImpl.class); @Autowired private ServiceManager serviceManager; @@ -38,6 +42,11 @@ public class ScriptServiceImpl implements ScriptService { @Override public DSpaceRunnable createDSpaceRunnableForScriptConfiguration(ScriptConfiguration scriptToExecute) throws IllegalAccessException, InstantiationException { - return (DSpaceRunnable) scriptToExecute.getDspaceRunnableClass().newInstance(); + try { + return (DSpaceRunnable) scriptToExecute.getDspaceRunnableClass().getDeclaredConstructor().newInstance(); + } catch (InvocationTargetException | NoSuchMethodException e) { + log.error(e.getMessage(), e); + throw new RuntimeException(e); + } } } diff --git a/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java index bd77e566e9..4b15c22f44 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/scripts/configuration/ScriptConfiguration.java @@ -65,6 +65,11 @@ public abstract class ScriptConfiguration implements B */ public abstract Class getDspaceRunnableClass(); + /** + * Generic setter for the dspaceRunnableClass + * @param dspaceRunnableClass The dspaceRunnableClass to be set on this IndexDiscoveryScriptConfiguration + */ + public abstract void setDspaceRunnableClass(Class dspaceRunnableClass); /** * This method will return if the script is allowed to execute in the given context. This is by default set * to the currentUser in the context being an admin, however this can be overwritten by each script individually diff --git a/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml b/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml index af453aab52..30fb69a3c4 100644 --- a/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml +++ b/dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml @@ -6,7 +6,7 @@ - + diff --git a/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java b/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java index 1975621e3a..18258dc4ac 100644 --- a/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java +++ b/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java @@ -34,6 +34,7 @@ public class MockDSpaceRunnableScriptConfiguration dspaceRunnableClass) { this.dspaceRunnableClass = dspaceRunnableClass; } @@ -43,7 +44,7 @@ public class MockDSpaceRunnableScriptConfiguration dspaceRunnableClass) { this.dspaceRunnableClass = dspaceRunnableClass; } diff --git a/dspace/config/spring/api/scripts.xml b/dspace/config/spring/api/scripts.xml index 78c4047d12..0713baad19 100644 --- a/dspace/config/spring/api/scripts.xml +++ b/dspace/config/spring/api/scripts.xml @@ -6,7 +6,7 @@ - + From 6e0396e6ad33cedbe81adddf0e146887abaea4d9 Mon Sep 17 00:00:00 2001 From: Yana De Pauw Date: Wed, 8 Apr 2020 15:14:18 +0200 Subject: [PATCH 027/125] 70213: Initial findAll endpoint & backend --- .../java/org/dspace/license/CCLicense.java | 26 ++- .../license/CCLicenseConnectorService.java | 26 +++ .../CCLicenseConnectorServiceImpl.java | 216 ++++++++++++++++++ .../org/dspace/license/CCLicenseField.java | 25 +- .../dspace/license/CCLicenseFieldEnum.java | 82 +++++++ .../java/org/dspace/license/CCLookup.java | 50 ++-- .../license/CreativeCommonsServiceImpl.java | 68 ++++-- .../service/CreativeCommonsService.java | 17 ++ .../MockCCLicenseConnectorServiceImpl.java | 72 ++++++ .../SubmissionCCLicenseConverter.java | 59 +++++ .../SubmissionCCLicenseFieldConverter.java | 61 +++++ ...SubmissionCCLicenseFieldEnumConverter.java | 45 ++++ .../SubmissionCCLicenseFieldEnumRest.java | 44 ++++ .../model/SubmissionCCLicenseFieldRest.java | 59 +++++ .../rest/model/SubmissionCCLicenseRest.java | 73 ++++++ .../hateoas/SubmissionCCLicenseResource.java | 23 ++ .../SubmissionCCLicenseRestRepository.java | 44 ++++ .../config/spring/api/core-services-mock.xml | 1 + .../SubmissionCCLicenseRestRepositoryIT.java | 46 ++++ .../matcher/SubmissionCCLicenseMatcher.java | 82 +++++++ .../MockCCLicenseConnectorServiceImpl.java | 72 ++++++ dspace/config/spring/api/core-services.xml | 1 + 22 files changed, 1121 insertions(+), 71 deletions(-) create mode 100644 dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorService.java create mode 100644 dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java create mode 100644 dspace-api/src/main/java/org/dspace/license/CCLicenseFieldEnum.java create mode 100644 dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseConverter.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseFieldConverter.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseFieldEnumConverter.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseFieldEnumRest.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseFieldRest.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseRest.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/SubmissionCCLicenseResource.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java create mode 100644 dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseRestRepositoryIT.java create mode 100644 dspace-server-webapp/src/test/java/org/dspace/app/rest/matcher/SubmissionCCLicenseMatcher.java create mode 100644 dspace-server-webapp/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java diff --git a/dspace-api/src/main/java/org/dspace/license/CCLicense.java b/dspace-api/src/main/java/org/dspace/license/CCLicense.java index b015e3a9d3..d5d9fe14a2 100644 --- a/dspace-api/src/main/java/org/dspace/license/CCLicense.java +++ b/dspace-api/src/main/java/org/dspace/license/CCLicense.java @@ -8,6 +8,8 @@ package org.dspace.license; +import java.util.List; + /** * @author wbossons */ @@ -15,17 +17,17 @@ public class CCLicense { private String licenseName; private String licenseId; - private int order = 0; + private List ccLicenseFieldList; public CCLicense() { super(); } - public CCLicense(String licenseId, String licenseName, int order) { + public CCLicense(String licenseId, String licenseName, List ccLicenseFieldList) { super(); this.licenseId = licenseId; this.licenseName = licenseName; - this.order = order; + this.ccLicenseFieldList = ccLicenseFieldList; } public String getLicenseName() { @@ -44,13 +46,19 @@ public class CCLicense { this.licenseId = licenseId; } - public int getOrder() { - return this.order; + /** + * Gets the list of CC License Fields + * @return the list of CC License Fields + */ + public List getCcLicenseFieldList() { + return ccLicenseFieldList; } - public void setOrder(int order) { - this.order = order; + /** + * Sets the list of CC License Fields + * @param ccLicenseFieldList + */ + public void setCcLicenseFieldList(final List ccLicenseFieldList) { + this.ccLicenseFieldList = ccLicenseFieldList; } - - } diff --git a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorService.java b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorService.java new file mode 100644 index 0000000000..52bbf39cc7 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorService.java @@ -0,0 +1,26 @@ +/** + * 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.util.List; + +/** + * Service interface class for the Creative commons license connector service. + * The implementation of this class is responsible for all the calls to the CC license API and parsing the response + * The service is autowired by spring + */ +public interface CCLicenseConnectorService { + + /** + * Retrieves the CC Licenses for the provided language from the CC License API + * @param language - the language to retrieve the licenses for + * @return a list of licenses obtained for the provided languages + */ + public List retrieveLicenses(String language); + +} diff --git a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java new file mode 100644 index 0000000000..edc9934694 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java @@ -0,0 +1,216 @@ +/** + * 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.StringReader; +import java.util.Collections; +import java.util.LinkedList; +import java.util.List; + +import org.apache.commons.lang3.ArrayUtils; +import org.apache.commons.lang3.StringUtils; +import org.apache.http.client.methods.CloseableHttpResponse; +import org.apache.http.client.methods.HttpGet; +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.jaxen.JaxenException; +import org.jaxen.jdom.JDOMXPath; +import org.jdom.Attribute; +import org.jdom.Element; +import org.jdom.JDOMException; +import org.jdom.input.SAXBuilder; +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; + private SAXBuilder parser = new SAXBuilder(); + + + @Autowired + private ConfigurationService configurationService; + + @Override + public void afterPropertiesSet() throws Exception { + HttpClientBuilder builder = HttpClientBuilder.create(); + + client = builder + .disableAutomaticRetries() + .setMaxConnTotal(5) + .build(); + } + + /** + * Retrieves the CC Licenses for the provided language from the CC License API + * @param language - the language to retrieve the licenses for + * @return a list of licenses obtained for the provided languages + */ + public List retrieveLicenses(String language) { + String ccLicenseUrl = configurationService.getProperty("cc.api.rooturl"); + + HttpGet httpGet = new HttpGet(ccLicenseUrl + "/?locale=" + language); + + List licenses; + try (CloseableHttpResponse response = client.execute(httpGet)) { + licenses = retrieveLicenses(response); + } catch (JDOMException | JaxenException | IOException e) { + log.error(e); + licenses = Collections.emptyList(); + } + + List ccLicenses = new LinkedList<>(); + + for (String license : licenses) { + + HttpGet licenseHttpGet = new HttpGet(ccLicenseUrl + "/license/" + license); + try (CloseableHttpResponse response = client.execute(licenseHttpGet)) { + CCLicense ccLicense = retrieveLicenseObject(response); + ccLicenses.add(ccLicense); + } catch (JaxenException | JDOMException | IOException e) { + log.error(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 JaxenException + * @throws JDOMException + */ + private List retrieveLicenses(CloseableHttpResponse response) + throws IOException, JaxenException, JDOMException { + + List domains = new LinkedList<>(); + String[] excludedLicenses = configurationService.getArrayProperty("cc.license.classfilter"); + + + String responseString = EntityUtils.toString(response.getEntity()); + JDOMXPath licenseClassXpath = new JDOMXPath("//licenses/license"); + + + InputSource is = new InputSource(new StringReader(responseString)); + org.jdom.Document classDoc = this.parser.build(is); + + List elements = licenseClassXpath.selectNodes(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 response for a specific CC License response + * @return the corresponding CC License Object + * @throws IOException + * @throws JaxenException + * @throws JDOMException + */ + private CCLicense retrieveLicenseObject(CloseableHttpResponse response) + throws IOException, JaxenException, JDOMException { + + String responseString = EntityUtils.toString(response.getEntity()); + + + JDOMXPath licenseClassXpath = new JDOMXPath("//licenseclass"); + JDOMXPath licenseFieldXpath = new JDOMXPath("field"); + + + InputSource is; + + is = new InputSource(new StringReader(responseString)); + + org.jdom.Document classDoc = this.parser.build(is); + + Object element = licenseClassXpath.selectSingleNode(classDoc); + String licenseId = getSingleNodeValue(element, "@id"); + String licenseLabel = getSingleNodeValue(element, "label"); + + List ccLicenseFields = new LinkedList<>(); + + List licenseFields = licenseFieldXpath.selectNodes(element); + for (Element licenseField : licenseFields) { + CCLicenseField ccLicenseField = parseLicenseField(licenseField); + ccLicenseFields.add(ccLicenseField); + } + + + return new CCLicense(licenseId, licenseLabel, ccLicenseFields); + } + + private CCLicenseField parseLicenseField(final Element licenseField) throws JaxenException { + String id = getSingleNodeValue(licenseField, "@id"); + String label = getSingleNodeValue(licenseField, "label"); + String description = getSingleNodeValue(licenseField, "description"); + + JDOMXPath enumXpath = new JDOMXPath("enum"); + List enums = enumXpath.selectNodes(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) throws JaxenException { + 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) throws JaxenException { + JDOMXPath xpath = new JDOMXPath(query); + Object singleNode = xpath.selectSingleNode(t); + + return getNodeValue(singleNode); + } + +} diff --git a/dspace-api/src/main/java/org/dspace/license/CCLicenseField.java b/dspace-api/src/main/java/org/dspace/license/CCLicenseField.java index 6360249f65..8fb6de5478 100644 --- a/dspace-api/src/main/java/org/dspace/license/CCLicenseField.java +++ b/dspace-api/src/main/java/org/dspace/license/CCLicenseField.java @@ -7,8 +7,7 @@ */ package org.dspace.license; -import java.util.HashMap; -import java.util.Map; +import java.util.List; /** * Wrapper class for representation of a license field declaration. @@ -22,7 +21,7 @@ public class CCLicenseField { private String description = ""; private String type = ""; - private HashMap fieldEnum = null; + private List fieldEnum = null; /** * Construct a new LicenseField class. Note that after construction, @@ -31,13 +30,11 @@ public class CCLicenseField { * @param id The unique identifier for this field; this value will be used in constructing the answers XML. * @param label The label to use when generating the user interface. */ - public CCLicenseField(String id, String label) { - super(); - - this.fieldEnum = new HashMap(); - + public CCLicenseField(String id, String label, String description, List fieldEnum) { this.id = id; this.label = label; + this.description = description; + this.fieldEnum = fieldEnum; } /** @@ -90,16 +87,12 @@ public class CCLicenseField { } /** - * @return Returns an instance implementing the Map interface; - * the instance contains a mapping from identifiers to - * labels for the enumeration values. - * @see Map + * Returns the list of enums of this field + * @return the list of enums of this field */ - public Map getEnum() { - return this.fieldEnum; + public List getFieldEnum() { + return fieldEnum; } - - } diff --git a/dspace-api/src/main/java/org/dspace/license/CCLicenseFieldEnum.java b/dspace-api/src/main/java/org/dspace/license/CCLicenseFieldEnum.java new file mode 100644 index 0000000000..628fcb8354 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/license/CCLicenseFieldEnum.java @@ -0,0 +1,82 @@ +/** + * 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 org.apache.commons.lang3.StringUtils; + +/** + * Wrapper class for representation of a license field enum declaration. + * A field enum is a single "answer" to the field question + */ +public class CCLicenseFieldEnum { + + private String id = ""; + private String label = ""; + private String description = ""; + + public CCLicenseFieldEnum(String id, String label, String description) { + if (StringUtils.isNotBlank(id)) { + this.id = id; + } + if (StringUtils.isNotBlank(label)) { + this.label = label; + } + if (StringUtils.isNotBlank(description)) { + this.description = description; + } + + } + + /** + * Get the id of this enum + * @return the id of this enum + */ + public String getId() { + return id; + } + + /** + * Set the id of this enum + * @param id + */ + public void setId(final String id) { + this.id = id; + } + + /** + * Get the label of this enum + * @return the label of this enum + */ + public String getLabel() { + return label; + } + + /** + * Set the label of this enum + * @param label + */ + public void setLabel(final String label) { + this.label = label; + } + + /** + * Get the description of this enum + * @return the description of this enum + */ + public String getDescription() { + return description; + } + + /** + * Set the description of this enum + * @param description + */ + public void setDescription(final String description) { + this.description = description; + } +} diff --git a/dspace-api/src/main/java/org/dspace/license/CCLookup.java b/dspace-api/src/main/java/org/dspace/license/CCLookup.java index c86aa78301..b7ddfa2314 100644 --- a/dspace-api/src/main/java/org/dspace/license/CCLookup.java +++ b/dspace-api/src/main/java/org/dspace/license/CCLookup.java @@ -128,7 +128,7 @@ public class CCLookup { // add if not filtered String liD = ((Attribute) xp_LicenseID.selectSingleNode(license)).getValue(); if (!lcFilter.contains(liD)) { - this.licenses.add(new CCLicense(liD, license.getText(), i)); +// this.licenses.add(new CCLicense(liD, license.getText(), i)); } } } catch (JaxenException jaxen_e) { @@ -213,30 +213,30 @@ public class CCLookup { for (int i = 0; i < results.size(); i++) { Element field = (Element) results.get(i); - try { - // create the field object - CCLicenseField cclicensefield = new CCLicenseField( - ((Attribute) xp_LicenseID.selectSingleNode(field)).getValue(), - ((Element) xp_Label.selectSingleNode(field)).getText()); - - // extract additional properties - cclicensefield.setDescription(((Element) xp_Description.selectSingleNode(field)).getText()); - cclicensefield.setType(((Element) xp_FieldType.selectSingleNode(field)).getText()); - - enumOptions = xp_Enum.selectNodes(field); - - for (int j = 0; j < enumOptions.size(); j++) { - String id = ((Attribute) xp_LicenseID.selectSingleNode(enumOptions.get(j))).getValue(); - String label = ((Element) xp_Label.selectSingleNode(enumOptions.get(j))).getText(); - - cclicensefield.getEnum().put(id, label); - - } // for each enum option - - this.licenseFields.add(cclicensefield); - } catch (JaxenException e) { - return null; - } +// try { +// // create the field object +// CCLicenseField cclicensefield = new CCLicenseField( +// ((Attribute) xp_LicenseID.selectSingleNode(field)).getValue(), +// ((Element) xp_Label.selectSingleNode(field)).getText()); +// +// // extract additional properties +// cclicensefield.setDescription(((Element) xp_Description.selectSingleNode(field)).getText()); +// cclicensefield.setType(((Element) xp_FieldType.selectSingleNode(field)).getText()); +// +// enumOptions = xp_Enum.selectNodes(field); +// +// for (int j = 0; j < enumOptions.size(); j++) { +// String id = ((Attribute) xp_LicenseID.selectSingleNode(enumOptions.get(j))).getValue(); +// String label = ((Element) xp_Label.selectSingleNode(enumOptions.get(j))).getText(); +// +//// cclicensefield.getEnum().put(id, label); +// +// } // for each enum option +// +// this.licenseFields.add(cclicensefield); +// } catch (JaxenException e) { +// return null; +// } } return licenseFields; diff --git a/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java b/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java index 384b82ddc3..fed51a9f0a 100644 --- a/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java @@ -82,9 +82,13 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi protected BundleService bundleService; @Autowired(required = true) protected ItemService itemService; + @Autowired + protected CCLicenseConnectorService ccLicenseConnectorService; protected ConfigurationService configurationService = DSpaceServicesFactory.getInstance().getConfigurationService(); + private List ccLicenses; + protected CreativeCommonsServiceImpl() { } @@ -103,8 +107,8 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi try { templates = TransformerFactory.newInstance().newTemplates( - new StreamSource(CreativeCommonsServiceImpl.class - .getResourceAsStream("CreativeCommons.xsl"))); + new StreamSource(CreativeCommonsServiceImpl.class + .getResourceAsStream("CreativeCommons.xsl"))); } catch (TransformerConfigurationException e) { throw new RuntimeException(e.getMessage(), e); } @@ -120,7 +124,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi // create the CC bundle if it doesn't exist // If it does, remove it and create a new one. protected Bundle getCcBundle(Context context, Item item) - throws SQLException, AuthorizeException, IOException { + throws SQLException, AuthorizeException, IOException { List bundles = itemService.getBundles(item, CC_BUNDLE_NAME); if ((bundles.size() > 0) && (bundles.get(0) != null)) { @@ -131,8 +135,8 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi @Override public void setLicenseRDF(Context context, Item item, String licenseRdf) - throws SQLException, IOException, - AuthorizeException { + throws SQLException, IOException, + AuthorizeException { Bundle bundle = getCcBundle(context, item); // set the format BitstreamFormat bs_rdf_format = bitstreamFormatService.findByShortDescription(context, "RDF XML"); @@ -144,7 +148,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi @Override public void setLicense(Context context, Item item, InputStream licenseStm, String mimeType) - throws SQLException, IOException, AuthorizeException { + throws SQLException, IOException, AuthorizeException { Bundle bundle = getCcBundle(context, item); // set the format @@ -160,9 +164,9 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi Bitstream bs = bitstreamService.create(context, bundle, licenseStm); bs.setSource(context, CC_BS_SOURCE); bs.setName(context, (mimeType != null && - (mimeType.equalsIgnoreCase("text/xml") || - mimeType.equalsIgnoreCase("text/rdf"))) ? - BSN_LICENSE_RDF : BSN_LICENSE_TEXT); + (mimeType.equalsIgnoreCase("text/xml") || + mimeType.equalsIgnoreCase("text/rdf"))) ? + BSN_LICENSE_RDF : BSN_LICENSE_TEXT); bs.setFormat(context, bs_format); bitstreamService.update(context, bs); } @@ -170,7 +174,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi @Override public void removeLicense(Context context, Item item) - throws SQLException, IOException, AuthorizeException { + throws SQLException, IOException, AuthorizeException { // remove CC license bundle if one exists List bundles = itemService.getBundles(item, CC_BUNDLE_NAME); @@ -181,7 +185,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi @Override public boolean hasLicense(Context context, Item item) - throws SQLException, IOException { + throws SQLException, IOException { // try to find CC license bundle List bundles = itemService.getBundles(item, CC_BUNDLE_NAME); @@ -203,20 +207,20 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi @Override public String getLicenseRDF(Context context, Item item) throws SQLException, - IOException, AuthorizeException { + IOException, AuthorizeException { return getStringFromBitstream(context, item, BSN_LICENSE_RDF); } @Override public Bitstream getLicenseRdfBitstream(Item item) throws SQLException, - IOException, AuthorizeException { + IOException, AuthorizeException { return getBitstream(item, BSN_LICENSE_RDF); } @Deprecated @Override public Bitstream getLicenseTextBitstream(Item item) throws SQLException, - IOException, AuthorizeException { + IOException, AuthorizeException { return getBitstream(item, BSN_LICENSE_TEXT); } @@ -237,8 +241,8 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi try { templates.newTransformer().transform( - new JDOMSource(license), - new StreamResult(result) + new JDOMSource(license), + new StreamResult(result) ); } catch (TransformerException e) { throw new IllegalStateException(e.getMessage(), e); @@ -267,7 +271,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi */ protected void setBitstreamFromBytes(Context context, Item item, Bundle bundle, String bitstream_name, BitstreamFormat format, byte[] bytes) - throws SQLException, IOException, AuthorizeException { + throws SQLException, IOException, AuthorizeException { ByteArrayInputStream bais = new ByteArrayInputStream(bytes); Bitstream bs = bitstreamService.create(context, bundle, bais); @@ -297,7 +301,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi */ protected String getStringFromBitstream(Context context, Item item, String bitstream_name) throws SQLException, IOException, - AuthorizeException { + AuthorizeException { byte[] bytes = getBytesFromBitstream(context, item, bitstream_name); if (bytes == null) { @@ -320,7 +324,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi * to perform a particular action. */ protected Bitstream getBitstream(Item item, String bitstream_name) - throws SQLException, IOException, AuthorizeException { + throws SQLException, IOException, AuthorizeException { Bundle cc_bundle = null; // look for the CC bundle @@ -342,7 +346,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi } protected byte[] getBytesFromBitstream(Context context, Item item, String bitstream_name) - throws SQLException, IOException, AuthorizeException { + throws SQLException, IOException, AuthorizeException { Bitstream bs = getBitstream(item, bitstream_name); // no such bitstream @@ -368,7 +372,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi @Override public void removeLicense(Context context, LicenseMetadataValue uriField, LicenseMetadataValue nameField, Item item) - throws AuthorizeException, IOException, SQLException { + throws AuthorizeException, IOException, SQLException { // only remove any previous licenses String licenseUri = uriField.ccItemValue(item); if (licenseUri != null) { @@ -383,4 +387,26 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi } } + /** + * Find all CC Licenses using the default language found in the configuration + * @return A list of available CC Licenses + */ + public List findAllCCLicenses() { + String language = configurationService.getProperty("cc.license.locale", "en"); + return findAllCCLicenses(language); + } + + /** + * Find all CC Licenses for the provided language + * @param language - the language for which to find the CC Licenses + * @return A list of available CC Licenses for the provided language + */ + public List findAllCCLicenses(String language) { + + if (ccLicenses == null || ccLicenses.isEmpty()) { + ccLicenses = ccLicenseConnectorService.retrieveLicenses(language); + } + return ccLicenses; + } + } diff --git a/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java b/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java index c99c38a127..d25f02ff7b 100644 --- a/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java +++ b/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java @@ -10,11 +10,13 @@ package org.dspace.license.service; import java.io.IOException; import java.io.InputStream; import java.sql.SQLException; +import java.util.List; import org.dspace.authorize.AuthorizeException; import org.dspace.content.Bitstream; import org.dspace.content.Item; import org.dspace.core.Context; +import org.dspace.license.CCLicense; import org.dspace.license.LicenseMetadataValue; import org.jdom.Document; @@ -149,4 +151,19 @@ public interface CreativeCommonsService { public void removeLicense(Context context, LicenseMetadataValue uriField, LicenseMetadataValue nameField, Item item) throws AuthorizeException, IOException, SQLException; + + /** + * Find all CC Licenses using the default language found in the configuration + * + * @return A list of available CC Licenses + */ + public List findAllCCLicenses(); + + /** + * Find all CC Licenses for the provided language + * + * @param language - the language for which to find the CC Licenses + * @return A list of available CC Licenses for the provided language + */ + public List findAllCCLicenses(String language); } diff --git a/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java b/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java new file mode 100644 index 0000000000..54219bbaaa --- /dev/null +++ b/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.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.license; + +import java.util.LinkedList; +import java.util.List; + +/** + * Mock implementation for the Creative commons license connector service. + * This class will return a structure of CC Licenses similar to the CC License API but without having to contact it + */ +public class MockCCLicenseConnectorServiceImpl extends CCLicenseConnectorServiceImpl { + + /** + * Retrieves mock CC Licenses for the provided language + * @param language - the language + * @return a list of mocked licenses + */ + public List retrieveLicenses(String language) { + List ccLicenses = new LinkedList<>(); + ccLicenses.add(createMockLicense(1, new int[]{3, 2, 3})); + ccLicenses.add(createMockLicense(2, new int[]{2})); + ccLicenses.add(createMockLicense(3, new int[]{})); + + return ccLicenses; + } + + private CCLicense createMockLicense(int count, int[] amountOfFieldsAndEnums) { + String licenseId = "license" + count; + String licenseName = "License " + count + " - Name"; + List mockLicenseFields = createMockLicenseFields(count, amountOfFieldsAndEnums); + return new CCLicense(licenseId, licenseName, mockLicenseFields); + } + + private List createMockLicenseFields(int count, int[] amountOfFieldsAndEnums) { + List ccLicenseFields = new LinkedList<>(); + for (int index = 0; index < amountOfFieldsAndEnums.length; index++) { + String licenseFieldId = "license" + count + "-field" + index; + String licenseFieldLabel = "License " + count + " - Field " + index + " - Label"; + String licenseFieldDescription = "License " + count + " - Field " + index + " - Description"; + List mockLicenseFields = createMockLicenseFields(count, + index, + amountOfFieldsAndEnums[index]); + ccLicenseFields.add(new CCLicenseField(licenseFieldId, + licenseFieldLabel, + licenseFieldDescription, + mockLicenseFields)); + + } + + return ccLicenseFields; + } + + private List createMockLicenseFields(int count, int index, int amountOfEnums) { + List ccLicenseFieldEnumList = new LinkedList<>(); + for (int i = 0; i < amountOfEnums; i++) { + String enumId = "license" + count + "-field" + index + "-enum" + i; + String enumLabel = "License " + count + " - Field " + index + " - Enum " + i + " - Label"; + String enumDescription = "License " + count + " - Field " + index + " - Enum " + i + " - " + + "Description"; + ccLicenseFieldEnumList.add(new CCLicenseFieldEnum(enumId, enumLabel, enumDescription)); + } + return ccLicenseFieldEnumList; + + } + +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseConverter.java new file mode 100644 index 0000000000..bd7e582e75 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseConverter.java @@ -0,0 +1,59 @@ +/** + * 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.rest.converter; + +import java.util.LinkedList; +import java.util.List; + +import org.dspace.app.rest.model.SubmissionCCLicenseFieldRest; +import org.dspace.app.rest.model.SubmissionCCLicenseRest; +import org.dspace.app.rest.projection.Projection; +import org.dspace.license.CCLicense; +import org.dspace.license.CCLicenseField; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Component; + +/** + * This converter is responsible for transforming the model representation of an CCLicense to the REST + * representation of an CCLicense and vice versa + **/ +@Component +public class SubmissionCCLicenseConverter implements DSpaceConverter { + + @Autowired + private ConverterService converter; + + /** + * Convert a CCLicense to its REST representation + * @param modelObject - the CCLicense to convert + * @param projection - the projection + * @return the corresponding SubmissionCCLicenseRest object + */ + @Override + public SubmissionCCLicenseRest convert(final CCLicense modelObject, final Projection projection) { + SubmissionCCLicenseRest submissionCCLicenseRest = new SubmissionCCLicenseRest(); + submissionCCLicenseRest.setProjection(projection); + submissionCCLicenseRest.setId(modelObject.getLicenseId()); + submissionCCLicenseRest.setName(modelObject.getLicenseName()); + + List ccLicenseFieldList = modelObject.getCcLicenseFieldList(); + List submissionCCLicenseFieldRests = new LinkedList<>(); + if (ccLicenseFieldList != null) { + for (CCLicenseField ccLicenseField : ccLicenseFieldList) { + submissionCCLicenseFieldRests.add(converter.toRest(ccLicenseField, projection)); + } + } + submissionCCLicenseRest.setFields(submissionCCLicenseFieldRests); + return submissionCCLicenseRest; + } + + public Class getModelClass() { + return CCLicense.class; + } + +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseFieldConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseFieldConverter.java new file mode 100644 index 0000000000..b0418ef4b5 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseFieldConverter.java @@ -0,0 +1,61 @@ +/** + * 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.rest.converter; + +import java.util.LinkedList; +import java.util.List; + +import org.dspace.app.rest.model.SubmissionCCLicenseFieldEnumRest; +import org.dspace.app.rest.model.SubmissionCCLicenseFieldRest; +import org.dspace.app.rest.projection.Projection; +import org.dspace.license.CCLicenseField; +import org.dspace.license.CCLicenseFieldEnum; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Component; + +/** + * This converter is responsible for transforming the model representation of an CCLicenseField to the REST + * representation of an CCLicenseField and vice versa + * The CCLicenseField is a sub component of the CCLicense object + **/ +@Component +public class SubmissionCCLicenseFieldConverter + implements DSpaceConverter { + + @Autowired + private ConverterService converter; + + /** + * Convert a CCLicenseField to its REST representation + * @param modelObject - the CCLicenseField to convert + * @param projection - the projection + * @return the corresponding SubmissionCCLicenseFieldRest object + */ + @Override + public SubmissionCCLicenseFieldRest convert(final CCLicenseField modelObject, final Projection projection) { + SubmissionCCLicenseFieldRest submissionCCLicenseFieldRest = new SubmissionCCLicenseFieldRest(); + submissionCCLicenseFieldRest.setId(modelObject.getId()); + submissionCCLicenseFieldRest.setLabel(modelObject.getLabel()); + submissionCCLicenseFieldRest.setDescription(modelObject.getDescription()); + + List fieldEnum = modelObject.getFieldEnum(); + List submissionCCLicenseFieldEnumRests = new LinkedList<>(); + if (fieldEnum != null) { + for (CCLicenseFieldEnum ccLicenseFieldEnum : fieldEnum) { + submissionCCLicenseFieldEnumRests.add(converter.toRest(ccLicenseFieldEnum, projection)); + } + } + submissionCCLicenseFieldRest.setEnums(submissionCCLicenseFieldEnumRests); + return submissionCCLicenseFieldRest; + } + + public Class getModelClass() { + return CCLicenseField.class; + } + +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseFieldEnumConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseFieldEnumConverter.java new file mode 100644 index 0000000000..85ed1c45e4 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseFieldEnumConverter.java @@ -0,0 +1,45 @@ +/** + * 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.rest.converter; + +import org.dspace.app.rest.model.SubmissionCCLicenseFieldEnumRest; +import org.dspace.app.rest.projection.Projection; +import org.dspace.license.CCLicenseFieldEnum; +import org.springframework.stereotype.Component; + +/** + * This converter is responsible for transforming the model representation of an CCLicenseFieldEnum to the REST + * representation of an CCLicenseFieldEnum and vice versa + * The CCLicenseFieldEnum is a sub component of the CCLicenseField object + **/ +@Component +public class SubmissionCCLicenseFieldEnumConverter + implements DSpaceConverter { + + /** + * Convert a CCLicenseFieldEnum to its REST representation + * + * @param modelObject - the CCLicenseField to convert + * @param projection - the projection + * @return the corresponding SubmissionCCLicenseFieldEnumRest object + */ + @Override + public SubmissionCCLicenseFieldEnumRest convert(final CCLicenseFieldEnum modelObject, final Projection projection) { + SubmissionCCLicenseFieldEnumRest submissionCCLicenseFieldEnumRest = new SubmissionCCLicenseFieldEnumRest(); + submissionCCLicenseFieldEnumRest.setId(modelObject.getId()); + submissionCCLicenseFieldEnumRest.setLabel(modelObject.getLabel()); + submissionCCLicenseFieldEnumRest.setDescription(modelObject.getDescription()); + + return submissionCCLicenseFieldEnumRest; + } + + public Class getModelClass() { + return CCLicenseFieldEnum.class; + } + +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseFieldEnumRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseFieldEnumRest.java new file mode 100644 index 0000000000..770eb25782 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseFieldEnumRest.java @@ -0,0 +1,44 @@ +/** + * 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.rest.model; + +/** + * This class is the REST representation of the CCLicenseFieldEnum model object and acts as a data sub object + * for the SubmissionCCLicenseFieldRest class. + * Refer to {@link org.dspace.license.CCLicenseFieldEnum} for explanation of the properties + */ +public class SubmissionCCLicenseFieldEnumRest { + + private String id; + private String label; + private String description; + + public String getId() { + return id; + } + + public void setId(final String id) { + this.id = id; + } + + public String getLabel() { + return label; + } + + public void setLabel(final String label) { + this.label = label; + } + + public String getDescription() { + return description; + } + + public void setDescription(final String description) { + this.description = description; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseFieldRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseFieldRest.java new file mode 100644 index 0000000000..bcc90279dc --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseFieldRest.java @@ -0,0 +1,59 @@ +/** + * 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.rest.model; + +import java.util.List; + +/** + * This class is the REST representation of the CCLicenseField model object and acts as a data sub object + * for the SubmissionCCLicenseRest class. + * Refer to {@link org.dspace.license.CCLicenseField} for explanation of the properties + */ +public class SubmissionCCLicenseFieldRest { + + private String id; + + private String label; + + private String description; + + private List enums; + + + public String getId() { + return id; + } + + public void setId(final String id) { + this.id = id; + } + + public String getLabel() { + return label; + } + + public void setLabel(final String label) { + this.label = label; + } + + public String getDescription() { + return description; + } + + public void setDescription(final String description) { + this.description = description; + } + + public List getEnums() { + return enums; + } + + public void setEnums(final List enums) { + this.enums = enums; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseRest.java new file mode 100644 index 0000000000..396e014531 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseRest.java @@ -0,0 +1,73 @@ +/** + * 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.rest.model; + +import java.util.List; + +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonProperty; +import org.dspace.app.rest.RestResourceController; + +/** + * This class is the REST representation of the CCLicense model object and acts as a data object + * * for the SubmissionCCLicenseResource class. + * Refer to {@link org.dspace.license.CCLicense} for explanation of the properties + */ +public class SubmissionCCLicenseRest extends BaseObjectRest { + public static final String NAME = "submissioncclicense"; + + public static final String CATEGORY = RestAddressableModel.CONFIGURATION; + + private String id; + + private String name; + + private List fields; + + public String getId() { + return id; + } + + public void setId(final String id) { + this.id = id; + } + + public String getName() { + return name; + } + + public void setName(final String name) { + this.name = name; + } + + public List getFields() { + return fields; + } + + public void setFields(final List fields) { + this.fields = fields; + } + + @JsonIgnore + @Override + public String getCategory() { + return CATEGORY; + } + + @Override + @JsonProperty(access = JsonProperty.Access.READ_ONLY) + public String getType() { + return NAME; + } + + @Override + @JsonIgnore + public Class getController() { + return RestResourceController.class; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/SubmissionCCLicenseResource.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/SubmissionCCLicenseResource.java new file mode 100644 index 0000000000..fb041d2827 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/SubmissionCCLicenseResource.java @@ -0,0 +1,23 @@ +/** + * 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.rest.model.hateoas; + +import org.dspace.app.rest.model.SubmissionCCLicenseRest; +import org.dspace.app.rest.model.hateoas.annotations.RelNameDSpaceResource; +import org.dspace.app.rest.utils.Utils; + +/** + * CCLicense HAL Resource. This resource adds the data from the REST object together with embedded objects + * and a set of links if applicable + */ +@RelNameDSpaceResource(SubmissionCCLicenseRest.NAME) +public class SubmissionCCLicenseResource extends DSpaceResource { + public SubmissionCCLicenseResource(SubmissionCCLicenseRest submissionCCLicenseRest, Utils utils) { + super(submissionCCLicenseRest, utils); + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java new file mode 100644 index 0000000000..d3c5236141 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java @@ -0,0 +1,44 @@ +/** + * 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.rest.repository; + +import java.util.List; + +import org.dspace.app.rest.model.SubmissionCCLicenseRest; +import org.dspace.core.Context; +import org.dspace.license.CCLicense; +import org.dspace.license.service.CreativeCommonsService; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; +import org.springframework.stereotype.Component; + +/** + * This is the repository that is responsible to manage CCLicense Rest objects + */ +@Component(SubmissionCCLicenseRest.CATEGORY + "." + SubmissionCCLicenseRest.NAME) +public class SubmissionCCLicenseRestRepository extends DSpaceRestRepository { + + @Autowired + protected CreativeCommonsService creativeCommonsService; + + + public SubmissionCCLicenseRest findOne(final Context context, final String s) { + return null; + } + + public Page findAll(final Context context, final Pageable pageable) { + + List allCCLicenses = creativeCommonsService.findAllCCLicenses(); + return converter.toRestPage(utils.getPage(allCCLicenses, pageable), utils.obtainProjection()); + } + + public Class getDomainClass() { + return null; + } +} diff --git a/dspace-server-webapp/src/test/data/dspaceFolder/config/spring/api/core-services-mock.xml b/dspace-server-webapp/src/test/data/dspaceFolder/config/spring/api/core-services-mock.xml index ff13e7f6b4..8010d3e5d6 100644 --- a/dspace-server-webapp/src/test/data/dspaceFolder/config/spring/api/core-services-mock.xml +++ b/dspace-server-webapp/src/test/data/dspaceFolder/config/spring/api/core-services-mock.xml @@ -6,4 +6,5 @@ + diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseRestRepositoryIT.java new file mode 100644 index 0000000000..0cf4f2b387 --- /dev/null +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseRestRepositoryIT.java @@ -0,0 +1,46 @@ +/** + * 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.rest; + +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +import org.dspace.app.rest.matcher.SubmissionCCLicenseMatcher; +import org.dspace.app.rest.test.AbstractControllerIntegrationTest; +import org.hamcrest.Matchers; +import org.junit.Test; + +/** + * Class to the methods from the SubmissionCCLicenseRestRepository + * Since the CC Licenses are obtained from the CC License API, a mock service has been implemented + * This mock service will return a fixed set of CC Licenses using a similar structure to the ones obtained from the + * CC License API. + * Refer to {@link org.dspace.license.MockCCLicenseConnectorServiceImpl} for more information + */ +public class SubmissionCCLicenseRestRepositoryIT extends AbstractControllerIntegrationTest { + + + /** + * Test the findAll method form the SubmissionCCLicenseRestRepository + * @throws Exception + */ + @Test + public void findAllTest() throws Exception { + + getClient().perform(get("/api/config/submissioncclicenses")) + .andExpect(status().isOk()) + .andExpect(content().contentType(contentType)) + .andExpect(jsonPath("$._embedded.submissioncclicenses", Matchers.containsInAnyOrder( + SubmissionCCLicenseMatcher.matchLicenseEntry(1, new int[]{3, 2, 3}), + SubmissionCCLicenseMatcher.matchLicenseEntry(2, new int[]{2}), + SubmissionCCLicenseMatcher.matchLicenseEntry(3, new int[]{}) + ))); + } +} diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/matcher/SubmissionCCLicenseMatcher.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/matcher/SubmissionCCLicenseMatcher.java new file mode 100644 index 0000000000..cdf0470b51 --- /dev/null +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/matcher/SubmissionCCLicenseMatcher.java @@ -0,0 +1,82 @@ +/** + * 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.rest.matcher; + +import static com.jayway.jsonpath.matchers.JsonPathMatchers.hasJsonPath; +import static org.hamcrest.Matchers.allOf; +import static org.hamcrest.Matchers.containsInAnyOrder; +import static org.hamcrest.Matchers.is; + +import java.util.LinkedList; +import java.util.List; + +import org.hamcrest.Matcher; + +public class SubmissionCCLicenseMatcher { + + private SubmissionCCLicenseMatcher() { + } + + public static Matcher matchLicenseEntry(int count, int[] amountOfFieldsAndEnums) { + return allOf( + matchLicenseProperties(count), + matchFields(count, amountOfFieldsAndEnums) + ); + } + + private static Matcher matchFields(int count, int[] amountOfFieldsAndEnums) { + List> matchers = new LinkedList<>(); + for (int index = 0; index < amountOfFieldsAndEnums.length; index++) { + matchers.add(matchField(count, index, amountOfFieldsAndEnums[index])); + } + return hasJsonPath("$.fields", containsInAnyOrder(matchers)); + } + + private static Matcher matchField(int count, int fieldIndex, int amountOfEnums) { + return allOf( + matchLicenseFieldProperties(count, fieldIndex), + matchEnums(count, fieldIndex, amountOfEnums) + ); + + } + + private static Matcher matchEnums(int count, int fieldIndex, int amountOfEnums) { + List> matchers = new LinkedList<>(); + for (int index = 0; index < amountOfEnums; index++) { + matchers.add(matchLicenseFieldEnumProperties(count, fieldIndex, index)); + } +// return hasJsonPath("$.enums"); + return hasJsonPath("$.enums", containsInAnyOrder(matchers)); + } + + + public static Matcher matchLicenseProperties(int count) { + return allOf( + hasJsonPath("$.id", is("license" + count)), + hasJsonPath("$.name", is("License " + count + " - Name")) + ); + } + + public static Matcher matchLicenseFieldProperties(int count, int fieldIndex) { + return allOf( + hasJsonPath("$.id", is("license" + count + "-field" + fieldIndex)), + hasJsonPath("$.label", is("License " + count + " - Field " + fieldIndex + " - Label")), + hasJsonPath("$.description", is("License " + count + " - Field " + fieldIndex + " - Description")) + ); + } + + public static Matcher matchLicenseFieldEnumProperties(int count, int fieldIndex, int enumIndex) { + return allOf( + hasJsonPath("$.id", is("license" + count + "-field" + fieldIndex + "-enum" + enumIndex)), + hasJsonPath("$.label", + is("License " + count + " - Field " + fieldIndex + " - Enum " + enumIndex + " - Label")), + hasJsonPath("$.description", + is("License " + count + " - Field " + fieldIndex + " - Enum " + enumIndex + " - " + "Description")) + ); + } +} diff --git a/dspace-server-webapp/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java b/dspace-server-webapp/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java new file mode 100644 index 0000000000..54219bbaaa --- /dev/null +++ b/dspace-server-webapp/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.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.license; + +import java.util.LinkedList; +import java.util.List; + +/** + * Mock implementation for the Creative commons license connector service. + * This class will return a structure of CC Licenses similar to the CC License API but without having to contact it + */ +public class MockCCLicenseConnectorServiceImpl extends CCLicenseConnectorServiceImpl { + + /** + * Retrieves mock CC Licenses for the provided language + * @param language - the language + * @return a list of mocked licenses + */ + public List retrieveLicenses(String language) { + List ccLicenses = new LinkedList<>(); + ccLicenses.add(createMockLicense(1, new int[]{3, 2, 3})); + ccLicenses.add(createMockLicense(2, new int[]{2})); + ccLicenses.add(createMockLicense(3, new int[]{})); + + return ccLicenses; + } + + private CCLicense createMockLicense(int count, int[] amountOfFieldsAndEnums) { + String licenseId = "license" + count; + String licenseName = "License " + count + " - Name"; + List mockLicenseFields = createMockLicenseFields(count, amountOfFieldsAndEnums); + return new CCLicense(licenseId, licenseName, mockLicenseFields); + } + + private List createMockLicenseFields(int count, int[] amountOfFieldsAndEnums) { + List ccLicenseFields = new LinkedList<>(); + for (int index = 0; index < amountOfFieldsAndEnums.length; index++) { + String licenseFieldId = "license" + count + "-field" + index; + String licenseFieldLabel = "License " + count + " - Field " + index + " - Label"; + String licenseFieldDescription = "License " + count + " - Field " + index + " - Description"; + List mockLicenseFields = createMockLicenseFields(count, + index, + amountOfFieldsAndEnums[index]); + ccLicenseFields.add(new CCLicenseField(licenseFieldId, + licenseFieldLabel, + licenseFieldDescription, + mockLicenseFields)); + + } + + return ccLicenseFields; + } + + private List createMockLicenseFields(int count, int index, int amountOfEnums) { + List ccLicenseFieldEnumList = new LinkedList<>(); + for (int i = 0; i < amountOfEnums; i++) { + String enumId = "license" + count + "-field" + index + "-enum" + i; + String enumLabel = "License " + count + " - Field " + index + " - Enum " + i + " - Label"; + String enumDescription = "License " + count + " - Field " + index + " - Enum " + i + " - " + + "Description"; + ccLicenseFieldEnumList.add(new CCLicenseFieldEnum(enumId, enumLabel, enumDescription)); + } + return ccLicenseFieldEnumList; + + } + +} diff --git a/dspace/config/spring/api/core-services.xml b/dspace/config/spring/api/core-services.xml index 316f81fd18..64d8cc7147 100644 --- a/dspace/config/spring/api/core-services.xml +++ b/dspace/config/spring/api/core-services.xml @@ -100,6 +100,7 @@ + From 18c8efd95106f02ec12fe6edc9fb2abaf3735a0e Mon Sep 17 00:00:00 2001 From: Yana De Pauw Date: Thu, 9 Apr 2020 14:26:39 +0200 Subject: [PATCH 028/125] 70332: Implement feedback --- .../CCLicenseConnectorServiceImpl.java | 62 ++++++++++--------- .../SubmissionCCLicenseConverter.java | 1 + .../SubmissionCCLicenseFieldConverter.java | 1 + ...SubmissionCCLicenseFieldEnumConverter.java | 1 + .../SubmissionCCLicenseRestRepository.java | 6 +- 5 files changed, 41 insertions(+), 30 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java index edc9934694..a0dbd075cf 100644 --- a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java @@ -59,19 +59,21 @@ public class CCLicenseConnectorServiceImpl implements CCLicenseConnectorService, /** * Retrieves the CC Licenses for the provided language from the CC License API + * * @param language - the language to retrieve the licenses for * @return a list of licenses obtained for the provided languages */ public List retrieveLicenses(String language) { String ccLicenseUrl = configurationService.getProperty("cc.api.rooturl"); - HttpGet httpGet = new HttpGet(ccLicenseUrl + "/?locale=" + language); + String uri = ccLicenseUrl + "/?locale=" + language; + HttpGet httpGet = new HttpGet(uri); List licenses; try (CloseableHttpResponse response = client.execute(httpGet)) { licenses = retrieveLicenses(response); } catch (JDOMException | JaxenException | IOException e) { - log.error(e); + log.error("Error while retrieving the license details using url: " + uri, e); licenses = Collections.emptyList(); } @@ -79,12 +81,13 @@ public class CCLicenseConnectorServiceImpl implements CCLicenseConnectorService, for (String license : licenses) { - HttpGet licenseHttpGet = new HttpGet(ccLicenseUrl + "/license/" + license); + String licenseUri = ccLicenseUrl + "/license/" + license; + HttpGet licenseHttpGet = new HttpGet(licenseUri); try (CloseableHttpResponse response = client.execute(licenseHttpGet)) { - CCLicense ccLicense = retrieveLicenseObject(response); + CCLicense ccLicense = retrieveLicenseObject(license, response); ccLicenses.add(ccLicense); } catch (JaxenException | JDOMException | IOException e) { - log.error(e); + log.error("Error while retrieving the license details using url: " + licenseUri, e); } } @@ -94,6 +97,7 @@ public class CCLicenseConnectorServiceImpl implements CCLicenseConnectorService, /** * 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 @@ -111,14 +115,16 @@ public class CCLicenseConnectorServiceImpl implements CCLicenseConnectorService, JDOMXPath licenseClassXpath = new JDOMXPath("//licenses/license"); - InputSource is = new InputSource(new StringReader(responseString)); - org.jdom.Document classDoc = this.parser.build(is); + try (StringReader stringReader = new StringReader(responseString)) { + InputSource is = new InputSource(stringReader); + org.jdom.Document classDoc = this.parser.build(is); - List elements = licenseClassXpath.selectNodes(classDoc); - for (Element element : elements) { - String licenseId = getSingleNodeValue(element, "@id"); - if (StringUtils.isNotBlank(licenseId) && !ArrayUtils.contains(excludedLicenses, licenseId)) { - domains.add(licenseId); + List elements = licenseClassXpath.selectNodes(classDoc); + for (Element element : elements) { + String licenseId = getSingleNodeValue(element, "@id"); + if (StringUtils.isNotBlank(licenseId) && !ArrayUtils.contains(excludedLicenses, licenseId)) { + domains.add(licenseId); + } } } @@ -128,13 +134,15 @@ public class CCLicenseConnectorServiceImpl implements CCLicenseConnectorService, /** * Parse the response for a single CC License and return the corresponding CC License Object - * @param response for a specific CC License response + * + * @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 JaxenException * @throws JDOMException */ - private CCLicense retrieveLicenseObject(CloseableHttpResponse response) + private CCLicense retrieveLicenseObject(final String licenseId, CloseableHttpResponse response) throws IOException, JaxenException, JDOMException { String responseString = EntityUtils.toString(response.getEntity()); @@ -144,26 +152,24 @@ public class CCLicenseConnectorServiceImpl implements CCLicenseConnectorService, JDOMXPath licenseFieldXpath = new JDOMXPath("field"); - InputSource is; + try (StringReader stringReader = new StringReader(responseString)) { + InputSource is = new InputSource(stringReader); - is = new InputSource(new StringReader(responseString)); + org.jdom.Document classDoc = this.parser.build(is); - org.jdom.Document classDoc = this.parser.build(is); + Object element = licenseClassXpath.selectSingleNode(classDoc); + String licenseLabel = getSingleNodeValue(element, "label"); - Object element = licenseClassXpath.selectSingleNode(classDoc); - String licenseId = getSingleNodeValue(element, "@id"); - String licenseLabel = getSingleNodeValue(element, "label"); + List ccLicenseFields = new LinkedList<>(); - List ccLicenseFields = new LinkedList<>(); + List licenseFields = licenseFieldXpath.selectNodes(element); + for (Element licenseField : licenseFields) { + CCLicenseField ccLicenseField = parseLicenseField(licenseField); + ccLicenseFields.add(ccLicenseField); + } - List licenseFields = licenseFieldXpath.selectNodes(element); - for (Element licenseField : licenseFields) { - CCLicenseField ccLicenseField = parseLicenseField(licenseField); - ccLicenseFields.add(ccLicenseField); + return new CCLicense(licenseId, licenseLabel, ccLicenseFields); } - - - return new CCLicense(licenseId, licenseLabel, ccLicenseFields); } private CCLicenseField parseLicenseField(final Element licenseField) throws JaxenException { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseConverter.java index bd7e582e75..bf6b92a618 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseConverter.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseConverter.java @@ -52,6 +52,7 @@ public class SubmissionCCLicenseConverter implements DSpaceConverter getModelClass() { return CCLicense.class; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseFieldConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseFieldConverter.java index b0418ef4b5..782056dc1c 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseFieldConverter.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseFieldConverter.java @@ -54,6 +54,7 @@ public class SubmissionCCLicenseFieldConverter return submissionCCLicenseFieldRest; } + @Override public Class getModelClass() { return CCLicenseField.class; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseFieldEnumConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseFieldEnumConverter.java index 85ed1c45e4..6c8993905f 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseFieldEnumConverter.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseFieldEnumConverter.java @@ -38,6 +38,7 @@ public class SubmissionCCLicenseFieldEnumConverter return submissionCCLicenseFieldEnumRest; } + @Override public Class getModelClass() { return CCLicenseFieldEnum.class; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java index d3c5236141..d8ee6bec15 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java @@ -27,18 +27,20 @@ public class SubmissionCCLicenseRestRepository extends DSpaceRestRepository findAll(final Context context, final Pageable pageable) { List allCCLicenses = creativeCommonsService.findAllCCLicenses(); return converter.toRestPage(utils.getPage(allCCLicenses, pageable), utils.obtainProjection()); } + @Override public Class getDomainClass() { - return null; + return SubmissionCCLicenseRest.class; } } From f51a12d0106281d32885e1006d91f0c48110de05 Mon Sep 17 00:00:00 2001 From: Yana De Pauw Date: Fri, 10 Apr 2020 10:27:32 +0200 Subject: [PATCH 029/125] 70334: CC license (REST): Initial fineOne endpoint --- .../license/CCLicenseConnectorService.java | 7 ++- .../CCLicenseConnectorServiceImpl.java | 10 ++-- .../license/CreativeCommonsServiceImpl.java | 57 +++++++++++++++++-- .../service/CreativeCommonsService.java | 18 ++++++ .../MockCCLicenseConnectorServiceImpl.java | 18 ++++-- .../SubmissionCCLicenseRestRepository.java | 9 ++- .../SubmissionCCLicenseRestRepositoryIT.java | 16 ++++++ .../MockCCLicenseConnectorServiceImpl.java | 18 ++++-- 8 files changed, 127 insertions(+), 26 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorService.java b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorService.java index 52bbf39cc7..caf079d230 100644 --- a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorService.java +++ b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorService.java @@ -7,7 +7,7 @@ */ package org.dspace.license; -import java.util.List; +import java.util.Map; /** * Service interface class for the Creative commons license connector service. @@ -18,9 +18,10 @@ public interface CCLicenseConnectorService { /** * Retrieves the CC Licenses for the provided language from the CC License API + * * @param language - the language to retrieve the licenses for - * @return a list of licenses obtained for the provided languages + * @return a map of licenses with the id and the license for the provided language */ - public List retrieveLicenses(String language); + public Map retrieveLicenses(String language); } diff --git a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java index a0dbd075cf..4cb6d74b0f 100644 --- a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java @@ -10,8 +10,10 @@ package org.dspace.license; import java.io.IOException; import java.io.StringReader; 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; @@ -61,9 +63,9 @@ public class CCLicenseConnectorServiceImpl implements CCLicenseConnectorService, * Retrieves the CC Licenses for the provided language from the CC License API * * @param language - the language to retrieve the licenses for - * @return a list of licenses obtained for the provided languages + * @return a map of licenses with the id and the license for the provided language */ - public List retrieveLicenses(String language) { + public Map retrieveLicenses(String language) { String ccLicenseUrl = configurationService.getProperty("cc.api.rooturl"); String uri = ccLicenseUrl + "/?locale=" + language; @@ -77,7 +79,7 @@ public class CCLicenseConnectorServiceImpl implements CCLicenseConnectorService, licenses = Collections.emptyList(); } - List ccLicenses = new LinkedList<>(); + Map ccLicenses = new HashMap<>(); for (String license : licenses) { @@ -85,7 +87,7 @@ public class CCLicenseConnectorServiceImpl implements CCLicenseConnectorService, HttpGet licenseHttpGet = new HttpGet(licenseUri); try (CloseableHttpResponse response = client.execute(licenseHttpGet)) { CCLicense ccLicense = retrieveLicenseObject(license, response); - ccLicenses.add(ccLicense); + ccLicenses.put(ccLicense.getLicenseId(), ccLicense); } catch (JaxenException | JDOMException | IOException e) { log.error("Error while retrieving the license details using url: " + licenseUri, e); } diff --git a/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java b/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java index fed51a9f0a..1c08d297dc 100644 --- a/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java @@ -13,7 +13,10 @@ import java.io.IOException; import java.io.InputStream; import java.io.StringWriter; import java.sql.SQLException; +import java.util.HashMap; +import java.util.LinkedList; import java.util.List; +import java.util.Map; import javax.xml.transform.Templates; import javax.xml.transform.TransformerConfigurationException; import javax.xml.transform.TransformerException; @@ -87,7 +90,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi protected ConfigurationService configurationService = DSpaceServicesFactory.getInstance().getConfigurationService(); - private List ccLicenses; + private Map> ccLicenses; protected CreativeCommonsServiceImpl() { @@ -105,6 +108,9 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi System.setProperty("http.proxyPort", proxyPort); } + ccLicenses = new HashMap<>(); + + try { templates = TransformerFactory.newInstance().newTemplates( new StreamSource(CreativeCommonsServiceImpl.class @@ -389,6 +395,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi /** * Find all CC Licenses using the default language found in the configuration + * * @return A list of available CC Licenses */ public List findAllCCLicenses() { @@ -398,15 +405,55 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi /** * Find all CC Licenses for the provided language - * @param language - the language for which to find the CC Licenses + * + * @param language - the language for which to find the CC Licenses * @return A list of available CC Licenses for the provided language */ public List findAllCCLicenses(String language) { - if (ccLicenses == null || ccLicenses.isEmpty()) { - ccLicenses = ccLicenseConnectorService.retrieveLicenses(language); + if (!ccLicenses.containsKey(language)) { + initLicenses(language); } - return ccLicenses; + return new LinkedList<>(ccLicenses.get(language).values()); + } + + /** + * Find the CC License corresponding to the provided ID using the default language found in the configuration + * + * @param id - the ID of the license to be found + * @return the corresponding license if found or null when not found + */ + public CCLicense findOne(String id) { + String language = configurationService.getProperty("cc.license.locale", "en"); + return findOne(id, language); + } + + /** + * Find the CC License corresponding to the provided ID and provided language + * + * @param id - the ID of the license to be found + * @param language - the language for which to find the CC License + * @return the corresponding license if found or null when not found + */ + public CCLicense findOne(String id, String language) { + if (!ccLicenses.containsKey(language)) { + initLicenses(language); + } + Map licenseMap = ccLicenses.get(language); + if (licenseMap.containsKey(id)) { + return licenseMap.get(id); + } + return null; + } + + /** + * Retrieves the licenses for a specific language and cache them in this service + * + * @param language - the language for which to find the CC Licenses + */ + private void initLicenses(final String language) { + Map licenseMap = ccLicenseConnectorService.retrieveLicenses(language); + ccLicenses.put(language, licenseMap); } } diff --git a/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java b/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java index d25f02ff7b..edb9410f7e 100644 --- a/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java +++ b/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java @@ -166,4 +166,22 @@ public interface CreativeCommonsService { * @return A list of available CC Licenses for the provided language */ public List findAllCCLicenses(String language); + + /** + * Find the CC License corresponding to the provided ID using the default language found in the configuration + * + * @param id - the ID of the license to be found + * @return the corresponding license if found or null when not found + */ + public CCLicense findOne(String id); + + /** + * Find the CC License corresponding to the provided ID and provided language + * + * @param id - the ID of the license to be found + * @param language - the language for which to find the CC License + * @return the corresponding license if found or null when not found + */ + public CCLicense findOne(String id, String language); + } diff --git a/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java b/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java index 54219bbaaa..df934312d1 100644 --- a/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java +++ b/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java @@ -7,8 +7,10 @@ */ package org.dspace.license; +import java.util.HashMap; import java.util.LinkedList; import java.util.List; +import java.util.Map; /** * Mock implementation for the Creative commons license connector service. @@ -19,13 +21,17 @@ public class MockCCLicenseConnectorServiceImpl extends CCLicenseConnectorService /** * Retrieves mock CC Licenses for the provided language * @param language - the language - * @return a list of mocked licenses + * @return a map of mocked licenses with the id and the license */ - public List retrieveLicenses(String language) { - List ccLicenses = new LinkedList<>(); - ccLicenses.add(createMockLicense(1, new int[]{3, 2, 3})); - ccLicenses.add(createMockLicense(2, new int[]{2})); - ccLicenses.add(createMockLicense(3, new int[]{})); + public Map retrieveLicenses(String language) { + Map ccLicenses = new HashMap<>(); + CCLicense mockLicense1 = createMockLicense(1, new int[]{3, 2, 3}); + CCLicense mockLicense2 = createMockLicense(2, new int[]{2}); + CCLicense mockLicense3 = createMockLicense(3, new int[]{}); + + ccLicenses.put(mockLicense1.getLicenseId(), mockLicense1); + ccLicenses.put(mockLicense2.getLicenseId(), mockLicense2); + ccLicenses.put(mockLicense3.getLicenseId(), mockLicense3); return ccLicenses; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java index d8ee6bec15..88ba438639 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java @@ -16,6 +16,7 @@ import org.dspace.license.service.CreativeCommonsService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; +import org.springframework.data.rest.webmvc.ResourceNotFoundException; import org.springframework.stereotype.Component; /** @@ -28,8 +29,12 @@ public class SubmissionCCLicenseRestRepository extends DSpaceRestRepository retrieveLicenses(String language) { - List ccLicenses = new LinkedList<>(); - ccLicenses.add(createMockLicense(1, new int[]{3, 2, 3})); - ccLicenses.add(createMockLicense(2, new int[]{2})); - ccLicenses.add(createMockLicense(3, new int[]{})); + public Map retrieveLicenses(String language) { + Map ccLicenses = new HashMap<>(); + CCLicense mockLicense1 = createMockLicense(1, new int[]{3, 2, 3}); + CCLicense mockLicense2 = createMockLicense(2, new int[]{2}); + CCLicense mockLicense3 = createMockLicense(3, new int[]{}); + + ccLicenses.put(mockLicense1.getLicenseId(), mockLicense1); + ccLicenses.put(mockLicense2.getLicenseId(), mockLicense2); + ccLicenses.put(mockLicense3.getLicenseId(), mockLicense3); return ccLicenses; } From 794ee9fb9fc723c787709a35ba172ce522ca133c Mon Sep 17 00:00:00 2001 From: Yana De Pauw Date: Tue, 14 Apr 2020 15:59:21 +0200 Subject: [PATCH 030/125] 70337: Search CC License --- .../license/CCLicenseConnectorService.java | 12 ++ .../CCLicenseConnectorServiceImpl.java | 94 +++++++++++++ .../license/CreativeCommonsServiceImpl.java | 131 +++++++++++++++++- .../service/CreativeCommonsService.java | 87 ++++++++++-- .../MockCCLicenseConnectorServiceImpl.java | 15 ++ .../SubmissionCCLicenseSearchController.java | 95 +++++++++++++ .../rest/model/SubmissionCCLicenseRest.java | 1 + .../SubmissionCCLicenseRestRepositoryIT.java | 1 + ...SubmissionCCLicenseSearchControllerIT.java | 68 +++++++++ .../MockCCLicenseConnectorServiceImpl.java | 14 ++ 10 files changed, 501 insertions(+), 17 deletions(-) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java create mode 100644 dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java diff --git a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorService.java b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorService.java index caf079d230..48ed5f7200 100644 --- a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorService.java +++ b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorService.java @@ -24,4 +24,16 @@ public interface CCLicenseConnectorService { */ public Map retrieveLicenses(String language); + /** + * 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); + } diff --git a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java index 4cb6d74b0f..7fedc7e2e1 100644 --- a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java @@ -9,6 +9,7 @@ package org.dspace.license; import java.io.IOException; import java.io.StringReader; +import java.text.MessageFormat; import java.util.Collections; import java.util.HashMap; import java.util.LinkedList; @@ -17,8 +18,11 @@ 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; @@ -45,6 +49,15 @@ public class CCLicenseConnectorServiceImpl implements CCLicenseConnectorService, private CloseableHttpClient client; private SAXBuilder parser = new SAXBuilder(); + private String postArgument = "answers"; + private String postAnswerFormat = + " " + + "{1}" + + "" + + "{2}" + + "" + + ""; + @Autowired private ConfigurationService configurationService; @@ -221,4 +234,85 @@ public class CCLicenseConnectorServiceImpl implements CCLicenseConnectorService, 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 | JaxenException | 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 JaxenException + * @throws JDOMException + */ + private String retrieveLicenseUri(final CloseableHttpResponse response) + throws IOException, JaxenException, JDOMException { + + String responseString = EntityUtils.toString(response.getEntity()); + JDOMXPath licenseClassXpath = new JDOMXPath("//result/license-uri"); + + + try (StringReader stringReader = new StringReader(responseString)) { + InputSource is = new InputSource(stringReader); + org.jdom.Document classDoc = this.parser.build(is); + + Object node = licenseClassXpath.selectSingleNode(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(); + } + + } diff --git a/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java b/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java index 1c08d297dc..c0c190307b 100644 --- a/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java @@ -90,6 +90,9 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi protected ConfigurationService configurationService = DSpaceServicesFactory.getInstance().getConfigurationService(); + private String defaultLanguage; + + private Map> ccLicenses; protected CreativeCommonsServiceImpl() { @@ -109,7 +112,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi } ccLicenses = new HashMap<>(); - + defaultLanguage = configurationService.getProperty("cc.license.locale", "en"); try { templates = TransformerFactory.newInstance().newTemplates( @@ -399,8 +402,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi * @return A list of available CC Licenses */ public List findAllCCLicenses() { - String language = configurationService.getProperty("cc.license.locale", "en"); - return findAllCCLicenses(language); + return findAllCCLicenses(defaultLanguage); } /** @@ -424,8 +426,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi * @return the corresponding license if found or null when not found */ public CCLicense findOne(String id) { - String language = configurationService.getProperty("cc.license.locale", "en"); - return findOne(id, language); + return findOne(id, defaultLanguage); } /** @@ -456,4 +457,124 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi ccLicenses.put(language, licenseMap); } + /** + * Retrieve the CC License URI for the provided license ID, based on the provided answers, using the default + * language found in the configuration + * + * @param licenseId - the ID of the license + * @param answerMap - the answers to the different field questions + * @return the corresponding license URI + */ + public String retrieveLicenseUri(String licenseId, Map answerMap) { + return retrieveLicenseUri(licenseId, defaultLanguage, answerMap); + + } + + /** + * Retrieve the CC License URI for the provided license ID and language based on the provided answers + * + * @param licenseId - the ID of the license + * @param language - the language for which to find the CC License URI + * @param answerMap - the answers to the different field questions + * @return the corresponding license URI + */ + public String retrieveLicenseUri(String licenseId, String language, Map answerMap) { + return ccLicenseConnectorService.retrieveRightsByQuestion(licenseId, language, answerMap); + + } + + /** + * Verify whether the answer map contains a valid response to all field questions and no answers that don't have a + * corresponding question in the license, using the default language found in the config to check the license + * + * @param licenseId - the ID of the license + * @param fullAnswerMap - the answers to the different field questions + * @return whether the information is valid + */ + public boolean verifyLicenseInformation(String licenseId, Map fullAnswerMap) { + return verifyLicenseInformation(licenseId, defaultLanguage, fullAnswerMap); + } + + /** + * Verify whether the answer map contains a valid response to all field questions and no answers that don't have a + * corresponding question in the license, using the provided language to check the license + * + * @param licenseId - the ID of the license + * @param language - the language for which to retrieve the full answerMap + * @param fullAnswerMap - the answers to the different field questions + * @return whether the information is valid + */ + public boolean verifyLicenseInformation(String licenseId, String language, Map fullAnswerMap) { + CCLicense ccLicense = findOne(licenseId, language); + + List ccLicenseFieldList = ccLicense.getCcLicenseFieldList(); + + for (String field : fullAnswerMap.keySet()) { + CCLicenseField ccLicenseField = findCCLicenseField(field, ccLicenseFieldList); + if (ccLicenseField == null) { + return false; + } + if (!containsAnswerEnum(fullAnswerMap.get(field), ccLicenseField)) { + return false; + } + } + return true; + } + + /** + * Retrieve the full answer map containing empty values when an answer for a field was not provided in the + * answerMap, using the default language found in the configuration + * + * @param licenseId - the ID of the license + * @param answerMap - the answers to the different field questions + * @return the answerMap supplemented with all other license fields with a blank answer + */ + public Map retrieveFullAnswerMap(String licenseId, Map answerMap) { + return retrieveFullAnswerMap(licenseId, defaultLanguage, answerMap); + } + + /** + * Retrieve the full answer map for a provided language, containing empty values when an answer for a field was not + * provided in the answerMap. + * + * @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 answerMap supplemented with all other license fields with a blank answer for the provided language + */ + public Map retrieveFullAnswerMap(String licenseId, String language, Map answerMap) { + CCLicense ccLicense = findOne(licenseId, language); + if (ccLicense == null) { + return null; + } + Map fullParamMap = new HashMap<>(answerMap); + List ccLicenseFieldList = ccLicense.getCcLicenseFieldList(); + for (CCLicenseField ccLicenseField : ccLicenseFieldList) { + if (!fullParamMap.containsKey(ccLicenseField.getId())) { + fullParamMap.put(ccLicenseField.getId(), ""); + } + } + return fullParamMap; + } + + private boolean containsAnswerEnum(final String enumAnswer, final CCLicenseField ccLicenseField) { + List fieldEnums = ccLicenseField.getFieldEnum(); + for (CCLicenseFieldEnum fieldEnum : fieldEnums) { + if (StringUtils.equals(fieldEnum.getId(), enumAnswer)) { + return true; + } + } + return false; + } + + private CCLicenseField findCCLicenseField(final String field, final List ccLicenseFieldList) { + for (CCLicenseField ccLicenseField : ccLicenseFieldList) { + if (StringUtils.equals(ccLicenseField.getId(), field)) { + return ccLicenseField; + } + } + + return null; + } + } diff --git a/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java b/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java index edb9410f7e..cda546246f 100644 --- a/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java +++ b/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java @@ -11,6 +11,7 @@ import java.io.IOException; import java.io.InputStream; import java.sql.SQLException; import java.util.List; +import java.util.Map; import org.dspace.authorize.AuthorizeException; import org.dspace.content.Bitstream; @@ -52,7 +53,7 @@ public interface CreativeCommonsService { * to perform a particular action. */ public void setLicenseRDF(Context context, Item item, String licenseRdf) - throws SQLException, IOException, AuthorizeException; + throws SQLException, IOException, AuthorizeException; /** @@ -74,19 +75,19 @@ public interface CreativeCommonsService { */ public void setLicense(Context context, Item item, InputStream licenseStm, String mimeType) - throws SQLException, IOException, AuthorizeException; + throws SQLException, IOException, AuthorizeException; public void removeLicense(Context context, Item item) - throws SQLException, IOException, AuthorizeException; + throws SQLException, IOException, AuthorizeException; public boolean hasLicense(Context context, Item item) - throws SQLException, IOException; + throws SQLException, IOException; public String getLicenseURL(Context context, Item item) - throws SQLException, IOException, AuthorizeException; + throws SQLException, IOException, AuthorizeException; public String getLicenseRDF(Context context, Item item) - throws SQLException, IOException, AuthorizeException; + throws SQLException, IOException, AuthorizeException; /** * Get Creative Commons license RDF, returning Bitstream object. @@ -99,7 +100,7 @@ public interface CreativeCommonsService { * to perform a particular action. */ public Bitstream getLicenseRdfBitstream(Item item) - throws SQLException, IOException, AuthorizeException; + throws SQLException, IOException, AuthorizeException; /** * Get Creative Commons license Text, returning Bitstream object. @@ -114,7 +115,7 @@ public interface CreativeCommonsService { * is no longer stored (see https://jira.duraspace.org/browse/DS-2604) */ public Bitstream getLicenseTextBitstream(Item item) - throws SQLException, IOException, AuthorizeException; + throws SQLException, IOException, AuthorizeException; /** * Get a few license-specific properties. We expect these to be cached at @@ -150,7 +151,7 @@ public interface CreativeCommonsService { */ public void removeLicense(Context context, LicenseMetadataValue uriField, LicenseMetadataValue nameField, Item item) - throws AuthorizeException, IOException, SQLException; + throws AuthorizeException, IOException, SQLException; /** * Find all CC Licenses using the default language found in the configuration @@ -170,7 +171,7 @@ public interface CreativeCommonsService { /** * Find the CC License corresponding to the provided ID using the default language found in the configuration * - * @param id - the ID of the license to be found + * @param id - the ID of the license to be found * @return the corresponding license if found or null when not found */ public CCLicense findOne(String id); @@ -178,10 +179,72 @@ public interface CreativeCommonsService { /** * Find the CC License corresponding to the provided ID and provided language * - * @param id - the ID of the license to be found - * @param language - the language for which to find the CC License + * @param id - the ID of the license to be found + * @param language - the language for which to find the CC License * @return the corresponding license if found or null when not found */ public CCLicense findOne(String id, String language); + /** + * Retrieve the CC License URI for the provided license ID, based on the provided answers, using the default + * language found in the configuration + * + * @param licenseId - the ID of the license + * @param answerMap - the answers to the different field questions + * @return the corresponding license URI + */ + public String retrieveLicenseUri(String licenseId, Map answerMap); + + /** + * Retrieve the CC License URI for the provided license ID and language based on the provided answers + * + * @param licenseId - the ID of the license + * @param language - the language for which to find the CC License URI + * @param answerMap - the answers to the different field questions + * @return the corresponding license URI + */ + public String retrieveLicenseUri(String licenseId, String language, Map answerMap); + + /** + * Retrieve the full answer map containing empty values when an answer for a field was not provided in the + * answerMap, using the default language found in the configuration + * + * @param licenseId - the ID of the license + * @param answerMap - the answers to the different field questions + * @return the answerMap supplemented with all other license fields with a blank answer + */ + public Map retrieveFullAnswerMap(String licenseId, Map answerMap); + + /** + * Retrieve the full answer map for a provided language, containing empty values when an answer for a field was not + * provided in the answerMap. + * + * @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 answerMap supplemented with all other license fields with a blank answer for the provided language + */ + public Map retrieveFullAnswerMap(String licenseId, String language, Map answerMap); + + /** + * Verify whether the answer map contains a valid response to all field questions and no answers that don't have a + * corresponding question in the license, using the default language found in the config to check the license + * + * @param licenseId - the ID of the license + * @param fullAnswerMap - the answers to the different field questions + * @return whether the information is valid + */ + public boolean verifyLicenseInformation(String licenseId, Map fullAnswerMap); + + /** + * Verify whether the answer map contains a valid response to all field questions and no answers that don't have a + * corresponding question in the license, using the provided language to check the license + * + * @param licenseId - the ID of the license + * @param language - the language for which to retrieve the full answerMap + * @param fullAnswerMap - the answers to the different field questions + * @return whether the information is valid + */ + public boolean verifyLicenseInformation(String licenseId, String language, Map fullAnswerMap); + } diff --git a/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java b/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java index df934312d1..226e2aa77b 100644 --- a/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java +++ b/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java @@ -20,6 +20,7 @@ public class MockCCLicenseConnectorServiceImpl extends CCLicenseConnectorService /** * Retrieves mock CC Licenses for the provided language + * * @param language - the language * @return a map of mocked licenses with the id and the license */ @@ -75,4 +76,18 @@ public class MockCCLicenseConnectorServiceImpl extends CCLicenseConnectorService } + /** + * Retrieve a mock CC License URI + * + * @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(final String licenseId, + final String language, + final Map answerMap) { + + return "mock-license-uri"; + } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java new file mode 100644 index 0000000000..185fb7e8eb --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java @@ -0,0 +1,95 @@ +/** + * 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.rest; + +import java.util.HashMap; +import java.util.Map; +import javax.servlet.ServletRequest; + +import org.apache.commons.lang3.StringUtils; +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import org.dspace.app.rest.exception.DSpaceBadRequestException; +import org.dspace.app.rest.model.SubmissionCCLicenseRest; +import org.dspace.app.rest.utils.Utils; +import org.dspace.license.service.CreativeCommonsService; +import org.dspace.services.RequestService; +import org.dspace.utils.DSpace; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.data.rest.webmvc.ResourceNotFoundException; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.ResponseBody; +import org.springframework.web.bind.annotation.RestController; + +/** + * This controller is responsible for searching the CC License URI + */ +@RestController +@RequestMapping("/api/" + SubmissionCCLicenseRest.CATEGORY + "/" + SubmissionCCLicenseRest.PLURAL + "/search" + + "/rightsByQuestions") +public class SubmissionCCLicenseSearchController { + + private static final Logger log = LogManager.getLogger(); + + @Autowired + protected Utils utils; + + @Autowired + protected CreativeCommonsService creativeCommonsService; + + protected RequestService requestService = new DSpace().getRequestService(); + + /** + * Retrieves the CC License URI based on the license ID and answers in the field questions, provided as parameters + * to this request + * + * @return the CC License URI as a string + */ + @RequestMapping(method = RequestMethod.GET) + @ResponseBody + public String findByRightsByQuestions() { + ServletRequest servletRequest = requestService.getCurrentRequest() + .getServletRequest(); + Map requestParameterMap = servletRequest + .getParameterMap(); + Map parameterMap = new HashMap<>(); + String licenseId = servletRequest.getParameter("license"); + if (StringUtils.isBlank(licenseId)) { + throw new DSpaceBadRequestException( + "A \"license\" parameter needs to be provided."); + } + for (String parameter : requestParameterMap.keySet()) { + if (StringUtils.startsWith(parameter, "answer_")) { + String field = StringUtils.substringAfter(parameter, "answer_"); + String answer = ""; + if (requestParameterMap.get(parameter).length > 0) { + answer = requestParameterMap.get(parameter)[0]; + } + parameterMap.put(field, answer); + } + } + + Map fullParamMap = creativeCommonsService.retrieveFullAnswerMap(licenseId, parameterMap); + if (fullParamMap == null) { + throw new ResourceNotFoundException("No CC License could be matched on the provided ID: " + licenseId); + } + boolean licenseContainsCorrectInfo = creativeCommonsService.verifyLicenseInformation(licenseId, fullParamMap); + if (!licenseContainsCorrectInfo) { + throw new DSpaceBadRequestException( + "The provided answers do not match the required fields for the provided license."); + } + + String licenseUri = creativeCommonsService.retrieveLicenseUri(licenseId, fullParamMap); + + if (StringUtils.isBlank(licenseUri)) { + throw new ResourceNotFoundException("No CC License URI could be found for ID: " + licenseId); + } + return licenseUri; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseRest.java index 396e014531..611d532039 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseRest.java @@ -20,6 +20,7 @@ import org.dspace.app.rest.RestResourceController; */ public class SubmissionCCLicenseRest extends BaseObjectRest { public static final String NAME = "submissioncclicense"; + public static final String PLURAL = "submissioncclicenses"; public static final String CATEGORY = RestAddressableModel.CONFIGURATION; diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseRestRepositoryIT.java index 1a2b1b0839..5fa22470fe 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseRestRepositoryIT.java @@ -29,6 +29,7 @@ public class SubmissionCCLicenseRestRepositoryIT extends AbstractControllerInteg /** * Test the findAll method form the SubmissionCCLicenseRestRepository + * * @throws Exception */ @Test diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java new file mode 100644 index 0000000000..402f4c3a69 --- /dev/null +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java @@ -0,0 +1,68 @@ +/** + * 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.rest; + + +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +import org.dspace.app.rest.test.AbstractControllerIntegrationTest; +import org.junit.Test; + +/** + * Class to the methods from the SubmissionCCLicenseSearchController + * Since the CC Licenses and the corresponding URIs are obtained from the CC License API, a mock service has been + * implemented. + * This mock service will return a fixed set of CC Licenses using a similar structure to the ones obtained from the + * CC License API. + * Refer to {@link org.dspace.license.MockCCLicenseConnectorServiceImpl} for more information + */ +public class SubmissionCCLicenseSearchControllerIT extends AbstractControllerIntegrationTest { + + + @Test + public void searchRightsByQuestionsTest() throws Exception { + getClient().perform(get( + "/api/config/submissioncclicenses/search/rightsByQuestions?license=license2&answer_license2-field0" + + "=license2-field0-enum1")) + .andExpect(status().isOk()) + .andExpect(content().string("mock-license-uri")); + } + + @Test + public void searchRightsByQuestionsTestLicenseWithoutFields() throws Exception { + getClient().perform(get("/api/config/submissioncclicenses/search/rightsByQuestions?license=license3")) + .andExpect(status().isOk()) + .andExpect(content().string("mock-license-uri")); + } + + @Test + public void searchRightsByQuestionsNonExistingLicense() throws Exception { + getClient().perform(get( + "/api/config/submissioncclicenses/search/rightsByQuestions?license=nonexisting-license" + + "&answer_license2-field0=license2-field0-enum1")) + .andExpect(status().isNotFound()); + } + + @Test + public void searchRightsByQuestionsMissingRequiredAnswer() throws Exception { + getClient().perform(get( + "/api/config/submissioncclicenses/search/rightsByQuestions?license=license1&answer_license1field0" + + "=license1field0enum1")) + .andExpect(status().isBadRequest()); + } + + @Test + public void searchRightsByQuestionsAdditionalNonExistingAnswer() throws Exception { + getClient().perform(get( + "/api/config/submissioncclicenses/search/rightsByQuestions?license=license2" + + "&answer_license2field0=license2field0enum1&answer_nonexisting=test")) + .andExpect(status().isBadRequest()); + } +} diff --git a/dspace-server-webapp/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java b/dspace-server-webapp/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java index df934312d1..23d395ec2b 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java +++ b/dspace-server-webapp/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java @@ -75,4 +75,18 @@ public class MockCCLicenseConnectorServiceImpl extends CCLicenseConnectorService } + /** + * Retrieve a mock CC License URI + * + * @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(final String licenseId, + final String language, + final Map answerMap) { + + return "mock-license-uri"; + } } From b30f9d9338b9008e47442bf43e28f9313d58bdaa Mon Sep 17 00:00:00 2001 From: Yana De Pauw Date: Thu, 16 Apr 2020 16:51:02 +0200 Subject: [PATCH 031/125] 70403: CC license (REST): New submission section --- .../license/CreativeCommonsServiceImpl.java | 54 +++++++++++++++++-- .../dspace/license/LicenseMetadataValue.java | 4 ++ .../service/CreativeCommonsService.java | 20 ++++++- .../app/rest/model/step/DataCCLicense.java | 44 +++++++++++++++ .../submit/AbstractRestProcessingStep.java | 1 + .../app/rest/submit/SubmissionService.java | 52 ++++++++++++------ .../app/rest/submit/step/CCLicenseStep.java | 44 +++++++++++++++ dspace/config/item-submission.xml | 8 +-- 8 files changed, 202 insertions(+), 25 deletions(-) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/step/DataCCLicense.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/step/CCLicenseStep.java diff --git a/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java b/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java index c0c190307b..928e4b6891 100644 --- a/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java @@ -235,15 +235,51 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi @Override public String getLicenseURL(Context context, Item item) throws SQLException, IOException, AuthorizeException { - String licenseUri = getCCField("uri").ccItemValue(item); + String licenseUri = getCCField("uri"); if (StringUtils.isNotBlank(licenseUri)) { - return licenseUri; + return getLicenseURI(item); } // JSPUI backward compatibility see https://jira.duraspace.org/browse/DS-2604 return getStringFromBitstream(context, item, BSN_LICENSE_URL); } + /** + * Returns the stored license uri of the item + * + * @param item - The item for which to retrieve the stored license uri + * @return the stored license uri of the item + */ + @Override + public String getLicenseURI(Item item) { + String licenseUriField = getCCField("uri"); + if (StringUtils.isNotBlank(licenseUriField)) { + String metadata = itemService.getMetadata(item, licenseUriField); + if (StringUtils.isNotBlank(metadata)) { + return metadata; + } + } + return null; + } + + /** + * Returns the stored license name of the item + * + * @param item - The item for which to retrieve the stored license name + * @return the stored license name of the item + */ + @Override + public String getLicenseName( Item item) { + String licenseNameField = getCCField("name"); + if (StringUtils.isNotBlank(licenseNameField)) { + String metadata = itemService.getMetadata(item, licenseNameField); + if (StringUtils.isNotBlank(metadata)) { + return metadata; + } + } + return null; + } + @Override public String fetchLicenseRDF(Document license) { StringWriter result = new StringWriter(); @@ -374,8 +410,8 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi * Returns a metadata field handle for given field Id */ @Override - public LicenseMetadataValue getCCField(String fieldId) { - return new LicenseMetadataValue(configurationService.getProperty("cc.license." + fieldId)); + public String getCCField(String fieldId) { + return configurationService.getProperty("cc.license." + fieldId); } @Override @@ -401,6 +437,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi * * @return A list of available CC Licenses */ + @Override public List findAllCCLicenses() { return findAllCCLicenses(defaultLanguage); } @@ -411,6 +448,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi * @param language - the language for which to find the CC Licenses * @return A list of available CC Licenses for the provided language */ + @Override public List findAllCCLicenses(String language) { if (!ccLicenses.containsKey(language)) { @@ -425,6 +463,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi * @param id - the ID of the license to be found * @return the corresponding license if found or null when not found */ + @Override public CCLicense findOne(String id) { return findOne(id, defaultLanguage); } @@ -436,6 +475,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi * @param language - the language for which to find the CC License * @return the corresponding license if found or null when not found */ + @Override public CCLicense findOne(String id, String language) { if (!ccLicenses.containsKey(language)) { initLicenses(language); @@ -465,6 +505,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi * @param answerMap - the answers to the different field questions * @return the corresponding license URI */ + @Override public String retrieveLicenseUri(String licenseId, Map answerMap) { return retrieveLicenseUri(licenseId, defaultLanguage, answerMap); @@ -478,6 +519,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi * @param answerMap - the answers to the different field questions * @return the corresponding license URI */ + @Override public String retrieveLicenseUri(String licenseId, String language, Map answerMap) { return ccLicenseConnectorService.retrieveRightsByQuestion(licenseId, language, answerMap); @@ -491,6 +533,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi * @param fullAnswerMap - the answers to the different field questions * @return whether the information is valid */ + @Override public boolean verifyLicenseInformation(String licenseId, Map fullAnswerMap) { return verifyLicenseInformation(licenseId, defaultLanguage, fullAnswerMap); } @@ -504,6 +547,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi * @param fullAnswerMap - the answers to the different field questions * @return whether the information is valid */ + @Override public boolean verifyLicenseInformation(String licenseId, String language, Map fullAnswerMap) { CCLicense ccLicense = findOne(licenseId, language); @@ -529,6 +573,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi * @param answerMap - the answers to the different field questions * @return the answerMap supplemented with all other license fields with a blank answer */ + @Override public Map retrieveFullAnswerMap(String licenseId, Map answerMap) { return retrieveFullAnswerMap(licenseId, defaultLanguage, answerMap); } @@ -542,6 +587,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi * @param answerMap - the answers to the different field questions * @return the answerMap supplemented with all other license fields with a blank answer for the provided language */ + @Override public Map retrieveFullAnswerMap(String licenseId, String language, Map answerMap) { CCLicense ccLicense = findOne(licenseId, language); if (ccLicense == null) { diff --git a/dspace-api/src/main/java/org/dspace/license/LicenseMetadataValue.java b/dspace-api/src/main/java/org/dspace/license/LicenseMetadataValue.java index ec5c9e447b..6c1d27d381 100644 --- a/dspace-api/src/main/java/org/dspace/license/LicenseMetadataValue.java +++ b/dspace-api/src/main/java/org/dspace/license/LicenseMetadataValue.java @@ -18,6 +18,8 @@ import org.dspace.content.MetadataValue; import org.dspace.content.factory.ContentServiceFactory; import org.dspace.content.service.ItemService; import org.dspace.core.Context; +import org.dspace.license.factory.LicenseServiceFactory; +import org.dspace.license.service.CreativeCommonsService; /** * Helper class for using CC-related Metadata fields @@ -27,6 +29,7 @@ import org.dspace.core.Context; public class LicenseMetadataValue { protected final ItemService itemService; + protected final CreativeCommonsService creativeCommonsService; // Shibboleth for Creative Commons license data - i.e. characters that reliably indicate CC in a URI protected static final String ccShib = "creativecommons"; @@ -41,6 +44,7 @@ public class LicenseMetadataValue { params[3] = Item.ANY; } itemService = ContentServiceFactory.getInstance().getItemService(); + creativeCommonsService = LicenseServiceFactory.getInstance().getCreativeCommonsService(); } /** diff --git a/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java b/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java index cda546246f..3225393248 100644 --- a/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java +++ b/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java @@ -86,6 +86,24 @@ public interface CreativeCommonsService { public String getLicenseURL(Context context, Item item) throws SQLException, IOException, AuthorizeException; + + /** + * Returns the stored license uri of the item + * + * @param item - The item for which to retrieve the stored license uri + * @return the stored license uri of the item + */ + public String getLicenseURI(Item item); + + /** + * Returns the stored license name of the item + * + * @param item - The item for which to retrieve the stored license name + * @return the stored license name of the item + */ + public String getLicenseName(Item item); + + public String getLicenseRDF(Context context, Item item) throws SQLException, IOException, AuthorizeException; @@ -124,7 +142,7 @@ public interface CreativeCommonsService { * @param fieldId name of the property. * @return its value. */ - public LicenseMetadataValue getCCField(String fieldId); + public String getCCField(String fieldId); /** * Apply same transformation on the document to retrieve only the most diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/step/DataCCLicense.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/step/DataCCLicense.java new file mode 100644 index 0000000000..a8cfaf64f5 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/step/DataCCLicense.java @@ -0,0 +1,44 @@ +/** + * 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.rest.model.step; + +import org.dspace.app.rest.model.BitstreamRest; + + +public class DataCCLicense implements SectionData { + + private String uri; + + private String rights; + + private BitstreamRest file; + + public String getUri() { + return uri; + } + + public void setUri(final String uri) { + this.uri = uri; + } + + public String getRights() { + return rights; + } + + public void setRights(final String rights) { + this.rights = rights; + } + + public BitstreamRest getFile() { + return file; + } + + public void setFile(final BitstreamRest file) { + this.file = file; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/AbstractRestProcessingStep.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/AbstractRestProcessingStep.java index 58bfaba27b..9989f6ca07 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/AbstractRestProcessingStep.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/AbstractRestProcessingStep.java @@ -35,6 +35,7 @@ public interface AbstractRestProcessingStep extends ListenerProcessingStep { public static final String UPLOAD_STEP_MOVE_OPERATION_ENTRY = "bitstreammove"; public static final String UPLOAD_STEP_ACCESSCONDITIONS_OPERATION_ENTRY = "accessConditions"; public static final String LICENSE_STEP_OPERATION_ENTRY = "granted"; + public static final String CCLICENSE_STEP_OPERATION_ENTRY = "ccLicense"; public static final String UPLOAD_STEP_METADATA_PATH = "metadata"; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/SubmissionService.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/SubmissionService.java index 2840035a7a..660c360f33 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/SubmissionService.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/SubmissionService.java @@ -25,6 +25,7 @@ import org.dspace.app.rest.model.CheckSumRest; import org.dspace.app.rest.model.MetadataValueRest; import org.dspace.app.rest.model.UploadBitstreamAccessConditionDTO; import org.dspace.app.rest.model.WorkspaceItemRest; +import org.dspace.app.rest.model.step.DataCCLicense; import org.dspace.app.rest.model.step.DataUpload; import org.dspace.app.rest.model.step.UploadBitstreamRest; import org.dspace.app.rest.projection.Projection; @@ -33,6 +34,8 @@ import org.dspace.authorize.AuthorizeException; import org.dspace.authorize.ResourcePolicy; import org.dspace.content.Bitstream; import org.dspace.content.Collection; +import org.dspace.content.InProgressSubmission; +import org.dspace.content.Item; import org.dspace.content.MetadataValue; import org.dspace.content.WorkspaceItem; import org.dspace.content.service.CollectionService; @@ -41,6 +44,7 @@ import org.dspace.content.service.WorkspaceItemService; import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.core.Utils; +import org.dspace.license.service.CreativeCommonsService; import org.dspace.services.ConfigurationService; import org.dspace.services.RequestService; import org.dspace.services.model.Request; @@ -75,6 +79,8 @@ public class SubmissionService { @Autowired protected WorkflowService workflowService; @Autowired + protected CreativeCommonsService creativeCommonsService; + @Autowired private RequestService requestService; @Autowired private ConverterService converter; @@ -84,10 +90,8 @@ public class SubmissionService { /** * Create a workspaceitem using the information in the request * - * @param context - * the dspace context - * @param request - * the request containing the details about the workspace to create + * @param context the dspace context + * @param request the request containing the details about the workspace to create * @return * @throws SQLException * @throws AuthorizeException @@ -136,19 +140,19 @@ public class SubmissionService { } } -/** - * Build the rest representation of a bitstream as used in the upload section - * ({@link DataUpload}. It contains all its metadata and the list of applied - * access conditions (@link {@link UploadBitstreamAccessConditionDTO} - * - * @param configurationService the DSpace ConfigurationService - * @param source the bitstream to translate in its rest submission - * representation - * @return - * @throws SQLException - */ + /** + * Build the rest representation of a bitstream as used in the upload section + * ({@link DataUpload}. It contains all its metadata and the list of applied + * access conditions (@link {@link UploadBitstreamAccessConditionDTO} + * + * @param configurationService the DSpace ConfigurationService + * @param source the bitstream to translate in its rest submission + * representation + * @return + * @throws SQLException + */ public UploadBitstreamRest buildUploadBitstream(ConfigurationService configurationService, Bitstream source) - throws SQLException { + throws SQLException { UploadBitstreamRest data = new UploadBitstreamRest(); for (MetadataValue md : source.getMetadata()) { @@ -242,7 +246,7 @@ public class SubmissionService { wi = workflowService.start(context, wsi); } catch (IOException e) { throw new RuntimeException("The workflow could not be started for workspaceItem with" + - "id: " + id); + "id: " + id); } return wi; @@ -268,4 +272,18 @@ public class SubmissionService { public void saveWorkflowItem(Context context, XmlWorkflowItem source) throws SQLException, AuthorizeException { workflowItemService.update(context, source); } + + public DataCCLicense getDataCCLicense(InProgressSubmission obj) + throws SQLException, IOException, AuthorizeException { + DataCCLicense result = new DataCCLicense(); + Item item = obj.getItem(); + + result.setUri(creativeCommonsService.getLicenseURI(item)); + result.setRights(creativeCommonsService.getLicenseName(item)); + + Bitstream licenseRdfBitstream = creativeCommonsService.getLicenseRdfBitstream(item); + result.setFile(converter.toRest(licenseRdfBitstream, Projection.DEFAULT)); + + return result; + } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/step/CCLicenseStep.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/step/CCLicenseStep.java new file mode 100644 index 0000000000..4dcc319a3d --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/step/CCLicenseStep.java @@ -0,0 +1,44 @@ +/** + * 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.rest.submit.step; + +import org.dspace.app.rest.model.patch.Operation; +import org.dspace.app.rest.model.step.DataCCLicense; +import org.dspace.app.rest.submit.AbstractRestProcessingStep; +import org.dspace.app.rest.submit.SubmissionService; +import org.dspace.app.rest.submit.factory.PatchOperationFactory; +import org.dspace.app.rest.submit.factory.impl.PatchOperation; +import org.dspace.app.util.SubmissionStepConfig; +import org.dspace.content.InProgressSubmission; +import org.dspace.core.Context; +import org.dspace.services.model.Request; + + +public class CCLicenseStep extends org.dspace.submit.step.CCLicenseStep implements AbstractRestProcessingStep { + + @Override + public DataCCLicense getData(SubmissionService submissionService, InProgressSubmission obj, + SubmissionStepConfig config) + throws Exception { + return submissionService.getDataCCLicense(obj); + } + + + @Override + public void doPatchProcessing(Context context, Request currentRequest, InProgressSubmission source, Operation op) + throws Exception { + + if (op.getPath().endsWith(CCLICENSE_STEP_OPERATION_ENTRY)) { + + PatchOperation patchOperation = new PatchOperationFactory() + .instanceOf(CCLICENSE_STEP_OPERATION_ENTRY, op.getOp()); + patchOperation.perform(context, currentRequest, source, op); + + } + } +} diff --git a/dspace/config/item-submission.xml b/dspace/config/item-submission.xml index af707162ae..d1f755d293 100644 --- a/dspace/config/item-submission.xml +++ b/dspace/config/item-submission.xml @@ -115,9 +115,9 @@ - + submit.progressbar.CClicense + org.dspace.app.rest.submit.step.CCLicenseStep + cclicense + + From 5800bef325d38876b383fad6941a273e38069c4c Mon Sep 17 00:00:00 2001 From: Yana De Pauw Date: Fri, 17 Apr 2020 13:13:40 +0200 Subject: [PATCH 032/125] 70403: Add javadocs, undo line adjustments, LicenseMetadataValue changes --- .../dspace/license/LicenseMetadataValue.java | 4 ---- .../app/rest/model/step/DataCCLicense.java | 4 +++- .../app/rest/submit/SubmissionService.java | 15 ++++++++++-- .../app/rest/submit/step/CCLicenseStep.java | 23 ++++++++++++++++++- 4 files changed, 38 insertions(+), 8 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/license/LicenseMetadataValue.java b/dspace-api/src/main/java/org/dspace/license/LicenseMetadataValue.java index 6c1d27d381..ec5c9e447b 100644 --- a/dspace-api/src/main/java/org/dspace/license/LicenseMetadataValue.java +++ b/dspace-api/src/main/java/org/dspace/license/LicenseMetadataValue.java @@ -18,8 +18,6 @@ import org.dspace.content.MetadataValue; import org.dspace.content.factory.ContentServiceFactory; import org.dspace.content.service.ItemService; import org.dspace.core.Context; -import org.dspace.license.factory.LicenseServiceFactory; -import org.dspace.license.service.CreativeCommonsService; /** * Helper class for using CC-related Metadata fields @@ -29,7 +27,6 @@ import org.dspace.license.service.CreativeCommonsService; public class LicenseMetadataValue { protected final ItemService itemService; - protected final CreativeCommonsService creativeCommonsService; // Shibboleth for Creative Commons license data - i.e. characters that reliably indicate CC in a URI protected static final String ccShib = "creativecommons"; @@ -44,7 +41,6 @@ public class LicenseMetadataValue { params[3] = Item.ANY; } itemService = ContentServiceFactory.getInstance().getItemService(); - creativeCommonsService = LicenseServiceFactory.getInstance().getCreativeCommonsService(); } /** diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/step/DataCCLicense.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/step/DataCCLicense.java index a8cfaf64f5..32b3710d7c 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/step/DataCCLicense.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/step/DataCCLicense.java @@ -9,7 +9,9 @@ package org.dspace.app.rest.model.step; import org.dspace.app.rest.model.BitstreamRest; - +/** + * Java Bean to expose the section creativecommons representing the CC License during in progress submission. + */ public class DataCCLicense implements SectionData { private String uri; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/SubmissionService.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/SubmissionService.java index 660c360f33..0ac468448b 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/SubmissionService.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/SubmissionService.java @@ -90,8 +90,10 @@ public class SubmissionService { /** * Create a workspaceitem using the information in the request * - * @param context the dspace context - * @param request the request containing the details about the workspace to create + * @param context + * the dspace context + * @param request + * the request containing the details about the workspace to create * @return * @throws SQLException * @throws AuthorizeException @@ -273,6 +275,15 @@ public class SubmissionService { workflowItemService.update(context, source); } + /** + * Builds the CC License data of an inprogress submission based on the cc license info present in the metadata + * + * @param obj - the in progress submission + * @return an object representing the CC License data + * @throws SQLException + * @throws IOException + * @throws AuthorizeException + */ public DataCCLicense getDataCCLicense(InProgressSubmission obj) throws SQLException, IOException, AuthorizeException { DataCCLicense result = new DataCCLicense(); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/step/CCLicenseStep.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/step/CCLicenseStep.java index 4dcc319a3d..75f1949116 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/step/CCLicenseStep.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/step/CCLicenseStep.java @@ -18,9 +18,21 @@ import org.dspace.content.InProgressSubmission; import org.dspace.core.Context; import org.dspace.services.model.Request; - +/** + * CC License step for DSpace Spring Rest. Expose the creative commons license information about the in progress + * submission. + */ public class CCLicenseStep extends org.dspace.submit.step.CCLicenseStep implements AbstractRestProcessingStep { + /** + * Retrieves the CC License data of the in progress submission + * + * @param submissionService the submission service + * @param obj the in progress submission + * @param config the submission step configuration + * @return the CC License data of the in progress submission + * @throws Exception + */ @Override public DataCCLicense getData(SubmissionService submissionService, InProgressSubmission obj, SubmissionStepConfig config) @@ -29,6 +41,15 @@ public class CCLicenseStep extends org.dspace.submit.step.CCLicenseStep implemen } + /** + * Processes a patch for the CC License data + * + * @param context the DSpace context + * @param currentRequest the http request + * @param source the in progress submission + * @param op the json patch operation + * @throws Exception + */ @Override public void doPatchProcessing(Context context, Request currentRequest, InProgressSubmission source, Operation op) throws Exception { From 0920de7b21e7f5ccb6d88ae2128e6b533e0910bd Mon Sep 17 00:00:00 2001 From: Yana De Pauw Date: Mon, 20 Apr 2020 12:57:49 +0200 Subject: [PATCH 033/125] 70404: CC license (REST): Patch submission (Add) --- .../license/CCLicenseConnectorService.java | 21 ++++ .../CCLicenseConnectorServiceImpl.java | 55 +++++++- .../license/CreativeCommonsServiceImpl.java | 118 ++++++++++++++++-- .../service/CreativeCommonsService.java | 44 ++++++- .../submit/AbstractRestProcessingStep.java | 2 +- .../impl/CCLicenseAddPatchOperation.java | 66 ++++++++++ .../spring/spring-dspace-core-services.xml | 4 + dspace/config/item-submission.xml | 4 +- 8 files changed, 296 insertions(+), 18 deletions(-) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/factory/impl/CCLicenseAddPatchOperation.java diff --git a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorService.java b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorService.java index 48ed5f7200..0c061d2d64 100644 --- a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorService.java +++ b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorService.java @@ -7,8 +7,11 @@ */ package org.dspace.license; +import java.io.IOException; import java.util.Map; +import org.jdom.Document; + /** * Service interface class for the Creative commons license connector service. * The implementation of this class is responsible for all the calls to the CC license API and parsing the response @@ -27,6 +30,7 @@ public interface CCLicenseConnectorService { /** * 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 @@ -36,4 +40,21 @@ public interface CCLicenseConnectorService { String language, Map answerMap); + /** + * 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 + */ + public Document retrieveLicenseRDFDoc(String licenseURI) throws IOException; + + /** + * 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); + } diff --git a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java index 7fedc7e2e1..9813a5c31b 100644 --- a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java @@ -8,7 +8,11 @@ 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; @@ -31,6 +35,7 @@ import org.dspace.services.ConfigurationService; import org.jaxen.JaxenException; import org.jaxen.jdom.JDOMXPath; import org.jdom.Attribute; +import org.jdom.Document; import org.jdom.Element; import org.jdom.JDOMException; import org.jdom.input.SAXBuilder; @@ -237,6 +242,7 @@ public class CCLicenseConnectorServiceImpl implements CCLicenseConnectorService, /** * 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 @@ -273,7 +279,7 @@ public class CCLicenseConnectorServiceImpl implements CCLicenseConnectorService, /** * 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 + * @param response for a specific CC License URI response * @return the corresponding CC License URI as a string * @throws IOException * @throws JaxenException @@ -314,5 +320,52 @@ public class CCLicenseConnectorServiceImpl implements CCLicenseConnectorService, 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) { + try { + return getSingleNodeValue(doc, "//result/license-uri"); + } catch (JaxenException e) { + log.error("Error while retrieving the license name from the license document", e); + } + return null; + } } diff --git a/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java b/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java index 928e4b6891..a1077af1ef 100644 --- a/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java @@ -181,8 +181,17 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi } + /** + * Removes the license file from the item + * + * @param context - The relevant DSpace Context + * @param item - The item from which the license file needs to be removed + * @throws SQLException + * @throws IOException + * @throws AuthorizeException + */ @Override - public void removeLicense(Context context, Item item) + public void removeLicenseFile(Context context, Item item) throws SQLException, IOException, AuthorizeException { // remove CC license bundle if one exists List bundles = itemService.getBundles(item, CC_BUNDLE_NAME); @@ -414,24 +423,49 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi return configurationService.getProperty("cc.license." + fieldId); } + /** + * Remove license information, delete also the bitstream + * + * @param context - DSpace Context + * @param item - the item + * @throws AuthorizeException Exception indicating the current user of the context does not have permission + * to perform a particular action. + * @throws IOException A general class of exceptions produced by failed or interrupted I/O operations. + * @throws SQLException An exception that provides information on a database access error or other errors. + */ @Override - public void removeLicense(Context context, LicenseMetadataValue uriField, - LicenseMetadataValue nameField, Item item) + public void removeLicense(Context context, Item item) throws AuthorizeException, IOException, SQLException { + + String uriField = getCCField("uri"); + String nameField = getCCField("name"); + + String licenseUri = itemService.getMetadata(item, uriField); + // only remove any previous licenses - String licenseUri = uriField.ccItemValue(item); if (licenseUri != null) { - uriField.removeItemValue(context, item, licenseUri); + removeLicenseField(context, item, uriField); if (configurationService.getBooleanProperty("cc.submit.setname")) { - String licenseName = nameField.keyedItemValue(item, licenseUri); - nameField.removeItemValue(context, item, licenseName); + removeLicenseField(context, item, nameField); } if (configurationService.getBooleanProperty("cc.submit.addbitstream")) { - removeLicense(context, item); + removeLicenseFile(context, item); } } } + private void removeLicenseField(Context context, Item item, String field) throws SQLException { + String[] params = splitField(field); + itemService.clearMetadata(context, item, params[0], params[1], params[2], params[3]); + + } + + private void addLicenseField(Context context, Item item, String field, String value) throws SQLException { + String[] params = splitField(field); + itemService.addMetadata(context, item, params[0], params[1], params[2], params[3], value); + + } + /** * Find all CC Licenses using the default language found in the configuration * @@ -623,4 +657,72 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi return null; } + /** + * Update the license of the item with a new one based on the provided license URI + * + * @param context - The relevant DSpace context + * @param licenseUri - The license URI to be used in the update + * @param item - The item for which to update the license + * @return true when the update was successful, false when not + * @throws AuthorizeException + * @throws SQLException + */ + @Override + public boolean updateLicense(final Context context, final String licenseUri, final Item item) + throws AuthorizeException, SQLException { + try { + Document doc = ccLicenseConnectorService.retrieveLicenseRDFDoc(licenseUri); + String licenseName = ccLicenseConnectorService.retrieveLicenseName(doc); + if (StringUtils.isBlank(licenseName)) { + return false; + } + + removeLicense(context, item); + addLicense(context, item, licenseUri, licenseName, doc); + + return true; + + } catch (IOException e) { + log.error("Error while updating the license of item: " + item.getID(), e); + } + return false; + } + + /** + * Add a new license to the item + * + * @param context - The relevant Dspace context + * @param item - The item to which the license will be added + * @param licenseUri - The license URI to add + * @param licenseName - The license name to add + * @param doc - The license to document to add + * @throws SQLException + * @throws IOException + * @throws AuthorizeException + */ + @Override + public void addLicense(Context context, Item item, String licenseUri, String licenseName, Document doc) + throws SQLException, IOException, AuthorizeException { + String uriField = getCCField("uri"); + String nameField = getCCField("name"); + + addLicenseField(context, item, uriField, licenseUri); + if (configurationService.getBooleanProperty("cc.submit.addbitstream")) { + setLicenseRDF(context, item, fetchLicenseRDF(doc)); + } + if (configurationService.getBooleanProperty("cc.submit.setname")) { + addLicenseField(context, item, nameField, licenseName); + } + } + + private String[] splitField(String fieldName) { + String[] params = new String[4]; + String[] fParams = fieldName.split("\\."); + for (int i = 0; i < fParams.length; i++) { + params[i] = fParams[i]; + } + params[3] = Item.ANY; + return params; + } + } diff --git a/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java b/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java index 3225393248..c5ea6475bb 100644 --- a/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java +++ b/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java @@ -18,7 +18,6 @@ import org.dspace.content.Bitstream; import org.dspace.content.Item; import org.dspace.core.Context; import org.dspace.license.CCLicense; -import org.dspace.license.LicenseMetadataValue; import org.jdom.Document; /** @@ -77,7 +76,16 @@ public interface CreativeCommonsService { InputStream licenseStm, String mimeType) throws SQLException, IOException, AuthorizeException; - public void removeLicense(Context context, Item item) + /** + * Removes the license file from the item + * + * @param context - The relevant DSpace Context + * @param item - The item from which the license file needs to be removed + * @throws SQLException + * @throws IOException + * @throws AuthorizeException + */ + public void removeLicenseFile(Context context, Item item) throws SQLException, IOException, AuthorizeException; public boolean hasLicense(Context context, Item item) @@ -159,16 +167,13 @@ public interface CreativeCommonsService { * Remove license information, delete also the bitstream * * @param context - DSpace Context - * @param uriField - the metadata field for license uri - * @param nameField - the metadata field for license name * @param item - the item * @throws AuthorizeException Exception indicating the current user of the context does not have permission * to perform a particular action. * @throws IOException A general class of exceptions produced by failed or interrupted I/O operations. * @throws SQLException An exception that provides information on a database access error or other errors. */ - public void removeLicense(Context context, LicenseMetadataValue uriField, - LicenseMetadataValue nameField, Item item) + public void removeLicense(Context context, Item item) throws AuthorizeException, IOException, SQLException; /** @@ -265,4 +270,31 @@ public interface CreativeCommonsService { */ public boolean verifyLicenseInformation(String licenseId, String language, Map fullAnswerMap); + /** + * Update the license of the item with a new one based on the provided license URI + * + * @param context - The relevant DSpace context + * @param licenseUri - The license URI to be used in the update + * @param item - The item for which to update the license + * @return true when the update was successful, false when not + * @throws AuthorizeException + * @throws SQLException + */ + public boolean updateLicense(final Context context, String licenseUri, final Item item) + throws AuthorizeException, SQLException; + + /** + * Add a new license to the item + * + * @param context - The relevant Dspace context + * @param item - The item to which the license will be added + * @param licenseUri - The license URI to add + * @param licenseName - The license name to add + * @param doc - The license to document to add + * @throws SQLException + * @throws IOException + * @throws AuthorizeException + */ + public void addLicense(Context context, Item item, String licenseUri, String licenseName, Document doc) + throws SQLException, IOException, AuthorizeException; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/AbstractRestProcessingStep.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/AbstractRestProcessingStep.java index 9989f6ca07..2dea6a2ce5 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/AbstractRestProcessingStep.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/AbstractRestProcessingStep.java @@ -35,7 +35,7 @@ public interface AbstractRestProcessingStep extends ListenerProcessingStep { public static final String UPLOAD_STEP_MOVE_OPERATION_ENTRY = "bitstreammove"; public static final String UPLOAD_STEP_ACCESSCONDITIONS_OPERATION_ENTRY = "accessConditions"; public static final String LICENSE_STEP_OPERATION_ENTRY = "granted"; - public static final String CCLICENSE_STEP_OPERATION_ENTRY = "ccLicense"; + public static final String CCLICENSE_STEP_OPERATION_ENTRY = "cclicense/uri"; public static final String UPLOAD_STEP_METADATA_PATH = "metadata"; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/factory/impl/CCLicenseAddPatchOperation.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/factory/impl/CCLicenseAddPatchOperation.java new file mode 100644 index 0000000000..46a0f5ce95 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/factory/impl/CCLicenseAddPatchOperation.java @@ -0,0 +1,66 @@ +/** + * 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.rest.submit.factory.impl; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.content.InProgressSubmission; +import org.dspace.content.Item; +import org.dspace.core.Context; +import org.dspace.license.service.CreativeCommonsService; +import org.dspace.services.model.Request; +import org.springframework.beans.factory.annotation.Autowired; + + +/** + * Submission "add" PATCH operation + * + * To add or update the Creative Commons License of a workspace item. + * When the item already has a Creative Commons License, the license will be replaced with a new one. + * + * Example: + * curl -X PATCH http://${dspace.server.url}/api/submission/workspaceitems/31599 -H "Content-Type: + * application/json" -d '[{ "op": "add", "path": "/sections/cclicense/uri", + * "value":"http://creativecommons.org/licenses/by-nc-sa/3.0/us/"}]' + * + * + */ +public class CCLicenseAddPatchOperation extends AddPatchOperation { + + @Autowired + CreativeCommonsService creativeCommonsService; + + @Override + protected Class getArrayClassForEvaluation() { + return String[].class; + } + + @Override + protected Class getClassForEvaluation() { + return String.class; + } + + @Override + void add(Context context, Request currentRequest, InProgressSubmission source, String path, Object value) + throws Exception { + + + String licenseUri = null; + if (value instanceof String) { + licenseUri = (String) value; + } + + if (StringUtils.isBlank(licenseUri)) { + throw new IllegalArgumentException( + "Value is not a valid license URI"); + } + + Item item = source.getItem(); + creativeCommonsService.updateLicense(context, licenseUri, item); + } + +} diff --git a/dspace-server-webapp/src/main/resources/spring/spring-dspace-core-services.xml b/dspace-server-webapp/src/main/resources/spring/spring-dspace-core-services.xml index 61459f11d6..2b37ea5bdd 100644 --- a/dspace-server-webapp/src/main/resources/spring/spring-dspace-core-services.xml +++ b/dspace-server-webapp/src/main/resources/spring/spring-dspace-core-services.xml @@ -52,6 +52,10 @@ + + + diff --git a/dspace/config/item-submission.xml b/dspace/config/item-submission.xml index d1f755d293..481b508176 100644 --- a/dspace/config/item-submission.xml +++ b/dspace/config/item-submission.xml @@ -115,7 +115,7 @@ - submit.progressbar.CClicense + submit.progressbar.CClicense org.dspace.app.rest.submit.step.CCLicenseStep cclicense @@ -203,7 +203,7 @@ - + From 09c0f62561795f3fefd22cac929d1cc9e6036f21 Mon Sep 17 00:00:00 2001 From: Yana De Pauw Date: Wed, 22 Apr 2020 14:39:53 +0200 Subject: [PATCH 034/125] 70505: Patch submission (Add): Bugfixing & tests --- .../CCLicenseConnectorServiceImpl.java | 4 +- .../license/CreativeCommonsServiceImpl.java | 3 + .../dspaceFolder/config/item-submission.xml | 8 +- .../MockCCLicenseConnectorServiceImpl.java | 32 +++++- .../impl/CCLicenseAddPatchOperation.java | 11 ++- .../rest/CCLicenseAddPatchOperationIT.java | 99 +++++++++++++++++++ .../SubmissionDefinitionsControllerIT.java | 2 +- .../MockCCLicenseConnectorServiceImpl.java | 31 ++++++ .../org/dspace/license/cc-license-rdf.xml | 31 ++++++ 9 files changed, 209 insertions(+), 12 deletions(-) create mode 100644 dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseAddPatchOperationIT.java create mode 100644 dspace-server-webapp/src/test/resources/org/dspace/license/cc-license-rdf.xml diff --git a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java index 9813a5c31b..a237a91984 100644 --- a/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/license/CCLicenseConnectorServiceImpl.java @@ -52,7 +52,7 @@ public class CCLicenseConnectorServiceImpl implements CCLicenseConnectorService, private Logger log = org.apache.logging.log4j.LogManager.getLogger(CCLicenseConnectorServiceImpl.class); private CloseableHttpClient client; - private SAXBuilder parser = new SAXBuilder(); + protected SAXBuilder parser = new SAXBuilder(); private String postArgument = "answers"; private String postAnswerFormat = @@ -361,7 +361,7 @@ public class CCLicenseConnectorServiceImpl implements CCLicenseConnectorService, */ public String retrieveLicenseName(final Document doc) { try { - return getSingleNodeValue(doc, "//result/license-uri"); + return getSingleNodeValue(doc, "//result/license-name"); } catch (JaxenException e) { log.error("Error while retrieving the license name from the license document", e); } diff --git a/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java b/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java index a1077af1ef..67a9e4e06d 100644 --- a/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java @@ -672,6 +672,9 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi throws AuthorizeException, SQLException { try { Document doc = ccLicenseConnectorService.retrieveLicenseRDFDoc(licenseUri); + if (doc == null) { + return false; + } String licenseName = ccLicenseConnectorService.retrieveLicenseName(doc); if (StringUtils.isBlank(licenseName)) { return false; diff --git a/dspace-api/src/test/data/dspaceFolder/config/item-submission.xml b/dspace-api/src/test/data/dspaceFolder/config/item-submission.xml index de19ef7287..d78b14c437 100644 --- a/dspace-api/src/test/data/dspaceFolder/config/item-submission.xml +++ b/dspace-api/src/test/data/dspaceFolder/config/item-submission.xml @@ -82,9 +82,9 @@ - + submit.progressbar.CClicense + org.dspace.app.rest.submit.step.CCLicenseStep + cclicense - + diff --git a/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java b/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java index 226e2aa77b..41cd9805f6 100644 --- a/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java +++ b/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java @@ -7,11 +7,17 @@ */ package org.dspace.license; +import java.io.IOException; +import java.io.InputStream; import java.util.HashMap; import java.util.LinkedList; import java.util.List; import java.util.Map; +import org.apache.commons.lang3.StringUtils; +import org.jdom.Document; +import org.jdom.JDOMException; + /** * Mock implementation for the Creative commons license connector service. * This class will return a structure of CC Licenses similar to the CC License API but without having to contact it @@ -20,7 +26,6 @@ public class MockCCLicenseConnectorServiceImpl extends CCLicenseConnectorService /** * Retrieves mock CC Licenses for the provided language - * * @param language - the language * @return a map of mocked licenses with the id and the license */ @@ -90,4 +95,29 @@ public class MockCCLicenseConnectorServiceImpl extends CCLicenseConnectorService return "mock-license-uri"; } + + /** + * Retrieve a mock license RDF document. + * When the uri contains "invalid", null will be returned to simulate that no document was found for the provided + * URI + * + * @param licenseURI - The license URI for which to retrieve the license RDF document + * @return a mock license RDF document or null when the URI contains invalid + * @throws IOException + */ + public Document retrieveLicenseRDFDoc(String licenseURI) throws IOException { + if (!StringUtils.contains(licenseURI, "invalid")) { + try { + + InputStream cclicense = getClass().getResourceAsStream("cc-license-rdf.xml"); + + Document doc = parser.build(cclicense); + return doc; + } catch (JDOMException e) { + e.printStackTrace(); + } + } + return null; + } + } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/factory/impl/CCLicenseAddPatchOperation.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/factory/impl/CCLicenseAddPatchOperation.java index 46a0f5ce95..e3286551d5 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/factory/impl/CCLicenseAddPatchOperation.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/factory/impl/CCLicenseAddPatchOperation.java @@ -27,7 +27,6 @@ import org.springframework.beans.factory.annotation.Autowired; * application/json" -d '[{ "op": "add", "path": "/sections/cclicense/uri", * "value":"http://creativecommons.org/licenses/by-nc-sa/3.0/us/"}]' * - * */ public class CCLicenseAddPatchOperation extends AddPatchOperation { @@ -46,7 +45,7 @@ public class CCLicenseAddPatchOperation extends AddPatchOperation { @Override void add(Context context, Request currentRequest, InProgressSubmission source, String path, Object value) - throws Exception { + throws Exception { String licenseUri = null; @@ -56,11 +55,15 @@ public class CCLicenseAddPatchOperation extends AddPatchOperation { if (StringUtils.isBlank(licenseUri)) { throw new IllegalArgumentException( - "Value is not a valid license URI"); + "Value is not a valid license URI"); } Item item = source.getItem(); - creativeCommonsService.updateLicense(context, licenseUri, item); + boolean updateLicense = creativeCommonsService.updateLicense(context, licenseUri, item); + if (!updateLicense) { + throw new IllegalArgumentException("The license uri: " + licenseUri + ", could not be resolved to a " + + "CC license"); + } } } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseAddPatchOperationIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseAddPatchOperationIT.java new file mode 100644 index 0000000000..ba58e5f489 --- /dev/null +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseAddPatchOperationIT.java @@ -0,0 +1,99 @@ +/** + * 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.rest; + +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.patch; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +import java.util.ArrayList; +import java.util.List; +import javax.ws.rs.core.MediaType; + +import org.dspace.app.rest.builder.CollectionBuilder; +import org.dspace.app.rest.builder.CommunityBuilder; +import org.dspace.app.rest.builder.WorkspaceItemBuilder; +import org.dspace.app.rest.model.patch.AddOperation; +import org.dspace.app.rest.model.patch.Operation; +import org.dspace.app.rest.test.AbstractControllerIntegrationTest; +import org.dspace.content.Collection; +import org.dspace.content.Community; +import org.dspace.content.WorkspaceItem; +import org.junit.Test; + +/** + * Class to the methods from the CCLicenseAddPatchOperation + * Since the CC Licenses are obtained from the CC License API, a mock service has been implemented + * This mock service will return a fixed set of CC Licenses using a similar structure to the ones obtained from the + * CC License API. + * Refer to {@link org.dspace.license.MockCCLicenseConnectorServiceImpl} for more information + */ +public class CCLicenseAddPatchOperationIT extends AbstractControllerIntegrationTest { + + + @Test + public void patchSubmissionCCLicense() throws Exception { + context.turnOffAuthorisationSystem(); + + Community community = CommunityBuilder.createCommunity(context) + .withName("Community") + .build(); + + Collection collection = CollectionBuilder.createCollection(context, community) + .withName("Collection") + .build(); + + WorkspaceItem workspaceItem = WorkspaceItemBuilder.createWorkspaceItem(context, collection) + .withTitle("Workspace Item") + .build(); + + String adminToken = getAuthToken(admin.getEmail(), password); + + List ops = new ArrayList(); + AddOperation addOperation = new AddOperation("/sections/cclicense/uri", "license-uri"); + + ops.add(addOperation); + String patchBody = getPatchContent(ops); + + + getClient(adminToken).perform(patch("/api/submission/workspaceitems/" + workspaceItem.getID()) + .content(patchBody) + .contentType(MediaType.APPLICATION_JSON_PATCH_JSON)) + .andExpect(status().isOk()); + } + + @Test + public void patchSubmissionCCLicenseInvalid() throws Exception { + context.turnOffAuthorisationSystem(); + + Community community = CommunityBuilder.createCommunity(context) + .withName("Community") + .build(); + + Collection collection = CollectionBuilder.createCollection(context, community) + .withName("Collection") + .build(); + + WorkspaceItem workspaceItem = WorkspaceItemBuilder.createWorkspaceItem(context, collection) + .withTitle("Workspace Item") + .build(); + + String adminToken = getAuthToken(admin.getEmail(), password); + + List ops = new ArrayList(); + AddOperation addOperation = new AddOperation("/sections/cclicense/uri", "invalid-license-uri"); + + ops.add(addOperation); + String patchBody = getPatchContent(ops); + + + getClient(adminToken).perform(patch("/api/submission/workspaceitems/" + workspaceItem.getID()) + .content(patchBody) + .contentType(MediaType.APPLICATION_JSON_PATCH_JSON)) + .andExpect(status().isInternalServerError()); + } +} diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionDefinitionsControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionDefinitionsControllerIT.java index 38d22fdf04..dbee267740 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionDefinitionsControllerIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionDefinitionsControllerIT.java @@ -204,7 +204,7 @@ public class SubmissionDefinitionsControllerIT extends AbstractControllerIntegra // We expect the content type to be "application/hal+json;charset=UTF-8" .andExpect(content().contentType(contentType)) // Match only that a section exists with a submission configuration behind - .andExpect(jsonPath("$._embedded.submissionsections", hasSize(5))) + .andExpect(jsonPath("$._embedded.submissionsections", hasSize(6))) .andExpect(jsonPath("$._embedded.submissionsections", Matchers.hasItem( allOf( diff --git a/dspace-server-webapp/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java b/dspace-server-webapp/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java index 23d395ec2b..41cd9805f6 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java +++ b/dspace-server-webapp/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java @@ -7,11 +7,17 @@ */ package org.dspace.license; +import java.io.IOException; +import java.io.InputStream; import java.util.HashMap; import java.util.LinkedList; import java.util.List; import java.util.Map; +import org.apache.commons.lang3.StringUtils; +import org.jdom.Document; +import org.jdom.JDOMException; + /** * Mock implementation for the Creative commons license connector service. * This class will return a structure of CC Licenses similar to the CC License API but without having to contact it @@ -89,4 +95,29 @@ public class MockCCLicenseConnectorServiceImpl extends CCLicenseConnectorService return "mock-license-uri"; } + + /** + * Retrieve a mock license RDF document. + * When the uri contains "invalid", null will be returned to simulate that no document was found for the provided + * URI + * + * @param licenseURI - The license URI for which to retrieve the license RDF document + * @return a mock license RDF document or null when the URI contains invalid + * @throws IOException + */ + public Document retrieveLicenseRDFDoc(String licenseURI) throws IOException { + if (!StringUtils.contains(licenseURI, "invalid")) { + try { + + InputStream cclicense = getClass().getResourceAsStream("cc-license-rdf.xml"); + + Document doc = parser.build(cclicense); + return doc; + } catch (JDOMException e) { + e.printStackTrace(); + } + } + return null; + } + } diff --git a/dspace-server-webapp/src/test/resources/org/dspace/license/cc-license-rdf.xml b/dspace-server-webapp/src/test/resources/org/dspace/license/cc-license-rdf.xml new file mode 100644 index 0000000000..5ff75ee4c7 --- /dev/null +++ b/dspace-server-webapp/src/test/resources/org/dspace/license/cc-license-rdf.xml @@ -0,0 +1,31 @@ + + + http://creativecommons.org/licenses/by-nc-sa/4.0/ + Attribution-NonCommercial-ShareAlike 4.0 International + false + + + + + + + + + + + + + + + + + + + + + + + + + Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. + From a27b64c88f98732b3c4db7b62567ef6078f82ba5 Mon Sep 17 00:00:00 2001 From: Yana De Pauw Date: Wed, 22 Apr 2020 18:00:43 +0200 Subject: [PATCH 035/125] 70506: CC license (REST): Patch submission (Remove) --- .../impl/CCLicenseRemovePatchOperation.java | 50 ++++++++++ .../spring/spring-dspace-core-services.xml | 4 + .../rest/CCLicenseAddPatchOperationIT.java | 17 +++- .../rest/CCLicenseRemovePatchOperationIT.java | 99 +++++++++++++++++++ 4 files changed, 167 insertions(+), 3 deletions(-) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/factory/impl/CCLicenseRemovePatchOperation.java create mode 100644 dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/factory/impl/CCLicenseRemovePatchOperation.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/factory/impl/CCLicenseRemovePatchOperation.java new file mode 100644 index 0000000000..19229a4f72 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/factory/impl/CCLicenseRemovePatchOperation.java @@ -0,0 +1,50 @@ +/** + * 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.rest.submit.factory.impl; + +import org.dspace.content.InProgressSubmission; +import org.dspace.content.Item; +import org.dspace.core.Context; +import org.dspace.license.service.CreativeCommonsService; +import org.dspace.services.model.Request; +import org.springframework.beans.factory.annotation.Autowired; + + +/** + * Submission "remove" PATCH operation + * + * To remove the Creative Commons License of a workspace item. + * + * Example: + * curl -X PATCH http://${dspace.server.url}/api/submission/workspaceitems/31599 -H "Content-Type: + * application/json" -d '[{ "op": "remove", "path": "/sections/cclicense/uri"}]' + * + */ +public class CCLicenseRemovePatchOperation extends RemovePatchOperation { + + @Autowired + CreativeCommonsService creativeCommonsService; + + @Override + protected Class getArrayClassForEvaluation() { + return String[].class; + } + + @Override + protected Class getClassForEvaluation() { + return String.class; + } + + @Override + void remove(Context context, Request currentRequest, InProgressSubmission source, String path, Object value) + throws Exception { + Item item = source.getItem(); + creativeCommonsService.removeLicense(context, item); + } + +} diff --git a/dspace-server-webapp/src/main/resources/spring/spring-dspace-core-services.xml b/dspace-server-webapp/src/main/resources/spring/spring-dspace-core-services.xml index 2b37ea5bdd..9faad91985 100644 --- a/dspace-server-webapp/src/main/resources/spring/spring-dspace-core-services.xml +++ b/dspace-server-webapp/src/main/resources/spring/spring-dspace-core-services.xml @@ -81,6 +81,10 @@ + + + diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseAddPatchOperationIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseAddPatchOperationIT.java index ba58e5f489..76b260f194 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseAddPatchOperationIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseAddPatchOperationIT.java @@ -7,7 +7,11 @@ */ package org.dspace.app.rest; +import static com.jayway.jsonpath.matchers.JsonPathMatchers.hasJsonPath; +import static org.hamcrest.Matchers.allOf; +import static org.hamcrest.Matchers.is; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.patch; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; import java.util.ArrayList; @@ -26,7 +30,7 @@ import org.dspace.content.WorkspaceItem; import org.junit.Test; /** - * Class to the methods from the CCLicenseAddPatchOperation + * Class to test the methods from the CCLicenseAddPatchOperation * Since the CC Licenses are obtained from the CC License API, a mock service has been implemented * This mock service will return a fixed set of CC Licenses using a similar structure to the ones obtained from the * CC License API. @@ -54,7 +58,8 @@ public class CCLicenseAddPatchOperationIT extends AbstractControllerIntegrationT String adminToken = getAuthToken(admin.getEmail(), password); List ops = new ArrayList(); - AddOperation addOperation = new AddOperation("/sections/cclicense/uri", "license-uri"); + AddOperation addOperation = new AddOperation("/sections/cclicense/uri", + "http://creativecommons.org/licenses/by-nc-sa/4.0/"); ops.add(addOperation); String patchBody = getPatchContent(ops); @@ -63,7 +68,13 @@ public class CCLicenseAddPatchOperationIT extends AbstractControllerIntegrationT getClient(adminToken).perform(patch("/api/submission/workspaceitems/" + workspaceItem.getID()) .content(patchBody) .contentType(MediaType.APPLICATION_JSON_PATCH_JSON)) - .andExpect(status().isOk()); + .andExpect(status().isOk()) + .andExpect(jsonPath("$.sections.cclicense", allOf( + hasJsonPath("$.uri", is("http://creativecommons.org/licenses/by-nc-sa/4.0/")), + hasJsonPath("$.rights", + is("Attribution-NonCommercial-ShareAlike 4.0 International")), + hasJsonPath("$.file.name", is("license_rdf")) + ))); } @Test diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java new file mode 100644 index 0000000000..b908b7acd7 --- /dev/null +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java @@ -0,0 +1,99 @@ +/** + * 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.rest; + +import static com.jayway.jsonpath.matchers.JsonPathMatchers.hasJsonPath; +import static org.hamcrest.Matchers.allOf; +import static org.hamcrest.Matchers.is; +import static org.hamcrest.Matchers.not; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.patch; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +import java.util.ArrayList; +import java.util.List; +import javax.ws.rs.core.MediaType; + +import org.dspace.app.rest.builder.CollectionBuilder; +import org.dspace.app.rest.builder.CommunityBuilder; +import org.dspace.app.rest.builder.WorkspaceItemBuilder; +import org.dspace.app.rest.model.patch.AddOperation; +import org.dspace.app.rest.model.patch.Operation; +import org.dspace.app.rest.model.patch.RemoveOperation; +import org.dspace.app.rest.test.AbstractControllerIntegrationTest; +import org.dspace.content.Collection; +import org.dspace.content.Community; +import org.dspace.content.WorkspaceItem; +import org.junit.Test; + +/** + * Class to test the methods from the CCLicenseRemovePatchOperation + * Since the CC Licenses are obtained from the CC License API, a mock service has been implemented + * This mock service will return a fixed set of CC Licenses using a similar structure to the ones obtained from the + * CC License API. + * Refer to {@link org.dspace.license.MockCCLicenseConnectorServiceImpl} for more information + */ +public class CCLicenseRemovePatchOperationIT extends AbstractControllerIntegrationTest { + + + @Test + public void patchRemoveSubmissionCCLicense() throws Exception { + context.turnOffAuthorisationSystem(); + + Community community = CommunityBuilder.createCommunity(context) + .withName("Community") + .build(); + + Collection collection = CollectionBuilder.createCollection(context, community) + .withName("Collection") + .build(); + + WorkspaceItem workspaceItem = WorkspaceItemBuilder.createWorkspaceItem(context, collection) + .withTitle("Workspace Item") + .build(); + + String adminToken = getAuthToken(admin.getEmail(), password); + + // First add a license and verify it is added + List ops = new ArrayList(); + AddOperation addOperation = new AddOperation("/sections/cclicense/uri", + "http://creativecommons.org/licenses/by-nc-sa/4.0/"); + + ops.add(addOperation); + String patchBody = getPatchContent(ops); + + + getClient(adminToken).perform(patch("/api/submission/workspaceitems/" + workspaceItem.getID()) + .content(patchBody) + .contentType(MediaType.APPLICATION_JSON_PATCH_JSON)) + .andExpect(status().isOk()) + .andExpect(jsonPath("$.sections.cclicense", allOf( + hasJsonPath("$.uri", is("http://creativecommons.org/licenses/by-nc-sa/4.0/")), + hasJsonPath("$.rights", + is("Attribution-NonCommercial-ShareAlike 4.0 International")), + hasJsonPath("$.file.name", is("license_rdf")) + ))); + + + + // Remove the license again and verify it is removed + + List removeOps = new ArrayList(); + RemoveOperation removeOperation = new RemoveOperation("/sections/cclicense/uri"); + + removeOps.add(removeOperation); + String removePatch = getPatchContent(removeOps); + + + getClient(adminToken).perform(patch("/api/submission/workspaceitems/" + workspaceItem.getID()) + .content(removePatch) + .contentType(MediaType.APPLICATION_JSON_PATCH_JSON)) + .andExpect(status().isOk()) + .andExpect(jsonPath("$.sections", not(hasJsonPath("cclicense")))); + } +} From 36264cca50439249f97b7a3ebbdc3459f8c07f8a Mon Sep 17 00:00:00 2001 From: Kevin Van de Velde Date: Thu, 23 Apr 2020 14:57:03 +0200 Subject: [PATCH 036/125] Submission CreativeCommons license rest evaluator plugin addition so that it plays nicely with the access restrictions --- ...ubmissionCCLicenseRestEvaluatorPlugin.java | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionCCLicenseRestEvaluatorPlugin.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionCCLicenseRestEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionCCLicenseRestEvaluatorPlugin.java new file mode 100644 index 0000000000..251717d799 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionCCLicenseRestEvaluatorPlugin.java @@ -0,0 +1,21 @@ +package org.dspace.app.rest.security; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.SubmissionCCLicenseRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +import java.io.Serializable; + +@Component +public class SubmissionCCLicenseRestEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(SubmissionCCLicenseRest.NAME, targetType)) { + return false; + } + return true; + } +} From b271ae662130405aa7b24c5a0cb6dbcec25aba68 Mon Sep 17 00:00:00 2001 From: Yana De Pauw Date: Tue, 28 Apr 2020 17:17:48 +0200 Subject: [PATCH 037/125] 70338: Cleanup CC license code --- .../java/org/dspace/license/CCLookup.java | 435 ------------------ .../license/CreativeCommonsServiceImpl.java | 33 -- .../dspace/license/LicenseMetadataValue.java | 129 ------ .../service/CreativeCommonsService.java | 13 - .../MockCCLicenseConnectorServiceImpl.java | 10 +- ...ubmissionCCLicenseRestEvaluatorPlugin.java | 11 +- .../rest/CCLicenseAddPatchOperationIT.java | 15 + .../rest/CCLicenseRemovePatchOperationIT.java | 3 +- .../MockCCLicenseConnectorServiceImpl.java | 10 +- 9 files changed, 40 insertions(+), 619 deletions(-) delete mode 100644 dspace-api/src/main/java/org/dspace/license/CCLookup.java delete mode 100644 dspace-api/src/main/java/org/dspace/license/LicenseMetadataValue.java diff --git a/dspace-api/src/main/java/org/dspace/license/CCLookup.java b/dspace-api/src/main/java/org/dspace/license/CCLookup.java deleted file mode 100644 index b7ddfa2314..0000000000 --- a/dspace-api/src/main/java/org/dspace/license/CCLookup.java +++ /dev/null @@ -1,435 +0,0 @@ -/** - * 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.OutputStreamWriter; -import java.io.UnsupportedEncodingException; -import java.net.MalformedURLException; -import java.net.URL; -import java.net.URLConnection; -import java.net.URLEncoder; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Iterator; -import java.util.List; -import java.util.Map; -import java.util.NoSuchElementException; - -import org.apache.logging.log4j.Logger; -import org.dspace.license.factory.LicenseServiceFactory; -import org.dspace.license.service.CreativeCommonsService; -import org.dspace.services.ConfigurationService; -import org.dspace.services.factory.DSpaceServicesFactory; -import org.jaxen.JaxenException; -import org.jaxen.jdom.JDOMXPath; -import org.jdom.Attribute; -import org.jdom.Document; -import org.jdom.Element; -import org.jdom.JDOMException; -import org.jdom.input.SAXBuilder; - - -/** - * A wrapper around Creative Commons REST web services. - * - * @author Wendy Bossons - */ -public class CCLookup { - - /** - * log4j logger - */ - private static Logger log = org.apache.logging.log4j.LogManager.getLogger(CCLookup.class); - - private String cc_root; - private String jurisdiction; - private List lcFilter = new ArrayList(); - - private Document license_doc = null; - private String rdfString = null; - private String errorMessage = null; - private boolean success = false; - - private SAXBuilder parser = new SAXBuilder(); - private List licenses = new ArrayList(); - private List licenseFields = new ArrayList(); - - protected CreativeCommonsService creativeCommonsService = LicenseServiceFactory.getInstance() - .getCreativeCommonsService(); - - /** - * Constructs a new instance with the default web services root. - */ - public CCLookup() { - super(); - - ConfigurationService configurationService = DSpaceServicesFactory.getInstance().getConfigurationService(); - - cc_root = configurationService.getProperty("cc.api.rooturl"); - - String jurisProp = configurationService.getProperty("cc.license.jurisdiction"); - jurisdiction = (jurisProp != null) ? jurisProp : ""; - - String[] filters = configurationService.getArrayProperty("cc.license.classfilter"); - if (filters != null) { - for (String name : filters) { - lcFilter.add(name.trim()); - } - } - } - - /** - * Returns the id for a particular CCLicense label. Returns an - * empty string if no match is found. - * - * @param class_label The CCLicense label to find. - * @return Returns a String containing the License class ID if the label - * is found; if not found, returns an empty string. - * @see CCLicense - */ - public String getLicenseId(String class_label) { - for (int i = 0; i < this.licenses.size(); i++) { - if (((CCLicense) this.licenses.get(i)).getLicenseName().equals(class_label)) { - return ((CCLicense) this.licenses.get(i)).getLicenseId(); - } - } - - return ""; - } - - /** - * Queries the web service for the available licenses. - * - * @param language The language to request labels and description strings in. - * @return Returns a Map of CCLicense objects. - * @see Map - * @see CCLicense - */ - public Collection getLicenses(String language) { - - // create XPath expressions - try { - JDOMXPath xp_Licenses = new JDOMXPath("//licenses/license"); - JDOMXPath xp_LicenseID = new JDOMXPath("@id"); - URL classUrl = new URL(this.cc_root + "/?locale=" + language); - Document classDoc = this.parser.build(classUrl); - // extract the identifiers and labels using XPath - List results = xp_Licenses.selectNodes(classDoc); - // populate licenses container - this.licenses.clear(); - for (int i = 0; i < results.size(); i++) { - Element license = results.get(i); - // add if not filtered - String liD = ((Attribute) xp_LicenseID.selectSingleNode(license)).getValue(); - if (!lcFilter.contains(liD)) { -// this.licenses.add(new CCLicense(liD, license.getText(), i)); - } - } - } catch (JaxenException jaxen_e) { - return null; - } catch (JDOMException jdom_e) { - return null; - } catch (IOException io_e) { - return null; - } catch (Exception e) { - // do nothing... but we should - return null; - } - - return licenses; - } - - - /** - * Queries the web service for a set of licenseFields for a particular license class. - * - * @param license A String specifying the CCLicense identifier to - * retrieve fields for. - * @param language the locale string - * @return A Collection of LicenseField objects. - * @see CCLicense - */ - public Collection getLicenseFields(String license, String language) { - - JDOMXPath xp_LicenseField; - JDOMXPath xp_LicenseID; - JDOMXPath xp_FieldType; - JDOMXPath xp_Description; - JDOMXPath xp_Label; - JDOMXPath xp_Enum; - - Document fieldDoc; - - URL classUrl; - List results = null; - List enumOptions = null; - - // create XPath expressions - try { - xp_LicenseField = new JDOMXPath("//field"); - xp_LicenseID = new JDOMXPath("@id"); - xp_Description = new JDOMXPath("description"); - xp_Label = new JDOMXPath("label"); - xp_FieldType = new JDOMXPath("type"); - xp_Enum = new JDOMXPath("enum"); - - } catch (JaxenException e) { - return null; - } - - // retrieve and parse the license class document - try { - classUrl = new URL(this.cc_root + "/license/" + license + "?locale=" + language); - } catch (Exception err) { - // do nothing... but we should - return null; - } - - // parse the licenses document - try { - fieldDoc = this.parser.build(classUrl); - } catch (JDOMException e) { - return null; - } catch (IOException e) { - return null; - } - - // reset the field definition container - this.licenseFields.clear(); - - // extract the identifiers and labels using XPath - try { - results = xp_LicenseField.selectNodes(fieldDoc); - } catch (JaxenException e) { - return null; - } - - for (int i = 0; i < results.size(); i++) { - Element field = (Element) results.get(i); - -// try { -// // create the field object -// CCLicenseField cclicensefield = new CCLicenseField( -// ((Attribute) xp_LicenseID.selectSingleNode(field)).getValue(), -// ((Element) xp_Label.selectSingleNode(field)).getText()); -// -// // extract additional properties -// cclicensefield.setDescription(((Element) xp_Description.selectSingleNode(field)).getText()); -// cclicensefield.setType(((Element) xp_FieldType.selectSingleNode(field)).getText()); -// -// enumOptions = xp_Enum.selectNodes(field); -// -// for (int j = 0; j < enumOptions.size(); j++) { -// String id = ((Attribute) xp_LicenseID.selectSingleNode(enumOptions.get(j))).getValue(); -// String label = ((Element) xp_Label.selectSingleNode(enumOptions.get(j))).getText(); -// -//// cclicensefield.getEnum().put(id, label); -// -// } // for each enum option -// -// this.licenseFields.add(cclicensefield); -// } catch (JaxenException e) { -// return null; -// } - } - - return licenseFields; - } // licenseFields - - /** - * Passes a set of "answers" to the web service and retrieves a license. - * - * @param licenseId The identifier of the license class being requested. - * @param answers A Map containing the answers to the license fields; - * each key is the identifier of a LicenseField, with the value - * containing the user-supplied answer. - * @param lang The language to request localized elements in. - * @throws IOException if IO error - * @see CCLicense - * @see Map - */ - public void issue(String licenseId, Map answers, String lang) - throws IOException { - - // Determine the issue URL - String issueUrl = this.cc_root + "/license/" + licenseId + "/issue"; - // Assemble the "answers" document - String answer_doc = "\n" + lang + "\n" + "\n"; - Iterator keys = answers.keySet().iterator(); - - try { - String current = (String) keys.next(); - - while (true) { - answer_doc += "<" + current + ">" + (String) answers.get(current) + "\n"; - current = (String) keys.next(); - } - - - } catch (NoSuchElementException e) { - // exception indicates we've iterated through the - // entire collection; just swallow and continue - } - // answer_doc += "\n"; FAILS with jurisdiction argument - answer_doc += "\n\n"; - String post_data; - - try { - post_data = URLEncoder.encode("answers", "UTF-8") + "=" + URLEncoder.encode(answer_doc, "UTF-8"); - } catch (UnsupportedEncodingException e) { - return; - } - - URL post_url; - try { - post_url = new URL(issueUrl); - } catch (MalformedURLException e) { - return; - } - URLConnection connection = post_url.openConnection(); - // this will not be needed after I'm done TODO: remove - connection.setDoOutput(true); - OutputStreamWriter writer = new OutputStreamWriter(connection.getOutputStream()); - writer.write(post_data); - writer.flush(); - // end TODO - try { - // parsing document from input stream - java.io.InputStream stream = connection.getInputStream(); - this.license_doc = this.parser.build(stream); - } catch (JDOMException jde) { - log.warn(jde.getMessage()); - } catch (Exception e) { - log.warn(e.getCause()); - } - return; - } // issue - - /** - * Passes a set of "answers" to the web service and retrieves a license. - * - * @param licenseURI The uri of the license. - * - * Note: does not support localization in 1.5 -- not yet - * @throws IOException if IO error - * @see CCLicense - * @see Map - */ - public void issue(String licenseURI) - throws IOException { - - // Determine the issue URL - // Example: http://api.creativecommons.org/rest/1.5/details? - // license-uri=http://creativecommons.org/licenses/by-nc-sa/3.0/ - String issueUrl = cc_root + "/details?license-uri=" + licenseURI; - - URL request_url; - try { - request_url = new URL(issueUrl); - } catch (MalformedURLException e) { - return; - } - URLConnection connection = request_url.openConnection(); - // this will not be needed after I'm done TODO: remove - connection.setDoOutput(true); - try { - // parsing document from input stream - java.io.InputStream stream = connection.getInputStream(); - license_doc = this.parser.build(stream); - } catch (JDOMException jde) { - log.warn(jde.getMessage()); - } catch (Exception e) { - log.warn(e.getCause()); - } - return; - } // issue - - /** - * Retrieves the URI for the license issued. - * - * @return A String containing the URI for the license issued. - */ - public String getLicenseUrl() { - String text = null; - try { - JDOMXPath xp_LicenseName = new JDOMXPath("//result/license-uri"); - text = ((Element) xp_LicenseName.selectSingleNode(this.license_doc)).getText(); - } catch (Exception e) { - log.warn(e.getMessage()); - setSuccess(false); - text = "An error occurred getting the license - uri."; - } finally { - return text; - } - } // getLicenseUrl - - /** - * Retrieves the human readable name for the license issued. - * - * @return A String containing the license name. - */ - public String getLicenseName() { - String text = null; - try { - JDOMXPath xp_LicenseName = new JDOMXPath("//result/license-name"); - text = ((Element) xp_LicenseName.selectSingleNode(this.license_doc)).getText(); - } catch (Exception e) { - log.warn(e.getMessage()); - setSuccess(false); - text = "An error occurred on the license name."; - } finally { - return text; - } - } // getLicenseName - - - public org.jdom.Document getLicenseDocument() { - return this.license_doc; - } - - public String getRdf() - throws IOException { - String result = ""; - try { - result = creativeCommonsService.fetchLicenseRDF(license_doc); - } catch (Exception e) { - log.warn("An error occurred getting the rdf . . ." + e.getMessage()); - setSuccess(false); - } - return result; - } - - public boolean isSuccess() { - setSuccess(false); - JDOMXPath xp_Success; - String text = null; - try { - xp_Success = new JDOMXPath("//message"); - text = ((Element) xp_Success.selectSingleNode(this.license_doc)).getText(); - setErrorMessage(text); - } catch (Exception e) { - log.warn("There was an issue . . . " + text); - setSuccess(true); - } - return this.success; - } - - private void setSuccess(boolean success) { - this.success = success; - } - - public String getErrorMessage() { - return this.errorMessage; - } - - private void setErrorMessage(String errorMessage) { - this.errorMessage = errorMessage; - } - -} diff --git a/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java b/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java index 67a9e4e06d..7a48b6f03b 100644 --- a/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java @@ -125,11 +125,6 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi } - @Override - public boolean isEnabled() { - return true; - } - // create the CC bundle if it doesn't exist // If it does, remove it and create a new one. protected Bundle getCcBundle(Context context, Item item) @@ -201,34 +196,6 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi } } - @Override - public boolean hasLicense(Context context, Item item) - throws SQLException, IOException { - // try to find CC license bundle - List bundles = itemService.getBundles(item, CC_BUNDLE_NAME); - - if (bundles.size() == 0) { - return false; - } - - // verify it has correct contents - try { - if ((getLicenseURL(context, item) == null)) { - return false; - } - } catch (AuthorizeException ae) { - return false; - } - - return true; - } - - @Override - public String getLicenseRDF(Context context, Item item) throws SQLException, - IOException, AuthorizeException { - return getStringFromBitstream(context, item, BSN_LICENSE_RDF); - } - @Override public Bitstream getLicenseRdfBitstream(Item item) throws SQLException, IOException, AuthorizeException { diff --git a/dspace-api/src/main/java/org/dspace/license/LicenseMetadataValue.java b/dspace-api/src/main/java/org/dspace/license/LicenseMetadataValue.java deleted file mode 100644 index ec5c9e447b..0000000000 --- a/dspace-api/src/main/java/org/dspace/license/LicenseMetadataValue.java +++ /dev/null @@ -1,129 +0,0 @@ -/** - * 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.sql.SQLException; -import java.util.ArrayList; -import java.util.List; - -import org.dspace.authorize.AuthorizeException; -import org.dspace.content.Item; -import org.dspace.content.MetadataValue; -import org.dspace.content.factory.ContentServiceFactory; -import org.dspace.content.service.ItemService; -import org.dspace.core.Context; - -/** - * Helper class for using CC-related Metadata fields - * - * @author kevinvandevelde at atmire.com - */ -public class LicenseMetadataValue { - - protected final ItemService itemService; - // Shibboleth for Creative Commons license data - i.e. characters that reliably indicate CC in a URI - protected static final String ccShib = "creativecommons"; - - private String[] params = new String[4]; - - public LicenseMetadataValue(String fieldName) { - if (fieldName != null && fieldName.length() > 0) { - String[] fParams = fieldName.split("\\."); - for (int i = 0; i < fParams.length; i++) { - params[i] = fParams[i]; - } - params[3] = Item.ANY; - } - itemService = ContentServiceFactory.getInstance().getItemService(); - } - - /** - * Returns first value that matches Creative Commons 'shibboleth', - * or null if no matching values. - * NB: this method will succeed only for metadata fields holding CC URIs - * - * @param item - the item to read - * @return value - the first CC-matched value, or null if no such value - */ - public String ccItemValue(Item item) { - List dcvalues = itemService.getMetadata(item, params[0], params[1], params[2], params[3]); - for (MetadataValue dcvalue : dcvalues) { - if ((dcvalue.getValue()).indexOf(ccShib) != -1) { - // return first value that matches the shib - return dcvalue.getValue(); - } - } - return null; - } - - /** - * Returns the value that matches the value mapped to the passed key if any. - * NB: this only delivers a license name (if present in field) given a license URI - * - * @param item - the item to read - * @param key - the key for desired value - * @return value - the value associated with key or null if no such value - * @throws IOException A general class of exceptions produced by failed or interrupted I/O operations. - * @throws SQLException An exception that provides information on a database access error or other errors. - * @throws AuthorizeException Exception indicating the current user of the context does not have permission - * to perform a particular action. - */ - public String keyedItemValue(Item item, String key) - throws AuthorizeException, IOException, SQLException { - CCLookup ccLookup = new CCLookup(); - ccLookup.issue(key); - String matchValue = ccLookup.getLicenseName(); - List dcvalues = itemService.getMetadata(item, params[0], params[1], params[2], params[3]); - for (MetadataValue dcvalue : dcvalues) { - if (dcvalue.getValue().equals(matchValue)) { - return dcvalue.getValue(); - } - } - return null; - } - - /** - * Removes the passed value from the set of values for the field in passed item. - * - * @param context The relevant DSpace Context. - * @param item - the item to update - * @param value - the value to remove - * @throws IOException A general class of exceptions produced by failed or interrupted I/O operations. - * @throws SQLException An exception that provides information on a database access error or other errors. - * @throws AuthorizeException Exception indicating the current user of the context does not have permission - * to perform a particular action. - */ - public void removeItemValue(Context context, Item item, String value) - throws AuthorizeException, IOException, SQLException { - if (value != null) { - List dcvalues = itemService.getMetadata(item, params[0], params[1], params[2], params[3]); - ArrayList arrayList = new ArrayList(); - for (MetadataValue dcvalue : dcvalues) { - if (!dcvalue.getValue().equals(value)) { - arrayList.add(dcvalue.getValue()); - } - } - itemService.clearMetadata(context, item, params[0], params[1], params[2], params[3]); - itemService.addMetadata(context, item, params[0], params[1], params[2], params[3], arrayList); - } - } - - /** - * Adds passed value to the set of values for the field in passed item. - * - * @param context The relevant DSpace Context. - * @param item - the item to update - * @param value - the value to add in this field - * @throws SQLException An exception that provides information on a database access error or other errors. - */ - public void addItemValue(Context context, Item item, String value) throws SQLException { - itemService.addMetadata(context, item, params[0], params[1], params[2], params[3], value); - } - -} diff --git a/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java b/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java index c5ea6475bb..fa32cb75ca 100644 --- a/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java +++ b/dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java @@ -31,13 +31,6 @@ public interface CreativeCommonsService { public static final String CC_BUNDLE_NAME = "CC-LICENSE"; - /** - * Simple accessor for enabling of CC - * - * @return is CC enabled? - */ - public boolean isEnabled(); - /** * setLicenseRDF * @@ -88,8 +81,6 @@ public interface CreativeCommonsService { public void removeLicenseFile(Context context, Item item) throws SQLException, IOException, AuthorizeException; - public boolean hasLicense(Context context, Item item) - throws SQLException, IOException; public String getLicenseURL(Context context, Item item) throws SQLException, IOException, AuthorizeException; @@ -111,10 +102,6 @@ public interface CreativeCommonsService { */ public String getLicenseName(Item item); - - public String getLicenseRDF(Context context, Item item) - throws SQLException, IOException, AuthorizeException; - /** * Get Creative Commons license RDF, returning Bitstream object. * diff --git a/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java b/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java index 41cd9805f6..bb443ab4a4 100644 --- a/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java +++ b/dspace-api/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java @@ -107,14 +107,18 @@ public class MockCCLicenseConnectorServiceImpl extends CCLicenseConnectorService */ public Document retrieveLicenseRDFDoc(String licenseURI) throws IOException { if (!StringUtils.contains(licenseURI, "invalid")) { + InputStream cclicense = null; try { - - InputStream cclicense = getClass().getResourceAsStream("cc-license-rdf.xml"); + cclicense = getClass().getResourceAsStream("cc-license-rdf.xml"); Document doc = parser.build(cclicense); return doc; } catch (JDOMException e) { - e.printStackTrace(); + throw new RuntimeException(e); + } finally { + if (cclicense != null) { + cclicense.close(); + } } } return null; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionCCLicenseRestEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionCCLicenseRestEvaluatorPlugin.java index 251717d799..ae925fe8b1 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionCCLicenseRestEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionCCLicenseRestEvaluatorPlugin.java @@ -1,12 +1,19 @@ +/** + * 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.rest.security; +import java.io.Serializable; + import org.apache.commons.lang3.StringUtils; import org.dspace.app.rest.model.SubmissionCCLicenseRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; -import java.io.Serializable; - @Component public class SubmissionCCLicenseRestEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseAddPatchOperationIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseAddPatchOperationIT.java index 76b260f194..4f9c753047 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseAddPatchOperationIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseAddPatchOperationIT.java @@ -10,6 +10,8 @@ package org.dspace.app.rest; import static com.jayway.jsonpath.matchers.JsonPathMatchers.hasJsonPath; import static org.hamcrest.Matchers.allOf; import static org.hamcrest.Matchers.is; +import static org.hamcrest.Matchers.not; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.patch; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; @@ -55,6 +57,8 @@ public class CCLicenseAddPatchOperationIT extends AbstractControllerIntegrationT .withTitle("Workspace Item") .build(); + context.restoreAuthSystemState(); + String adminToken = getAuthToken(admin.getEmail(), password); List ops = new ArrayList(); @@ -93,6 +97,9 @@ public class CCLicenseAddPatchOperationIT extends AbstractControllerIntegrationT .withTitle("Workspace Item") .build(); + context.restoreAuthSystemState(); + + String adminToken = getAuthToken(admin.getEmail(), password); List ops = new ArrayList(); @@ -106,5 +113,13 @@ public class CCLicenseAddPatchOperationIT extends AbstractControllerIntegrationT .content(patchBody) .contentType(MediaType.APPLICATION_JSON_PATCH_JSON)) .andExpect(status().isInternalServerError()); + + getClient(adminToken).perform(get("/api/submission/workspaceitems/" + workspaceItem.getID()) + .content(patchBody) + .contentType(MediaType.APPLICATION_JSON_PATCH_JSON)) + .andExpect(status().isOk()) + .andExpect(jsonPath("$.sections", not(hasJsonPath("cclicense")))); + + } } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java index b908b7acd7..afee0aa882 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java @@ -57,6 +57,8 @@ public class CCLicenseRemovePatchOperationIT extends AbstractControllerIntegrati .withTitle("Workspace Item") .build(); + context.restoreAuthSystemState(); + String adminToken = getAuthToken(admin.getEmail(), password); // First add a license and verify it is added @@ -80,7 +82,6 @@ public class CCLicenseRemovePatchOperationIT extends AbstractControllerIntegrati ))); - // Remove the license again and verify it is removed List removeOps = new ArrayList(); diff --git a/dspace-server-webapp/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java b/dspace-server-webapp/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java index 41cd9805f6..bb443ab4a4 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java +++ b/dspace-server-webapp/src/test/java/org/dspace/license/MockCCLicenseConnectorServiceImpl.java @@ -107,14 +107,18 @@ public class MockCCLicenseConnectorServiceImpl extends CCLicenseConnectorService */ public Document retrieveLicenseRDFDoc(String licenseURI) throws IOException { if (!StringUtils.contains(licenseURI, "invalid")) { + InputStream cclicense = null; try { - - InputStream cclicense = getClass().getResourceAsStream("cc-license-rdf.xml"); + cclicense = getClass().getResourceAsStream("cc-license-rdf.xml"); Document doc = parser.build(cclicense); return doc; } catch (JDOMException e) { - e.printStackTrace(); + throw new RuntimeException(e); + } finally { + if (cclicense != null) { + cclicense.close(); + } } } return null; From 8e0b22ad6ca165a16fc608f8d424c66d2b69100d Mon Sep 17 00:00:00 2001 From: Yana De Pauw Date: Wed, 29 Apr 2020 11:17:17 +0200 Subject: [PATCH 038/125] 70415: jurisdiction --- .../dspace/license/CreativeCommonsServiceImpl.java | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java b/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java index 7a48b6f03b..40e727d9df 100644 --- a/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java @@ -91,6 +91,8 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi protected ConfigurationService configurationService = DSpaceServicesFactory.getInstance().getConfigurationService(); private String defaultLanguage; + private String jurisdiction; + private static final String JURISDICTION_KEY = "jurisdiction"; private Map> ccLicenses; @@ -113,6 +115,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi ccLicenses = new HashMap<>(); defaultLanguage = configurationService.getProperty("cc.license.locale", "en"); + jurisdiction = configurationService.getProperty("cc.license.jurisdiction", ""); try { templates = TransformerFactory.newInstance().newTemplates( @@ -601,9 +604,18 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi fullParamMap.put(ccLicenseField.getId(), ""); } } + + updateJurisdiction(fullParamMap); + return fullParamMap; } + private void updateJurisdiction(final Map fullParamMap) { + if (fullParamMap.containsKey(JURISDICTION_KEY)) { + fullParamMap.put(JURISDICTION_KEY, jurisdiction); + } + } + private boolean containsAnswerEnum(final String enumAnswer, final CCLicenseField ccLicenseField) { List fieldEnums = ccLicenseField.getFieldEnum(); for (CCLicenseFieldEnum fieldEnum : fieldEnums) { From d8bda5c721e1bedde28f95168d47f1b5d3b61fc2 Mon Sep 17 00:00:00 2001 From: Peter Nijs Date: Fri, 24 Apr 2020 17:41:54 +0200 Subject: [PATCH 039/125] 70471: Add configuration properties endpoint --- .../test/data/dspaceFolder/config/local.cfg | 9 ++++ .../app/rest/ConfigurationRestController.java | 46 +++++++++++++++++++ .../repository/ConfigurationRepository.java | 45 ++++++++++++++++++ .../config/spring/rest/configuration.xml | 15 ++++++ .../app/rest/ConfigurationControllerIT.java | 43 +++++++++++++++++ dspace/config/spring/rest/configuration.xml | 13 ++++++ 6 files changed, 171 insertions(+) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/ConfigurationRestController.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRepository.java create mode 100644 dspace-server-webapp/src/test/data/dspaceFolder/config/spring/rest/configuration.xml create mode 100644 dspace-server-webapp/src/test/java/org/dspace/app/rest/ConfigurationControllerIT.java create mode 100644 dspace/config/spring/rest/configuration.xml diff --git a/dspace-api/src/test/data/dspaceFolder/config/local.cfg b/dspace-api/src/test/data/dspaceFolder/config/local.cfg index 3c4b4a839d..4550b3d626 100644 --- a/dspace-api/src/test/data/dspaceFolder/config/local.cfg +++ b/dspace-api/src/test/data/dspaceFolder/config/local.cfg @@ -108,3 +108,12 @@ plugin.sequence.java.util.Collection = \ java.util.LinkedList, \ java.util.Stack, \ java.util.TreeSet + +########################################### +# PROPERTIES USED TO TEST CONFIGURATION # +# PROPERTY EXPOSURE VIA REST # +########################################### + +configuration.not.exposed = secret_value +configuration.exposed.single.value = public_value +configuration.exposed.array.value = public_value_1, public_value_2 diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ConfigurationRestController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ConfigurationRestController.java new file mode 100644 index 0000000000..3e0c1434e6 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ConfigurationRestController.java @@ -0,0 +1,46 @@ +/** + * 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.rest; + +import org.dspace.app.rest.model.RestModel; +import org.dspace.app.rest.repository.ConfigurationRepository; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RestController; + +/** + * This will be the entry point for the api/config/properties endpoint + */ +@RestController +@RequestMapping("/api/" + RestModel.CONFIGURATION + "/properties") +public class ConfigurationRestController { + @Autowired + private ConfigurationRepository configurationRepository; + + /** + * This method gets a configuration property + * + * Example: + * 
+     * {@code
+     * curl http:///api/config/properties/google.analytics.key
+     *  -XGET \
+     *  -H 'Authorization: Bearer eyJhbGciOiJI...'
+     * }
+     *
+ * + * @param property The key of a configuration property + * @return The value of that property + */ + @RequestMapping(method = RequestMethod.GET, path = "/{property}") + public String[] getProperty(@PathVariable String property) { + return configurationRepository.getValue(property); + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRepository.java new file mode 100644 index 0000000000..954cff3b40 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRepository.java @@ -0,0 +1,45 @@ +/** + * 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.rest.repository; + +import java.util.ArrayList; +import javax.annotation.Resource; + +import org.dspace.app.rest.model.RestModel; +import org.dspace.services.ConfigurationService; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.data.rest.webmvc.ResourceNotFoundException; +import org.springframework.stereotype.Component; + +/** + * This is the repository responsible of exposing configuration properties + */ +@Component(RestModel.CONFIGURATION + ".properties") +public class ConfigurationRepository { + @Autowired + private ConfigurationService configurationService; + + @Resource(name = "exposedConfigurationProperties") + private ArrayList exposedProperties; + + /** + * Gets the value of a configuration property if it is exposed via REST + * + * @param property + * @return + */ + public String[] getValue(String property) { + String[] propertyValues = configurationService.getArrayProperty(property); + + if (!exposedProperties.contains(property) || propertyValues.length == 0) { + throw new ResourceNotFoundException("No such configuration property" + property); + } + + return propertyValues; + } +} diff --git a/dspace-server-webapp/src/test/data/dspaceFolder/config/spring/rest/configuration.xml b/dspace-server-webapp/src/test/data/dspaceFolder/config/spring/rest/configuration.xml new file mode 100644 index 0000000000..78b1230af5 --- /dev/null +++ b/dspace-server-webapp/src/test/data/dspaceFolder/config/spring/rest/configuration.xml @@ -0,0 +1,15 @@ + + + + + + + configuration.exposed.single.value + configuration.exposed.array.value + configuration.not.existing + + + + \ No newline at end of file diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ConfigurationControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ConfigurationControllerIT.java new file mode 100644 index 0000000000..c364dbf701 --- /dev/null +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ConfigurationControllerIT.java @@ -0,0 +1,43 @@ +/** + * 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.rest; + +import static org.hamcrest.Matchers.is; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +import org.dspace.app.rest.test.AbstractControllerIntegrationTest; +import org.junit.Test; + +public class ConfigurationControllerIT extends AbstractControllerIntegrationTest { + @Test + public void getSingleValue() throws Exception { + getClient().perform(get("/api/config/properties/configuration.exposed.single.value")) + .andExpect(jsonPath("$[0]", is("public_value"))); + } + + @Test + public void getArrayValue() throws Exception { + getClient().perform(get("/api/config/properties/configuration.exposed.array.value")) + .andExpect(jsonPath("$[0]", is("public_value_1"))) + .andExpect(jsonPath("$[1]", is("public_value_2"))); + } + + @Test + public void getNonExistingValue() throws Exception { + getClient().perform(get("/api/config/properties/configuration.not.existing")) + .andExpect(status().isNotFound()); + } + + @Test + public void getNonExposedValue() throws Exception { + getClient().perform(get("/api/config/properties/configuration.not.exposed")) + .andExpect(status().isNotFound()); + } +} diff --git a/dspace/config/spring/rest/configuration.xml b/dspace/config/spring/rest/configuration.xml new file mode 100644 index 0000000000..4604491099 --- /dev/null +++ b/dspace/config/spring/rest/configuration.xml @@ -0,0 +1,13 @@ + + + + + + + google.analytics.key + + + + \ No newline at end of file From f85a5b3c4d8127ff8f9f622e51948171fef76d33 Mon Sep 17 00:00:00 2001 From: Peter Nijs Date: Mon, 4 May 2020 17:56:14 +0200 Subject: [PATCH 040/125] 70603: Make the configuration properties endpoint conform to the contract --- .../app/rest/ConfigurationRestController.java | 46 ----------- .../link/PropertyResourceHalLinkFactory.java | 34 ++++++++ .../dspace/app/rest/model/PropertyRest.java | 51 ++++++++++++ .../rest/model/hateoas/PropertyResource.java | 18 +++++ .../repository/ConfigurationRepository.java | 45 ----------- .../ConfigurationRestRepository.java | 78 +++++++++++++++++++ .../java/org/dspace/app/rest/utils/Utils.java | 4 + ...l => exposed-properties-configuration.xml} | 0 ...ava => ConfigurationRestRepositoryIT.java} | 20 ++++- ...l => exposed-properties-configuration.xml} | 0 10 files changed, 201 insertions(+), 95 deletions(-) delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/ConfigurationRestController.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/link/PropertyResourceHalLinkFactory.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PropertyRest.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/PropertyResource.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRepository.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRestRepository.java rename dspace-server-webapp/src/test/data/dspaceFolder/config/spring/rest/{configuration.xml => exposed-properties-configuration.xml} (100%) rename dspace-server-webapp/src/test/java/org/dspace/app/rest/{ConfigurationControllerIT.java => ConfigurationRestRepositoryIT.java} (64%) rename dspace/config/spring/rest/{configuration.xml => exposed-properties-configuration.xml} (100%) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ConfigurationRestController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ConfigurationRestController.java deleted file mode 100644 index 3e0c1434e6..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ConfigurationRestController.java +++ /dev/null @@ -1,46 +0,0 @@ -/** - * 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.rest; - -import org.dspace.app.rest.model.RestModel; -import org.dspace.app.rest.repository.ConfigurationRepository; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.web.bind.annotation.PathVariable; -import org.springframework.web.bind.annotation.RequestMapping; -import org.springframework.web.bind.annotation.RequestMethod; -import org.springframework.web.bind.annotation.RestController; - -/** - * This will be the entry point for the api/config/properties endpoint - */ -@RestController -@RequestMapping("/api/" + RestModel.CONFIGURATION + "/properties") -public class ConfigurationRestController { - @Autowired - private ConfigurationRepository configurationRepository; - - /** - * This method gets a configuration property - * - * Example: - * 
-     * {@code
-     * curl http:///api/config/properties/google.analytics.key
-     *  -XGET \
-     *  -H 'Authorization: Bearer eyJhbGciOiJI...'
-     * }
-     *
- * - * @param property The key of a configuration property - * @return The value of that property - */ - @RequestMapping(method = RequestMethod.GET, path = "/{property}") - public String[] getProperty(@PathVariable String property) { - return configurationRepository.getValue(property); - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/PropertyResourceHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/PropertyResourceHalLinkFactory.java new file mode 100644 index 0000000000..39af3eefcf --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/PropertyResourceHalLinkFactory.java @@ -0,0 +1,34 @@ +/** + * 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.rest.link; + +import java.util.LinkedList; + +import org.dspace.app.rest.RestResourceController; +import org.dspace.app.rest.model.hateoas.PropertyResource; +import org.springframework.data.domain.Pageable; +import org.springframework.hateoas.Link; +import org.springframework.stereotype.Component; + +@Component +public class PropertyResourceHalLinkFactory extends HalLinkFactory { + @Override + protected void addLinks(PropertyResource halResource, Pageable pageable, LinkedList list) throws Exception { + halResource.removeLinks(); + } + + @Override + protected Class getControllerClass() { + return RestResourceController.class; + } + + @Override + protected Class getResourceClass() { + return PropertyResource.class; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PropertyRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PropertyRest.java new file mode 100644 index 0000000000..6cc2e02eaa --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PropertyRest.java @@ -0,0 +1,51 @@ +/** + * 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.rest.model; + +import java.util.List; + +import org.dspace.app.rest.RestResourceController; + +public class PropertyRest extends RestAddressableModel { + public static final String NAME = "property"; + public static final String CATEGORY = RestAddressableModel.CONFIGURATION; + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public List getValues() { + return values; + } + + public void setValues(List values) { + this.values = values; + } + + public String name; + public List values; + + @Override + public String getCategory() { + return CATEGORY; + } + + @Override + public Class getController() { + return RestResourceController.class; + } + + @Override + public String getType() { + return NAME; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/PropertyResource.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/PropertyResource.java new file mode 100644 index 0000000000..1aa1007c52 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/PropertyResource.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.rest.model.hateoas; + +import org.dspace.app.rest.model.PropertyRest; +import org.dspace.app.rest.utils.Utils; + +public class PropertyResource extends DSpaceResource { + + public PropertyResource(PropertyRest data, Utils utils) { + super(data, utils); + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRepository.java deleted file mode 100644 index 954cff3b40..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRepository.java +++ /dev/null @@ -1,45 +0,0 @@ -/** - * 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.rest.repository; - -import java.util.ArrayList; -import javax.annotation.Resource; - -import org.dspace.app.rest.model.RestModel; -import org.dspace.services.ConfigurationService; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.data.rest.webmvc.ResourceNotFoundException; -import org.springframework.stereotype.Component; - -/** - * This is the repository responsible of exposing configuration properties - */ -@Component(RestModel.CONFIGURATION + ".properties") -public class ConfigurationRepository { - @Autowired - private ConfigurationService configurationService; - - @Resource(name = "exposedConfigurationProperties") - private ArrayList exposedProperties; - - /** - * Gets the value of a configuration property if it is exposed via REST - * - * @param property - * @return - */ - public String[] getValue(String property) { - String[] propertyValues = configurationService.getArrayProperty(property); - - if (!exposedProperties.contains(property) || propertyValues.length == 0) { - throw new ResourceNotFoundException("No such configuration property" + property); - } - - return propertyValues; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRestRepository.java new file mode 100644 index 0000000000..4fc1d48c6f --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRestRepository.java @@ -0,0 +1,78 @@ +/** + * 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.rest.repository; + +import java.util.ArrayList; +import java.util.Arrays; +import javax.annotation.Resource; + +import org.dspace.app.rest.exception.RepositoryMethodNotImplementedException; +import org.dspace.app.rest.model.PropertyRest; +import org.dspace.core.Context; +import org.dspace.services.ConfigurationService; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; +import org.springframework.data.rest.webmvc.ResourceNotFoundException; +import org.springframework.stereotype.Component; + +/** + * This is the repository responsible of exposing configuration properties + */ +@Component(PropertyRest.CATEGORY + "." + PropertyRest.NAME) +public class ConfigurationRestRepository extends DSpaceRestRepository { + @Autowired + private ConfigurationService configurationService; + + @Resource(name = "exposedConfigurationProperties") + private ArrayList exposedProperties; + + /** + * Gets the value of a configuration property if it is exposed via REST + * + * Example: + * 
+     * {@code
+     * curl http:///api/config/properties/google.analytics.key
+     *  -XGET \
+     *  -H 'Authorization: Bearer eyJhbGciOiJI...'
+     * }
+     *
+ * + * @param property + * @return + */ + @Override + public PropertyRest findOne(Context context, String property) { + if (!exposedProperties.contains(property)) { + throw new ResourceNotFoundException("No such configuration property" + property); + } + + String[] propertyValues = configurationService.getArrayProperty(property); + + if (propertyValues.length == 0) { + throw new ResourceNotFoundException("No such configuration property" + property); + } + + PropertyRest propertyRest = new PropertyRest(); + propertyRest.setName(property); + propertyRest.setValues(Arrays.asList(propertyValues)); + + return propertyRest; + } + + @Override + public Page findAll(Context context, Pageable pageable) { + throw new RepositoryMethodNotImplementedException("No implementation found; Method not allowed!", ""); + } + + @Override + public Class getDomainClass() { + return PropertyRest.class; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/Utils.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/Utils.java index f241ba3b30..034f9e2f55 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/Utils.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/Utils.java @@ -53,6 +53,7 @@ import org.dspace.app.rest.model.CommunityRest; import org.dspace.app.rest.model.LinkRest; import org.dspace.app.rest.model.LinksRest; import org.dspace.app.rest.model.ProcessRest; +import org.dspace.app.rest.model.PropertyRest; import org.dspace.app.rest.model.ResourcePolicyRest; import org.dspace.app.rest.model.RestAddressableModel; import org.dspace.app.rest.model.RestModel; @@ -232,6 +233,9 @@ public class Utils { if (StringUtils.equals(modelPlural, "versionhistories")) { return VersionHistoryRest.NAME; } + if (StringUtils.equals(modelPlural, "properties")) { + return PropertyRest.NAME; + } return modelPlural.replaceAll("s$", ""); } diff --git a/dspace-server-webapp/src/test/data/dspaceFolder/config/spring/rest/configuration.xml b/dspace-server-webapp/src/test/data/dspaceFolder/config/spring/rest/exposed-properties-configuration.xml similarity index 100% rename from dspace-server-webapp/src/test/data/dspaceFolder/config/spring/rest/configuration.xml rename to dspace-server-webapp/src/test/data/dspaceFolder/config/spring/rest/exposed-properties-configuration.xml diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ConfigurationControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ConfigurationRestRepositoryIT.java similarity index 64% rename from dspace-server-webapp/src/test/java/org/dspace/app/rest/ConfigurationControllerIT.java rename to dspace-server-webapp/src/test/java/org/dspace/app/rest/ConfigurationRestRepositoryIT.java index c364dbf701..f1ecc474b4 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ConfigurationControllerIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ConfigurationRestRepositoryIT.java @@ -15,18 +15,24 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers. import org.dspace.app.rest.test.AbstractControllerIntegrationTest; import org.junit.Test; -public class ConfigurationControllerIT extends AbstractControllerIntegrationTest { +/** + * Integration Tests against the /api/config/properties/[property] endpoint + */ +public class ConfigurationRestRepositoryIT extends AbstractControllerIntegrationTest { @Test public void getSingleValue() throws Exception { getClient().perform(get("/api/config/properties/configuration.exposed.single.value")) - .andExpect(jsonPath("$[0]", is("public_value"))); + .andExpect(jsonPath("$.values[0]", is("public_value"))) + .andExpect(jsonPath("$.type", is("property"))) + .andExpect(jsonPath("$.name", is("configuration.exposed.single.value"))) + .andExpect(jsonPath("$._links").doesNotExist()); } @Test public void getArrayValue() throws Exception { getClient().perform(get("/api/config/properties/configuration.exposed.array.value")) - .andExpect(jsonPath("$[0]", is("public_value_1"))) - .andExpect(jsonPath("$[1]", is("public_value_2"))); + .andExpect(jsonPath("$.values[0]", is("public_value_1"))) + .andExpect(jsonPath("$.values[1]", is("public_value_2"))); } @Test @@ -40,4 +46,10 @@ public class ConfigurationControllerIT extends AbstractControllerIntegrationTest getClient().perform(get("/api/config/properties/configuration.not.exposed")) .andExpect(status().isNotFound()); } + + @Test + public void getAll() throws Exception { + getClient().perform(get("/api/config/properties/")) + .andExpect(status().isMethodNotAllowed()); + } } diff --git a/dspace/config/spring/rest/configuration.xml b/dspace/config/spring/rest/exposed-properties-configuration.xml similarity index 100% rename from dspace/config/spring/rest/configuration.xml rename to dspace/config/spring/rest/exposed-properties-configuration.xml From 861cdfb2b852a69347e467c2eb435f3f82a86528 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Wed, 6 May 2020 11:02:47 +0200 Subject: [PATCH 041/125] [Task 70080] applied feedback to the scripts prototype --- .../app/bulkedit/MetadataExportScriptConfiguration.java | 2 +- .../app/bulkedit/MetadataImportScriptConfiguration.java | 2 +- .../dspace/discovery/IndexDiscoveryScriptConfiguration.java | 2 +- .../dspace/scripts/MockDSpaceRunnableScriptConfiguration.java | 2 +- .../org/dspace/app/rest/repository/ScriptRestRepository.java | 4 ---- .../dspace/scripts/MockDSpaceRunnableScriptConfiguration.java | 2 +- 6 files changed, 5 insertions(+), 9 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportScriptConfiguration.java index 10cb1ec0bc..65c0ddd8cf 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportScriptConfiguration.java @@ -45,7 +45,7 @@ public class MetadataExportScriptConfiguration extends try { return authorizeService.isAdmin(context); } catch (SQLException e) { - throw new RuntimeException("SQLException occured", e); + throw new RuntimeException("SQLException occurred when checking if the current user is an admin", e); } } diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java index 510296742f..9ea50b7de5 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java @@ -45,7 +45,7 @@ public class MetadataImportScriptConfiguration extends try { return authorizeService.isAdmin(context); } catch (SQLException e) { - throw new RuntimeException("SQLException occured", e); + throw new RuntimeException("SQLException occurred when checking if the current user is an admin", e); } } diff --git a/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java index 8316d144ad..8bf3cf2aba 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java @@ -35,7 +35,7 @@ public class IndexDiscoveryScriptConfiguration extends Sc try { return authorizeService.isAdmin(context); } catch (SQLException e) { - throw new RuntimeException("SQLException occured", e); + throw new RuntimeException("SQLException occurred when checking if the current user is an admin", e); } } diff --git a/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java b/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java index 18258dc4ac..1197370e32 100644 --- a/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java +++ b/dspace-api/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java @@ -44,7 +44,7 @@ public class MockDSpaceRunnableScriptConfiguration args = constructArgs(dSpaceCommandLineParameters); diff --git a/dspace-server-webapp/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java b/dspace-server-webapp/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java index 366431e90b..1197370e32 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java +++ b/dspace-server-webapp/src/test/java/org/dspace/scripts/MockDSpaceRunnableScriptConfiguration.java @@ -44,7 +44,7 @@ public class MockDSpaceRunnableScriptConfiguration Date: Wed, 6 May 2020 11:49:39 +0200 Subject: [PATCH 042/125] [Task 70050] fixes after master merge --- .../org/dspace/app/rest/ProcessRestController.java | 13 +++++++------ .../app/rest/repository/ScriptRestRepository.java | 1 - 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessRestController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessRestController.java index 8c9cdd5200..66e6bbb47f 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessRestController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessRestController.java @@ -7,8 +7,7 @@ */ package org.dspace.app.rest; -import static org.springframework.hateoas.mvc.ControllerLinkBuilder.linkTo; -import static org.springframework.hateoas.mvc.ControllerLinkBuilder.methodOn; +import static org.springframework.hateoas.server.mvc.WebMvcLinkBuilder.methodOn; import java.sql.SQLException; import java.util.List; @@ -30,7 +29,8 @@ import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.data.web.PagedResourcesAssembler; import org.springframework.hateoas.Link; -import org.springframework.hateoas.PagedResources; +import org.springframework.hateoas.PagedModel; +import org.springframework.hateoas.server.mvc.WebMvcLinkBuilder; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; @@ -72,7 +72,7 @@ public class ProcessRestController { } @RequestMapping(method = RequestMethod.GET, value = "/{processId}/files/{fileType}") - public PagedResources listFilesWithTypeFromProcess( + public PagedModel listFilesWithTypeFromProcess( @PathVariable(name = "processId") Integer processId, @PathVariable(name = "fileType") String fileType, Pageable pageable, PagedResourcesAssembler assembler) throws SQLException, AuthorizeException { @@ -88,14 +88,15 @@ public class ProcessRestController { Page page = utils.getPage(bitstreamResources, pageable); - Link link = linkTo( + Link link = WebMvcLinkBuilder.linkTo( methodOn(this.getClass()).listFilesWithTypeFromProcess(processId, fileType, pageable, assembler)) .withSelfRel(); - PagedResources result = assembler.toResource(page, link); + PagedModel result = assembler.toModel(page, link); return result; } + @RequestMapping(method = RequestMethod.GET, value = "/{processId}/files/name/{fileName:.+}") public BitstreamResource getBitstreamByName(@PathVariable(name = "processId") Integer processId, @PathVariable(name = "fileName") String fileName) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java index cd826dfb49..a592e01cbd 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java @@ -29,7 +29,6 @@ import org.dspace.app.rest.model.ScriptRest; import org.dspace.app.rest.scripts.handler.impl.RestDSpaceRunnableHandler; import org.dspace.authorize.AuthorizeException; import org.dspace.core.Context; -import org.dspace.eperson.EPerson; import org.dspace.scripts.DSpaceCommandLineParameter; import org.dspace.scripts.DSpaceRunnable; import org.dspace.scripts.configuration.ScriptConfiguration; From 026c2308eccf07a5f60dbf9572c264c028598f48 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Wed, 6 May 2020 16:38:27 +0200 Subject: [PATCH 043/125] [Task 70750] made the Bitstream findAll endpoint not implemented --- .../repository/BitstreamRestRepository.java | 23 ++---------- .../app/rest/BitstreamRestRepositoryIT.java | 35 +++---------------- .../app/rest/EmptyRestRepositoryIT.java | 3 +- 3 files changed, 7 insertions(+), 54 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamRestRepository.java index 2d29781c9b..390f713d45 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamRestRepository.java @@ -10,17 +10,14 @@ package org.dspace.app.rest.repository; import java.io.IOException; import java.io.InputStream; import java.sql.SQLException; -import java.util.ArrayList; -import java.util.Iterator; -import java.util.List; import java.util.UUID; import javax.servlet.http.HttpServletRequest; import org.dspace.app.rest.exception.DSpaceBadRequestException; +import org.dspace.app.rest.exception.RepositoryMethodNotImplementedException; import org.dspace.app.rest.model.BitstreamRest; import org.dspace.app.rest.model.BundleRest; import org.dspace.app.rest.model.patch.Patch; -import org.dspace.app.rest.projection.Projection; import org.dspace.authorize.AuthorizeException; import org.dspace.authorize.service.AuthorizeService; import org.dspace.content.Bitstream; @@ -34,7 +31,6 @@ import org.dspace.content.service.CommunityService; import org.dspace.core.Context; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.domain.Page; -import org.springframework.data.domain.PageImpl; import org.springframework.data.domain.Pageable; import org.springframework.data.rest.webmvc.ResourceNotFoundException; import org.springframework.security.access.prepost.PreAuthorize; @@ -95,22 +91,7 @@ public class BitstreamRestRepository extends DSpaceObjectRestRepository findAll(Context context, Pageable pageable) { - List bit = new ArrayList(); - Iterator it = null; - int total = 0; - try { - total = bs.countTotal(context); - it = bs.findAll(context, pageable.getPageSize(), Math.toIntExact(pageable.getOffset())); - while (it.hasNext()) { - bit.add(it.next()); - } - } catch (SQLException e) { - throw new RuntimeException(e.getMessage(), e); - } - Projection projection = utils.obtainProjection(); - Page page = new PageImpl<>(bit, pageable, total) - .map((bitstream) -> converter.toRest(bitstream, projection)); - return page; + throw new RepositoryMethodNotImplementedException(BitstreamRest.NAME, "findAll"); } @Override diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/BitstreamRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/BitstreamRestRepositoryIT.java index d25fd0a33d..a63cd49823 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/BitstreamRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/BitstreamRestRepositoryIT.java @@ -39,7 +39,6 @@ import org.dspace.content.Community; import org.dspace.content.Item; import org.dspace.content.service.BitstreamService; import org.dspace.eperson.EPerson; -import org.hamcrest.Matchers; import org.junit.Ignore; import org.junit.Test; import org.springframework.beans.factory.annotation.Autowired; @@ -97,14 +96,8 @@ public class BitstreamRestRepositoryIT extends AbstractControllerIntegrationTest String token = getAuthToken(admin.getEmail(), password); - getClient(token).perform(get("/api/core/bitstreams/") - .param("projection", "full")) - .andExpect(status().isOk()) - .andExpect(content().contentType(contentType)) - .andExpect(jsonPath("$._embedded.bitstreams", Matchers.containsInAnyOrder( - BitstreamMatcher.matchBitstreamEntry(bitstream), - BitstreamMatcher.matchBitstreamEntry(bitstream1) - ))); + getClient(token).perform(get("/api/core/bitstreams/")) + .andExpect(status().isMethodNotAllowed()); } @Test @@ -158,33 +151,13 @@ public class BitstreamRestRepositoryIT extends AbstractControllerIntegrationTest getClient(token).perform(get("/api/core/bitstreams/") .param("size", "1") .param("projection", "full")) - .andExpect(status().isOk()) - .andExpect(content().contentType(contentType)) - .andExpect(jsonPath("$._embedded.bitstreams", Matchers.contains( - BitstreamMatcher.matchBitstreamEntry(bitstream)) - )) - .andExpect(jsonPath("$._embedded.bitstreams", Matchers.not( - Matchers.contains( - BitstreamMatcher.matchBitstreamEntry(bitstream1)) - ) - )) - - ; + .andExpect(status().isMethodNotAllowed()); getClient(token).perform(get("/api/core/bitstreams/") .param("size", "1") .param("page", "1") .param("projection", "full")) - .andExpect(status().isOk()) - .andExpect(content().contentType(contentType)) - .andExpect(jsonPath("$._embedded.bitstreams", Matchers.contains( - BitstreamMatcher.matchBitstreamEntry(bitstream1) - ))) - .andExpect(jsonPath("$._embedded.bitstreams", Matchers.not( - Matchers.contains( - BitstreamMatcher.matchBitstreamEntry(bitstream) - ) - ))); + .andExpect(status().isMethodNotAllowed()); getClient().perform(get("/api/core/bitstreams/")) .andExpect(status().isUnauthorized()); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/EmptyRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/EmptyRestRepositoryIT.java index 653ff072a0..af48a74cd3 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/EmptyRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/EmptyRestRepositoryIT.java @@ -38,7 +38,6 @@ public class EmptyRestRepositoryIT extends AbstractControllerIntegrationTest { //Test retrieval of all bitstreams while none exist getClient(token).perform(get("/api/core/bitstreams")) - . andExpect(status().isOk()) - .andExpect(jsonPath("$.page.totalElements", is(0))); + . andExpect(status().isMethodNotAllowed()); } } From b5bbc72eceb1fcf3b323007dfb57affe32109524 Mon Sep 17 00:00:00 2001 From: Yana De Pauw Date: Fri, 8 May 2020 12:57:07 +0200 Subject: [PATCH 044/125] 70815: Angular feedback --- .../SubmissionCCLicenseSearchController.java | 12 +++---- .../app/rest/model/PlainTextValueRest.java | 36 +++++++++++++++++++ ...SubmissionCCLicenseSearchControllerIT.java | 9 +++-- 3 files changed, 46 insertions(+), 11 deletions(-) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PlainTextValueRest.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java index 185fb7e8eb..26e52c8933 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java @@ -12,9 +12,8 @@ import java.util.Map; import javax.servlet.ServletRequest; import org.apache.commons.lang3.StringUtils; -import org.apache.logging.log4j.LogManager; -import org.apache.logging.log4j.Logger; import org.dspace.app.rest.exception.DSpaceBadRequestException; +import org.dspace.app.rest.model.PlainTextValueRest; import org.dspace.app.rest.model.SubmissionCCLicenseRest; import org.dspace.app.rest.utils.Utils; import org.dspace.license.service.CreativeCommonsService; @@ -24,7 +23,6 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.rest.webmvc.ResourceNotFoundException; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; -import org.springframework.web.bind.annotation.ResponseBody; import org.springframework.web.bind.annotation.RestController; /** @@ -35,8 +33,6 @@ import org.springframework.web.bind.annotation.RestController; "/rightsByQuestions") public class SubmissionCCLicenseSearchController { - private static final Logger log = LogManager.getLogger(); - @Autowired protected Utils utils; @@ -52,8 +48,7 @@ public class SubmissionCCLicenseSearchController { * @return the CC License URI as a string */ @RequestMapping(method = RequestMethod.GET) - @ResponseBody - public String findByRightsByQuestions() { + public PlainTextValueRest findByRightsByQuestions() { ServletRequest servletRequest = requestService.getCurrentRequest() .getServletRequest(); Map requestParameterMap = servletRequest @@ -90,6 +85,7 @@ public class SubmissionCCLicenseSearchController { if (StringUtils.isBlank(licenseUri)) { throw new ResourceNotFoundException("No CC License URI could be found for ID: " + licenseId); } - return licenseUri; + PlainTextValueRest plainTextValueRest = new PlainTextValueRest(licenseUri); + return plainTextValueRest; } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PlainTextValueRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PlainTextValueRest.java new file mode 100644 index 0000000000..6f02aa9286 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PlainTextValueRest.java @@ -0,0 +1,36 @@ +/** + * 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.rest.model; + +/** + * Rest object used to represent a plain text value + */ +public class PlainTextValueRest { + public static final String TYPE = "plaintextvalue"; + + private String value; + + public PlainTextValueRest() { + } + + public PlainTextValueRest(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + public void setValue(final String value) { + this.value = value; + } + + public String getType() { + return TYPE; + } +} diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java index 402f4c3a69..5c35bb5acf 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java @@ -8,8 +8,9 @@ package org.dspace.app.rest; +import static org.hamcrest.Matchers.is; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; -import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; import org.dspace.app.rest.test.AbstractControllerIntegrationTest; @@ -32,14 +33,16 @@ public class SubmissionCCLicenseSearchControllerIT extends AbstractControllerInt "/api/config/submissioncclicenses/search/rightsByQuestions?license=license2&answer_license2-field0" + "=license2-field0-enum1")) .andExpect(status().isOk()) - .andExpect(content().string("mock-license-uri")); + .andExpect(jsonPath("$.value", is("mock-license-uri"))) + .andExpect(jsonPath("$.type", is("plaintextvalue"))); } @Test public void searchRightsByQuestionsTestLicenseWithoutFields() throws Exception { getClient().perform(get("/api/config/submissioncclicenses/search/rightsByQuestions?license=license3")) .andExpect(status().isOk()) - .andExpect(content().string("mock-license-uri")); + .andExpect(jsonPath("$.value", is("mock-license-uri"))) + .andExpect(jsonPath("$.type", is("plaintextvalue"))); } @Test From 7fcb782230bb5b71a799322e23998d427aac5419 Mon Sep 17 00:00:00 2001 From: Peter Nijs Date: Mon, 11 May 2020 12:56:27 +0200 Subject: [PATCH 045/125] 70824: Configuration properties endpoint feedback --- .../link/PropertyResourceHalLinkFactory.java | 3 +++ .../dspace/app/rest/model/PropertyRest.java | 4 ++++ .../rest/model/hateoas/PropertyResource.java | 3 +++ .../ConfigurationRestRepository.java | 10 +++------- .../rest/exposed-properties-configuration.xml | 19 +++++++++---------- .../rest/exposed-properties-configuration.xml | 15 +++++++-------- 6 files changed, 29 insertions(+), 25 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/PropertyResourceHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/PropertyResourceHalLinkFactory.java index 39af3eefcf..98d06179d2 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/PropertyResourceHalLinkFactory.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/PropertyResourceHalLinkFactory.java @@ -15,6 +15,9 @@ import org.springframework.data.domain.Pageable; import org.springframework.hateoas.Link; import org.springframework.stereotype.Component; +/** + * This class' purpose is to remove all links from the PropertyResource. + */ @Component public class PropertyResourceHalLinkFactory extends HalLinkFactory { @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PropertyRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PropertyRest.java index 6cc2e02eaa..a6b6fa73af 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PropertyRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PropertyRest.java @@ -11,6 +11,10 @@ import java.util.List; import org.dspace.app.rest.RestResourceController; +/** + * This class acts as the REST representation of a DSpace configuration property. + * This class acts as a data holder for the PropertyResource + */ public class PropertyRest extends RestAddressableModel { public static final String NAME = "property"; public static final String CATEGORY = RestAddressableModel.CONFIGURATION; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/PropertyResource.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/PropertyResource.java index 1aa1007c52..96df54ce9a 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/PropertyResource.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/PropertyResource.java @@ -10,6 +10,9 @@ package org.dspace.app.rest.model.hateoas; import org.dspace.app.rest.model.PropertyRest; import org.dspace.app.rest.utils.Utils; +/** + * The purpose of this class is to wrap the information of the PropertyRest into a HAL resource + */ public class PropertyResource extends DSpaceResource { public PropertyResource(PropertyRest data, Utils utils) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRestRepository.java index 4fc1d48c6f..1b35d07794 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRestRepository.java @@ -49,16 +49,12 @@ public class ConfigurationRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { - throw new RepositoryMethodNotImplementedException("No implementation found; Method not allowed!", ""); + throw new RepositoryMethodNotImplementedException("No implementation found; Method not allowed", ""); } @Override diff --git a/dspace-server-webapp/src/test/data/dspaceFolder/config/spring/rest/exposed-properties-configuration.xml b/dspace-server-webapp/src/test/data/dspaceFolder/config/spring/rest/exposed-properties-configuration.xml index 78b1230af5..38e1f241f7 100644 --- a/dspace-server-webapp/src/test/data/dspaceFolder/config/spring/rest/exposed-properties-configuration.xml +++ b/dspace-server-webapp/src/test/data/dspaceFolder/config/spring/rest/exposed-properties-configuration.xml @@ -1,15 +1,14 @@ - - - - configuration.exposed.single.value - configuration.exposed.array.value - configuration.not.existing - - - + + + configuration.exposed.single.value + configuration.exposed.array.value + configuration.not.existing + \ No newline at end of file diff --git a/dspace/config/spring/rest/exposed-properties-configuration.xml b/dspace/config/spring/rest/exposed-properties-configuration.xml index 4604491099..159d2ed8a3 100644 --- a/dspace/config/spring/rest/exposed-properties-configuration.xml +++ b/dspace/config/spring/rest/exposed-properties-configuration.xml @@ -1,13 +1,12 @@ - - - - google.analytics.key - - - + + + google.analytics.key + \ No newline at end of file From adfce8e9f3dbe805325f94a24af3eb5a2de01253 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Wed, 13 May 2020 09:40:01 +0200 Subject: [PATCH 046/125] Fixed issues after master merge --- .../app/rest/WorkflowDefinitionCollectionsLinkRepository.java | 2 +- .../dspace/app/rest/WorkflowDefinitionStepsLinkRepository.java | 2 +- .../org/dspace/app/rest/WorkflowStepActionsLinkRepository.java | 2 +- .../java/org/dspace/app/rest/converter/ConverterService.java | 1 - .../org/dspace/app/rest/repository/VersionsLinkRepository.java | 2 +- .../java/org/dspace/app/rest/CollectionRestRepositoryIT.java | 1 - .../java/org/dspace/app/rest/converter/ConverterServiceIT.java | 1 - 7 files changed, 4 insertions(+), 7 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowDefinitionCollectionsLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowDefinitionCollectionsLinkRepository.java index 1f66c0928d..7ae5f5ecc0 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowDefinitionCollectionsLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowDefinitionCollectionsLinkRepository.java @@ -72,7 +72,7 @@ public class WorkflowDefinitionCollectionsLinkRepository extends AbstractDSpaceR collectionsMappedToWorkflow.addAll(xmlWorkflowFactory.getCollectionHandlesMappedToWorklow(context, workflowName)); Pageable pageable = optionalPageable != null ? optionalPageable : PageRequest.of(0, 20); - return converter.toRestPage(utils.getPage(collectionsMappedToWorkflow, pageable), + return converter.toRestPage(collectionsMappedToWorkflow, pageable, projection); } else { throw new ResourceNotFoundException("No workflow with name " + workflowName + " is configured"); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowDefinitionStepsLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowDefinitionStepsLinkRepository.java index 4fdc391641..24c82ee460 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowDefinitionStepsLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowDefinitionStepsLinkRepository.java @@ -55,7 +55,7 @@ public class WorkflowDefinitionStepsLinkRepository extends AbstractDSpaceRestRep try { List steps = xmlWorkflowFactory.getWorkflowByName(workflowName).getSteps(); Pageable pageable = optionalPageable != null ? optionalPageable : PageRequest.of(0, 20); - return converter.toRestPage(utils.getPage(steps, pageable), projection); + return converter.toRestPage(steps, pageable, projection); } catch (WorkflowConfigurationException e) { throw new ResourceNotFoundException("No workflow with name " + workflowName + " is configured"); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowStepActionsLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowStepActionsLinkRepository.java index 8ddab1381f..f2b6a423f8 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowStepActionsLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/WorkflowStepActionsLinkRepository.java @@ -52,6 +52,6 @@ public class WorkflowStepActionsLinkRepository extends AbstractDSpaceRestReposit Projection projection) { List actions = xmlWorkflowFactory.getStepByName(workflowStepName).getActions(); Pageable pageable = optionalPageable != null ? optionalPageable : PageRequest.of(0, 20); - return converter.toRestPage(utils.getPage(actions, pageable), projection); + return converter.toRestPage(actions, pageable, projection); } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java index 7ca38c3000..381fc84c4b 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java @@ -37,7 +37,6 @@ import org.springframework.data.domain.PageImpl; import org.springframework.data.domain.Pageable; import org.springframework.hateoas.EntityModel; import org.springframework.hateoas.Link; -import org.springframework.hateoas.Resource; import org.springframework.security.core.context.SecurityContextHolder; import org.springframework.stereotype.Component; import org.springframework.stereotype.Service; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/VersionsLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/VersionsLinkRepository.java index 4b17b46c91..e188b04950 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/VersionsLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/VersionsLinkRepository.java @@ -64,6 +64,6 @@ public class VersionsLinkRepository extends AbstractDSpaceRestRepository } List versions = versioningService.getVersionsByHistory(context, versionHistory); Pageable pageable = optionalPageable != null ? optionalPageable : PageRequest.of(0, 20); - return converter.toRestPage(utils.getPage(versions, pageable), projection); + return converter.toRestPage(versions, pageable, projection); } } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java index e39a2b5a5e..1600f8da65 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java @@ -29,7 +29,6 @@ import org.dspace.app.rest.builder.CollectionBuilder; import org.dspace.app.rest.builder.CommunityBuilder; import org.dspace.app.rest.builder.EPersonBuilder; import org.dspace.app.rest.builder.ResourcePolicyBuilder; -import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.converter.CollectionConverter; import org.dspace.app.rest.matcher.CollectionMatcher; import org.dspace.app.rest.matcher.CommunityMatcher; diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java index d933177fd1..a1d994f6de 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java @@ -39,7 +39,6 @@ import org.mockito.Mock; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.hateoas.EntityModel; import org.springframework.hateoas.Link; -import org.springframework.hateoas.Resource; import org.springframework.mock.web.MockHttpServletRequest; import org.springframework.mock.web.MockHttpServletResponse; From ea538d619b1d5dc226afe737ea92314eb808bfc6 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Wed, 13 May 2020 13:13:54 +0200 Subject: [PATCH 047/125] [Task 70871] fixed tests after master merge --- ...ctionBitstreamReadGroupLinkRepository.java | 3 ++ .../java/org/dspace/app/rest/utils/Utils.java | 6 +++- .../rest/CollectionGroupRestControllerIT.java | 29 +++++++++++++++++++ .../authorization/AdministratorFeatureIT.java | 29 ++++++++++++------- .../authorization/EnrollAdministratorIT.java | 8 ++--- 5 files changed, 59 insertions(+), 16 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionBitstreamReadGroupLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionBitstreamReadGroupLinkRepository.java index 57b17168ea..c1b322a490 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionBitstreamReadGroupLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionBitstreamReadGroupLinkRepository.java @@ -72,6 +72,9 @@ public class CollectionBitstreamReadGroupLinkRepository extends AbstractDSpaceRe } List bitstreamGroups = authorizeService .getAuthorizedGroups(context, collection, Constants.DEFAULT_BITSTREAM_READ); + if (bitstreamGroups == null || bitstreamGroups.isEmpty()) { + return null; + } Group bitstreamReadGroup = bitstreamGroups.get(0); if (bitstreamReadGroup == null) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/Utils.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/Utils.java index 15a0237d82..562312be76 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/Utils.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/Utils.java @@ -86,6 +86,7 @@ import org.springframework.data.domain.PageImpl; import org.springframework.data.domain.PageRequest; import org.springframework.data.domain.Pageable; import org.springframework.hateoas.Link; +import org.springframework.security.access.AccessDeniedException; import org.springframework.stereotype.Component; import org.springframework.web.multipart.MultipartFile; @@ -668,7 +669,10 @@ public class Utils { Object linkedObject = method.invoke(linkRepository, null, contentId, null, projection); resource.embedResource(rel, wrapForEmbedding(resource, linkedObject, link, oldLinks)); } catch (InvocationTargetException e) { - if (e.getTargetException() instanceof RuntimeException) { + // Can't do this beforehand because we lack information to call Evaluators + if (e.getTargetException() instanceof AccessDeniedException) { + log.warn("Tried fetching resource: " + linkRest.name() + " for DSpaceObject with ID: " + contentId); + } else if (e.getTargetException() instanceof RuntimeException) { throw (RuntimeException) e.getTargetException(); } else { throw new RuntimeException(e); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionGroupRestControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionGroupRestControllerIT.java index 0ce009a06e..f58e0c563e 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionGroupRestControllerIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionGroupRestControllerIT.java @@ -35,6 +35,7 @@ import org.dspace.eperson.Group; import org.dspace.eperson.service.GroupService; import org.dspace.workflow.WorkflowService; import org.junit.Before; +import org.junit.Ignore; import org.junit.Test; import org.springframework.beans.factory.annotation.Autowired; @@ -955,7 +956,10 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati jsonPath("$", GroupMatcher.matchGroupEntry(role.getID(), role.getName()))); } + // Put on ignore because there's no support to identify read rights on a group for a user in a special + // com/coll admin group @Test + @Ignore public void getCollectionDefaultItemReadGroupTestParentCommunityAdmin() throws Exception { context.turnOffAuthorisationSystem(); String itemGroupString = "ITEM"; @@ -973,7 +977,10 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati jsonPath("$", GroupMatcher.matchGroupEntry(role.getID(), role.getName()))); } + // Put on ignore because there's no support to identify read rights on a group for a user in a special + // com/coll admin group @Test + @Ignore public void getCollectionDefaultItemReadGroupTestCollectionAdmin() throws Exception { context.turnOffAuthorisationSystem(); String itemGroupString = "ITEM"; @@ -1096,7 +1103,11 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati } + + // Put on ignore because there's no support to identify read rights on a group for a user in a special + // com/coll admin group @Test + @Ignore public void postCollectionDefaultItemReadGroupCreateDefaultItemReadGroupSuccessParentCommunityAdmin() throws Exception { @@ -1129,7 +1140,11 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati } + + // Put on ignore because there's no support to identify read rights on a group for a user in a special + // com/coll admin group @Test + @Ignore public void postCollectionDefaultItemReadGroupCreateDefaultItemReadGroupSuccessCollectionAdmin() throws Exception { ObjectMapper mapper = new ObjectMapper(); @@ -1436,7 +1451,10 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati jsonPath("$", GroupMatcher.matchGroupEntry(role.getID(), role.getName()))); } + // Put on ignore because there's no support to identify read rights on a group for a user in a special + // com/coll admin group @Test + @Ignore public void getCollectionDefaultBitstreamReadGroupTestParentCommunityAdmin() throws Exception { context.turnOffAuthorisationSystem(); String bitstreamGroupString = "BITSTREAM"; @@ -1454,7 +1472,10 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati jsonPath("$", GroupMatcher.matchGroupEntry(role.getID(), role.getName()))); } + // Put on ignore because there's no support to identify read rights on a group for a user in a special + // com/coll admin group @Test + @Ignore public void getCollectionDefaultBitstreamReadGroupTestCollectionAdmin() throws Exception { context.turnOffAuthorisationSystem(); String bitstreamGroupString = "BITSTREAM"; @@ -1580,7 +1601,11 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati } + + // Put on ignore because there's no support to identify read rights on a group for a user in a special + // com/coll admin group @Test + @Ignore public void postCollectionDefaultBitstreamReadGroupCreateDefaultBitstreamReadGroupSuccessParentCommunityAdmin() throws Exception { @@ -1613,7 +1638,11 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati } + + // Put on ignore because there's no support to identify read rights on a group for a user in a special + // com/coll admin group @Test + @Ignore public void postCollectionDefaultBitstreamReadGroupCreateDefaultBitstreamReadGroupSuccessCollectionAdmin() throws Exception { diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/AdministratorFeatureIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/AdministratorFeatureIT.java index cb326d41c7..e1e89cda02 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/AdministratorFeatureIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/AdministratorFeatureIT.java @@ -15,7 +15,9 @@ import org.dspace.app.rest.authorization.impl.AdministratorOfFeature; import org.dspace.app.rest.builder.CollectionBuilder; import org.dspace.app.rest.builder.CommunityBuilder; import org.dspace.app.rest.builder.EPersonBuilder; -import org.dspace.app.rest.converter.ConverterService; +import org.dspace.app.rest.converter.CollectionConverter; +import org.dspace.app.rest.converter.CommunityConverter; +import org.dspace.app.rest.converter.SiteConverter; import org.dspace.app.rest.matcher.AuthorizationMatcher; import org.dspace.app.rest.model.CollectionRest; import org.dspace.app.rest.model.CommunityRest; @@ -47,13 +49,17 @@ public class AdministratorFeatureIT extends AbstractControllerIntegrationTest { @Autowired private AuthorizationFeatureService authorizationFeatureService; @Autowired - private ConverterService converterService; - @Autowired GroupService groupService; @Autowired AuthorizeService authService; @Autowired CommunityService communityService; + @Autowired + private CommunityConverter communityConverter; + @Autowired + private CollectionConverter collectionConverter; + @Autowired + private SiteConverter siteConverter; private SiteService siteService; @@ -103,9 +109,10 @@ public class AdministratorFeatureIT extends AbstractControllerIntegrationTest { context.restoreAuthSystemState(); - CommunityRest communityRestA = converterService.toRest(communityA, DefaultProjection.DEFAULT); - CommunityRest SubCommunityOfArest = converterService.toRest(subCommunityOfA, DefaultProjection.DEFAULT); - CollectionRest collectionRestOfSubComm = converterService.toRest(collectionOfSubComm,DefaultProjection.DEFAULT); + CommunityRest communityRestA = communityConverter.convert(communityA, DefaultProjection.DEFAULT); + CommunityRest SubCommunityOfArest = communityConverter.convert(subCommunityOfA, DefaultProjection.DEFAULT); + CollectionRest collectionRestOfSubComm = collectionConverter.convert(collectionOfSubComm, + DefaultProjection.DEFAULT); // tokens String tokenAdminComA = getAuthToken(adminComA.getEmail(), password); @@ -170,8 +177,8 @@ public class AdministratorFeatureIT extends AbstractControllerIntegrationTest { context.restoreAuthSystemState(); - CollectionRest collectionRestA = converterService.toRest(collectionA, DefaultProjection.DEFAULT); - CollectionRest collectionRestB = converterService.toRest(collectionB, DefaultProjection.DEFAULT); + CollectionRest collectionRestA = collectionConverter.convert(collectionA, DefaultProjection.DEFAULT); + CollectionRest collectionRestB = collectionConverter.convert(collectionB, DefaultProjection.DEFAULT); String tokenAdminColA = getAuthToken(adminColA.getEmail(), password); String tokenAdminColB = getAuthToken(adminColB.getEmail(), password); @@ -210,9 +217,9 @@ public class AdministratorFeatureIT extends AbstractControllerIntegrationTest { context.restoreAuthSystemState(); Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, DefaultProjection.DEFAULT); - CommunityRest communityRest = converterService.toRest(parentCommunity, DefaultProjection.DEFAULT); - CollectionRest collectionRest = converterService.toRest(collection, DefaultProjection.DEFAULT); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); + CommunityRest communityRest = communityConverter.convert(parentCommunity, DefaultProjection.DEFAULT); + CollectionRest collectionRest = collectionConverter.convert(collection, DefaultProjection.DEFAULT); // tokens String tokenAdmin = getAuthToken(admin.getEmail(), password); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/EnrollAdministratorIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/EnrollAdministratorIT.java index ddc879947f..2be3ed9466 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/EnrollAdministratorIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/authorization/EnrollAdministratorIT.java @@ -16,7 +16,7 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers. import org.dspace.app.rest.authorization.impl.AdministratorOfFeature; import org.dspace.app.rest.builder.EPersonBuilder; -import org.dspace.app.rest.converter.ConverterService; +import org.dspace.app.rest.converter.SiteConverter; import org.dspace.app.rest.matcher.AuthorizationMatcher; import org.dspace.app.rest.model.SiteRest; import org.dspace.app.rest.projection.DefaultProjection; @@ -44,9 +44,9 @@ public class EnrollAdministratorIT extends AbstractControllerIntegrationTest { @Autowired private AuthorizationFeatureService authorizationFeatureService; @Autowired - private ConverterService converterService; - @Autowired GroupService groupService; + @Autowired + private SiteConverter siteConverter; private SiteService siteService; @@ -76,7 +76,7 @@ public class EnrollAdministratorIT extends AbstractControllerIntegrationTest { context.restoreAuthSystemState(); Site site = siteService.findSite(context); - SiteRest siteRest = converterService.toRest(site, DefaultProjection.DEFAULT); + SiteRest siteRest = siteConverter.convert(site, DefaultProjection.DEFAULT); Group adminGroup = groupService.findByName(context, Group.ADMIN); From 262d81a33f25992311aa32363c15ab24386bdcb4 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Wed, 13 May 2020 14:50:42 +0200 Subject: [PATCH 048/125] [Task 70871] implemented default preauthorize setting --- .../app/rest/repository/BitstreamFormatRestRepository.java | 1 + .../dspace/app/rest/repository/BrowseIndexRestRepository.java | 2 ++ .../org/dspace/app/rest/repository/DSpaceRestRepository.java | 2 ++ .../dspace/app/rest/repository/EntityTypeRestRepository.java | 2 ++ .../app/rest/repository/ExternalSourceRestRepository.java | 2 ++ .../dspace/app/rest/repository/MetadataFieldRestRepository.java | 1 + .../app/rest/repository/MetadataSchemaRestRepository.java | 1 + .../dspace/app/rest/repository/RelationshipRestRepository.java | 2 ++ .../app/rest/repository/RelationshipTypeRestRepository.java | 2 ++ .../org/dspace/app/rest/repository/ScriptRestRepository.java | 2 ++ .../java/org/dspace/app/rest/repository/SiteRestRepository.java | 1 + 11 files changed, 18 insertions(+) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamFormatRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamFormatRestRepository.java index d710f41f91..49585ee9db 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamFormatRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamFormatRestRepository.java @@ -42,6 +42,7 @@ public class BitstreamFormatRestRepository extends DSpaceRestRepository { @Override + @PreAuthorize("permitAll()") public BrowseIndexRest findOne(Context context, String name) { BrowseIndexRest bi = null; BrowseIndex bix; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/DSpaceRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/DSpaceRestRepository.java index 97c13a6656..e8bf235940 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/DSpaceRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/DSpaceRestRepository.java @@ -32,6 +32,7 @@ import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.data.domain.Sort; import org.springframework.data.repository.PagingAndSortingRepository; +import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.web.multipart.MultipartFile; /** @@ -122,6 +123,7 @@ public abstract class DSpaceRestRepository Date: Mon, 18 May 2020 14:48:39 +0200 Subject: [PATCH 049/125] [Task 70911] applied feedback to the Scripts and Processes functionality --- .../org/dspace/app/bulkedit/DSpaceCSV.java | 10 +++-- .../dspace/app/bulkedit/MetadataExport.java | 6 ++- .../org/dspace/scripts/DSpaceRunnable.java | 3 ++ .../dspace/scripts/ProcessServiceImpl.java | 4 +- .../app/rest/ProcessRestController.java | 18 --------- .../link/process/ProcessHalLinkFactory.java | 5 +++ .../ProcessResourceHalLinkFactory.java | 8 +++- .../rest/model/ProcessFileWrapperRest.java | 17 +++++++- .../dspace/app/rest/model/ProcessRest.java | 8 +++- .../hateoas/ProcessFileWrapperResource.java | 13 +++++- .../ProcessFilesLinkRepository.java | 40 +++++++++++++++++++ .../repository/ProcessRestRepository.java | 31 ++++++++++++++ dspace/config/dspace.cfg | 2 +- dspace/config/registries/dspace-types.xml | 20 ++++++++++ dspace/config/registries/process-types.xml | 20 ---------- 15 files changed, 155 insertions(+), 50 deletions(-) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java create mode 100644 dspace/config/registries/dspace-types.xml delete mode 100644 dspace/config/registries/process-types.xml diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/DSpaceCSV.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/DSpaceCSV.java index d85f327092..ad7824bebf 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/DSpaceCSV.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/DSpaceCSV.java @@ -11,6 +11,7 @@ import java.io.BufferedReader; import java.io.InputStream; import java.io.InputStreamReader; import java.io.Serializable; +import java.nio.charset.StandardCharsets; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; @@ -24,7 +25,6 @@ import java.util.regex.Pattern; import org.apache.commons.io.IOUtils; import org.apache.commons.lang3.StringUtils; -import org.apache.pdfbox.util.Charsets; import org.dspace.authority.AuthorityValue; import org.dspace.authority.factory.AuthorityServiceFactory; import org.dspace.authority.service.AuthorityValueService; @@ -149,7 +149,7 @@ public class DSpaceCSV implements Serializable { // Open the CSV file BufferedReader input = null; try { - input = new BufferedReader(new InputStreamReader(inputStream, "UTF-8")); + input = new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8)); // Read the heading line String head = input.readLine(); @@ -619,12 +619,16 @@ public class DSpaceCSV implements Serializable { return csvLines; } + /** + * Creates and returns an InputStream from the CSV Lines in this DSpaceCSV + * @return The InputStream created from the CSVLines in this DSpaceCSV + */ public InputStream getInputStream() { StringBuilder stringBuilder = new StringBuilder(); for (String csvLine : getCSVLinesAsStringArray()) { stringBuilder.append(csvLine + "\n"); } - return IOUtils.toInputStream(stringBuilder.toString(), Charsets.UTF_8); + return IOUtils.toInputStream(stringBuilder.toString(), StandardCharsets.UTF_8); } /** diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java index 783b2c7e93..b3e00bd99f 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java @@ -31,11 +31,14 @@ public class MetadataExport extends DSpaceRunnable implements R */ protected CommandLine commandLine; + /** + * This EPerson identifier variable is the uuid of the eperson that's running the script + */ private UUID epersonIdentifier; /** diff --git a/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java b/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java index 5fa8ec7699..68b6613193 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java @@ -136,7 +136,7 @@ public class ProcessServiceImpl implements ProcessService { Bitstream bitstream = bitstreamService.create(context, is); bitstream.setName(context, fileName); bitstreamService.setFormat(context, bitstream, bitstreamFormatService.guessFormat(context, bitstream)); - bitstreamService.addMetadata(context, bitstream, "process", "type", null, null, type); + bitstreamService.addMetadata(context, bitstream, "dspace", "process", "type", null, type); authorizeService.addPolicy(context, bitstream, Constants.READ, context.getCurrentUser()); authorizeService.addPolicy(context, bitstream, Constants.WRITE, context.getCurrentUser()); authorizeService.addPolicy(context, bitstream, Constants.DELETE, context.getCurrentUser()); @@ -197,7 +197,7 @@ public class ProcessServiceImpl implements ProcessService { } else { List filteredBitstreams = new ArrayList<>(); for (Bitstream bitstream : allBitstreams) { - if (StringUtils.equals(bitstreamService.getMetadata(bitstream, "process.type"), type)) { + if (StringUtils.equals(bitstreamService.getMetadata(bitstream, "dspace.process.type"), type)) { filteredBitstreams.add(bitstream); } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessRestController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessRestController.java index 66e6bbb47f..edf79003b7 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessRestController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessRestController.java @@ -20,7 +20,6 @@ import org.dspace.app.rest.link.process.ProcessResourceHalLinkFactory; import org.dspace.app.rest.model.BitstreamRest; import org.dspace.app.rest.model.ProcessRest; import org.dspace.app.rest.model.hateoas.BitstreamResource; -import org.dspace.app.rest.model.hateoas.ProcessFileWrapperResource; import org.dspace.app.rest.repository.ProcessRestRepository; import org.dspace.app.rest.utils.Utils; import org.dspace.authorize.AuthorizeException; @@ -51,26 +50,9 @@ public class ProcessRestController { @Autowired private Utils utils; - @Autowired - private HalLinkService halLinkService; - @Autowired ProcessResourceHalLinkFactory processResourceHalLinkFactory; - @RequestMapping(method = RequestMethod.GET, value = "/{processId}/files") - public ProcessFileWrapperResource listFilesFromProcess(@PathVariable(name = "processId") Integer processId) - throws SQLException, AuthorizeException { - - if (log.isTraceEnabled()) { - log.trace("Retrieving Files from Process with ID: " + processId); - } - - ProcessFileWrapperResource processFileWrapperResource = - new ProcessFileWrapperResource(processRestRepository.getProcessFileWrapperRest(processId), utils); - halLinkService.addLinks(processFileWrapperResource); - return processFileWrapperResource; - } - @RequestMapping(method = RequestMethod.GET, value = "/{processId}/files/{fileType}") public PagedModel listFilesWithTypeFromProcess( @PathVariable(name = "processId") Integer processId, diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessHalLinkFactory.java index 11fcb1b71c..aef3c81081 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessHalLinkFactory.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessHalLinkFactory.java @@ -10,5 +10,10 @@ package org.dspace.app.rest.link.process; import org.dspace.app.rest.ProcessRestController; import org.dspace.app.rest.link.HalLinkFactory; +/** + * This abstract class offers an easily extendable HalLinkFactory class to use methods on the ProcessRestController + * and make it more easy to read or define which methods should be found in the getMethodOn methods when building links + * @param This parameter should be of type {@link org.dspace.app.rest.model.hateoas.HALResource} + */ public abstract class ProcessHalLinkFactory extends HalLinkFactory { } \ No newline at end of file diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java index 41b9f81d28..2e69443218 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java @@ -17,24 +17,30 @@ import org.springframework.data.domain.Pageable; import org.springframework.hateoas.Link; import org.springframework.stereotype.Component; +/** + * This HalLinkFactory provides the {@link ProcessResource} with links + */ @Component public class ProcessResourceHalLinkFactory extends ProcessHalLinkFactory { @Autowired private ConfigurationService configurationService; + @Override protected void addLinks(ProcessResource halResource, Pageable pageable, LinkedList list) throws Exception { String dspaceRestUrl = configurationService.getProperty("dspace.server.url"); - list.add(buildLink("files", getMethodOn().listFilesFromProcess(halResource.getContent().getProcessId()))); +// list.add(buildLink("files", getMethodOn().listFilesFromProcess(halResource.getContent().getProcessId()))); list.add( buildLink("script", dspaceRestUrl + "/api/system/scripts/" + halResource.getContent().getScriptName())); } + @Override protected Class getControllerClass() { return ProcessRestController.class; } + @Override protected Class getResourceClass() { return ProcessResource.class; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileWrapperRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileWrapperRest.java index df9059393e..38755ab928 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileWrapperRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileWrapperRest.java @@ -11,7 +11,12 @@ import java.util.List; import com.fasterxml.jackson.annotation.JsonIgnore; -public class ProcessFileWrapperRest { + +/** + * The ProcessFileWrapper REST Resource + * + */ +public class ProcessFileWrapperRest implements RestModel { private Integer processId; @JsonIgnore @@ -32,4 +37,14 @@ public class ProcessFileWrapperRest { public List getBitstreams() { return bitstreams; } + + @Override + public String getType() { + return "processfilewrapper"; + } + + @Override + public String getTypePlural() { + return "processfilewrappers"; + } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessRest.java index 6d3ddfae43..a5206c72b2 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessRest.java @@ -20,12 +20,18 @@ import org.dspace.scripts.Process; /** * This class serves as a REST representation for the {@link Process} class */ +@LinksRest(links = { + @LinkRest( + name = ProcessRest.FILES, + method = "getFilesFromProcess" + ), +}) public class ProcessRest extends BaseObjectRest { public static final String NAME = "process"; public static final String PLURAL_NAME = "processes"; public static final String CATEGORY = RestAddressableModel.SYSTEM; - + public static final String FILES = "files"; public String getCategory() { return CATEGORY; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileWrapperResource.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileWrapperResource.java index e2ca726bb7..bc1f6809c8 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileWrapperResource.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileWrapperResource.java @@ -17,16 +17,25 @@ import org.dspace.app.rest.model.MetadataValueRest; import org.dspace.app.rest.model.ProcessFileWrapperRest; import org.dspace.app.rest.utils.Utils; - +/** + * This is the Resource object for the {@link ProcessFileWrapperRest} + * It'll create a Resource object to return and include the associated bitstreams in an embed that's properly + * made for the type of file that that particular bitstream is + */ public class ProcessFileWrapperResource extends HALResource { + /** + * Constructor for this object. Calls on super and creates separate embedded lists + * @param content The {@link ProcessFileWrapperRest} object associated with this resource + * @param utils Utils class + */ public ProcessFileWrapperResource(ProcessFileWrapperRest content, Utils utils) { super(content); if (content != null) { HashMap> bitstreamResourceMap = new HashMap<>(); for (BitstreamRest bitstreamRest : content.getBitstreams()) { - List fileType = bitstreamRest.getMetadata().getMap().get("process.type"); + List fileType = bitstreamRest.getMetadata().getMap().get("dspace.process.type"); if (fileType != null && !fileType.isEmpty()) { bitstreamResourceMap .computeIfAbsent(fileType.get(0).getValue(), k -> new ArrayList<>()) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java new file mode 100644 index 0000000000..89d9d3531a --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java @@ -0,0 +1,40 @@ +/** + * 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.rest.repository; + +import java.sql.SQLException; +import javax.annotation.Nullable; +import javax.servlet.http.HttpServletRequest; + +import org.dspace.app.rest.model.ProcessFileWrapperRest; +import org.dspace.app.rest.model.ProcessRest; +import org.dspace.app.rest.projection.Projection; +import org.dspace.authorize.AuthorizeException; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.data.domain.Pageable; +import org.springframework.stereotype.Component; + +@Component(ProcessRest.CATEGORY + "." + ProcessRest.NAME + "." + ProcessRest.FILES) +public class ProcessFilesLinkRepository extends AbstractDSpaceRestRepository implements LinkRestRepository { + + @Autowired + private ProcessRestRepository processRestRepository; + + public ProcessFileWrapperRest getFilesFromProcess(@Nullable HttpServletRequest request, + Integer processId, + @Nullable Pageable optionalPageable, + Projection projection) throws SQLException, AuthorizeException { + + + ProcessFileWrapperRest processFileWrapperRest = new ProcessFileWrapperRest(); + processFileWrapperRest.setBitstreams(processRestRepository.getProcessBitstreams(processId)); + processFileWrapperRest.setProcessId(processId); + + return processFileWrapperRest; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java index 590b51edaf..15d5cf6530 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java @@ -78,10 +78,25 @@ public class ProcessRestRepository extends DSpaceRestRepository getProcessBitstreams(Integer processId) throws SQLException, AuthorizeException { return getProcessBitstreamsByType(processId, null); } + /** + * Creates a ProcessFileWrapperRest object for the given ProcessId by setting the ProcessId on this object + * and getting the Bitstreams for this project and setting this on the REST object + * @param processId The given ProcessId + * @return The ProcessFileWrapperRest object with the ProcessId and the list of bitstreams filled in + * @throws SQLException If something goes wrong + * @throws AuthorizeException If something goes wrong + */ public ProcessFileWrapperRest getProcessFileWrapperRest(Integer processId) throws SQLException, AuthorizeException { ProcessFileWrapperRest processFileWrapperRest = new ProcessFileWrapperRest(); processFileWrapperRest.setBitstreams(getProcessBitstreams(processId)); @@ -90,6 +105,14 @@ public class ProcessRestRepository extends DSpaceRestRepository getProcessBitstreamsByType(Integer processId, String type) throws SQLException, AuthorizeException { Context context = obtainContext(); @@ -114,6 +137,14 @@ public class ProcessRestRepository extends DSpaceRestRepository + + + DSpace Types + + + + dspace + http://dspace.org/dspace + + + + dspace + process + type + + + + + diff --git a/dspace/config/registries/process-types.xml b/dspace/config/registries/process-types.xml deleted file mode 100644 index 672f8f94bf..0000000000 --- a/dspace/config/registries/process-types.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - - DSpace Process Types - - - - process - http://dspace.org/process - - - - process - type - - - - - - From 5b0bf29fd40ddc2247c1d2867594bd257beb094d Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Mon, 18 May 2020 14:52:13 +0200 Subject: [PATCH 050/125] Cleanup comment --- .../app/rest/link/process/ProcessResourceHalLinkFactory.java | 1 - 1 file changed, 1 deletion(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java index 2e69443218..fcf0945a96 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java @@ -29,7 +29,6 @@ public class ProcessResourceHalLinkFactory extends ProcessHalLinkFactory list) throws Exception { String dspaceRestUrl = configurationService.getProperty("dspace.server.url"); -// list.add(buildLink("files", getMethodOn().listFilesFromProcess(halResource.getContent().getProcessId()))); list.add( buildLink("script", dspaceRestUrl + "/api/system/scripts/" + halResource.getContent().getScriptName())); From 34bf7dd76b09bd20226e8b4a2317bae472eaf8d7 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Mon, 18 May 2020 15:54:38 +0200 Subject: [PATCH 051/125] [Task 70927] applied feedback on the subresources permissions functionality --- .../org/dspace/app/rest/RestResourceController.java | 13 +------------ .../dspace/app/rest/converter/ConverterService.java | 3 ++- .../main/java/org/dspace/app/rest/utils/Utils.java | 5 ++++- .../app/rest/CollectionGroupRestControllerIT.java | 8 ++++++++ .../app/rest/converter/ConverterServiceIT.java | 5 +++++ 5 files changed, 20 insertions(+), 14 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java index bc412b35fd..a1684d782e 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java @@ -813,7 +813,7 @@ public class RestResourceController implements InitializingBean { } return new EntityModel(new EmbeddedPage(link.getHref(), - pageResult.map(converter::toResource), null, subpath)); + pageResult.map(converter::toResource), null, subpath)); } else { RestModel object = (RestModel) linkMethod.invoke(linkRepository, request, uuid, page, utils.obtainProjection()); @@ -895,17 +895,6 @@ public class RestResourceController implements InitializingBean { } - private Page getRestModelsWithoutNullValues(Pageable page, - Page pageResult) { - ArrayList content = new ArrayList<>(); - pageResult.getContent().forEach(o -> { - if (o != null) { - content.add(o); - } - }); - return (Page) new PageImpl(content, page, pageResult.getTotalElements()); - } - /** * Find all * diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java index 381fc84c4b..59ee666cfe 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java @@ -96,7 +96,8 @@ public class ConverterService { if (restObject instanceof BaseObjectRest) { if (!dSpacePermissionEvaluator.hasPermission(SecurityContextHolder.getContext().getAuthentication(), restObject, "READ")) { - log.info("Access denied on " + restObject.getClass()); + log.debug("Access denied on " + restObject.getClass() + " with id: " + + ((BaseObjectRest) restObject).getId()); return null; } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/Utils.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/Utils.java index 562312be76..5ab839fbe2 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/Utils.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/Utils.java @@ -669,7 +669,10 @@ public class Utils { Object linkedObject = method.invoke(linkRepository, null, contentId, null, projection); resource.embedResource(rel, wrapForEmbedding(resource, linkedObject, link, oldLinks)); } catch (InvocationTargetException e) { - // Can't do this beforehand because we lack information to call Evaluators + // This will be thrown from the LinkRepository if a Resource has been requested that'll try to embed + // something that we don't have READ rights to. It'll then throw an AccessDeniedException from that + // linkRepository and we want to catch it here since we don't want our entire request to fail if a + // subresource of the requested resource is not available to be embedded. Instead we'll log it here if (e.getTargetException() instanceof AccessDeniedException) { log.warn("Tried fetching resource: " + linkRest.name() + " for DSpaceObject with ID: " + contentId); } else if (e.getTargetException() instanceof RuntimeException) { diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionGroupRestControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionGroupRestControllerIT.java index f58e0c563e..04cade01a7 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionGroupRestControllerIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionGroupRestControllerIT.java @@ -958,6 +958,7 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati // Put on ignore because there's no support to identify read rights on a group for a user in a special // com/coll admin group + // Please refer to: https://jira.lyrasis.org/browse/DS-4505 @Test @Ignore public void getCollectionDefaultItemReadGroupTestParentCommunityAdmin() throws Exception { @@ -979,6 +980,7 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati // Put on ignore because there's no support to identify read rights on a group for a user in a special // com/coll admin group + // Please refer to: https://jira.lyrasis.org/browse/DS-4505 @Test @Ignore public void getCollectionDefaultItemReadGroupTestCollectionAdmin() throws Exception { @@ -1106,6 +1108,7 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati // Put on ignore because there's no support to identify read rights on a group for a user in a special // com/coll admin group + // Please refer to: https://jira.lyrasis.org/browse/DS-4505 @Test @Ignore public void postCollectionDefaultItemReadGroupCreateDefaultItemReadGroupSuccessParentCommunityAdmin() @@ -1143,6 +1146,7 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati // Put on ignore because there's no support to identify read rights on a group for a user in a special // com/coll admin group + // Please refer to: https://jira.lyrasis.org/browse/DS-4505 @Test @Ignore public void postCollectionDefaultItemReadGroupCreateDefaultItemReadGroupSuccessCollectionAdmin() throws Exception { @@ -1453,6 +1457,7 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati // Put on ignore because there's no support to identify read rights on a group for a user in a special // com/coll admin group + // Please refer to: https://jira.lyrasis.org/browse/DS-4505 @Test @Ignore public void getCollectionDefaultBitstreamReadGroupTestParentCommunityAdmin() throws Exception { @@ -1474,6 +1479,7 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati // Put on ignore because there's no support to identify read rights on a group for a user in a special // com/coll admin group + // Please refer to: https://jira.lyrasis.org/browse/DS-4505 @Test @Ignore public void getCollectionDefaultBitstreamReadGroupTestCollectionAdmin() throws Exception { @@ -1604,6 +1610,7 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati // Put on ignore because there's no support to identify read rights on a group for a user in a special // com/coll admin group + // Please refer to: https://jira.lyrasis.org/browse/DS-4505 @Test @Ignore public void postCollectionDefaultBitstreamReadGroupCreateDefaultBitstreamReadGroupSuccessParentCommunityAdmin() @@ -1641,6 +1648,7 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati // Put on ignore because there's no support to identify read rights on a group for a user in a special // com/coll admin group + // Please refer to: https://jira.lyrasis.org/browse/DS-4505 @Test @Ignore public void postCollectionDefaultBitstreamReadGroupCreateDefaultBitstreamReadGroupSuccessCollectionAdmin() diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java index a1d994f6de..e1d2e2d089 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java @@ -67,6 +67,11 @@ public class ConverterServiceIT extends AbstractControllerIntegrationTest { @Before public void setup() { + // We're mocking a request here because we've started using the Context in the ConverterService#toRest + // method by invoking the DSpacePermissionEvaluator. This will traverse the RestPermissionEvaluatorPlugins + // and thus also invoke the AdminRestPermissionEvaluator which will try to retrieve the Context from a + // Request. This Request isn't available through tests on itself and thus we have to mock it here to avoid + // the PermissionEvaluator from crashing because of this. MockHttpServletRequest mockHttpServletRequest = new MockHttpServletRequest(); mockHttpServletRequest.setAttribute("dspace.context", new Context()); MockHttpServletResponse mockHttpServletResponse = new MockHttpServletResponse(); From 68b91aa8f04ac71c1d469c8db704601853b26d8a Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Tue, 19 May 2020 15:56:07 +0200 Subject: [PATCH 052/125] Applied feedback to the subresource permissions functionality --- .../org/dspace/app/rest/repository/ScriptRestRepository.java | 2 +- .../rest/scripts/handler/impl/RestDSpaceRunnableHandler.java | 4 ++-- .../AuthorizationFeatureRestPermissionEvaluatorPlugin.java | 4 ++-- .../rest/security/ScriptRestPermissionEvaluatorPlugin.java | 3 +++ 4 files changed, 8 insertions(+), 5 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java index 43eb7980df..5575f85ced 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ScriptRestRepository.java @@ -102,7 +102,7 @@ public class ScriptRestRepository extends DSpaceRestRepository args = constructArgs(dSpaceCommandLineParameters); runDSpaceScript(scriptToExecute, restDSpaceRunnableHandler, args); - return converter.toRest(restDSpaceRunnableHandler.getProcess(), utils.obtainProjection()); + return converter.toRest(restDSpaceRunnableHandler.getProcess(context), utils.obtainProjection()); } private List processPropertiesToDSpaceCommandLineParameters(String propertiesJson) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java index 66279699e5..5f2ad81909 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java @@ -179,9 +179,9 @@ public class RestDSpaceRunnableHandler implements DSpaceRunnableHandler { /** * This method will return the process created by this handler * @return The Process database object created by this handler + * @param context */ - public Process getProcess() { - Context context = new Context(); + public Process getProcess(Context context) { try { return processService.find(context, processId); } catch (SQLException e) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationFeatureRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationFeatureRestPermissionEvaluatorPlugin.java index 3552c47994..2a2dec0655 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationFeatureRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationFeatureRestPermissionEvaluatorPlugin.java @@ -15,8 +15,8 @@ import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; /** - * This class determines that any AuthorizationFeatureRest object can be viewed as it'll be a subresource of - * AuthorizationRest + * This class will handle calls made to AuthorizationRest endpoints. It will return true because access can be granted + * anytime it's linked from another resource. */ @Component public class AuthorizationFeatureRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ScriptRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ScriptRestPermissionEvaluatorPlugin.java index 116f5adf1c..3672ad47c4 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ScriptRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ScriptRestPermissionEvaluatorPlugin.java @@ -14,6 +14,9 @@ import org.dspace.app.rest.model.ScriptRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; +/** + * This class will handle Permissions for the {@link ScriptRest} object and its calls + */ @Component public class ScriptRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { @Override From bfa83b75993edd7d428c6e5d25aa49586b754394 Mon Sep 17 00:00:00 2001 From: Kevin Van de Velde Date: Wed, 20 May 2020 13:09:33 +0200 Subject: [PATCH 053/125] Disabling the CC License step in the default configuration --- .../dspaceFolder/config/item-submission.xml | 282 ++++++++++++++++++ dspace/config/item-submission.xml | 8 +- 2 files changed, 287 insertions(+), 3 deletions(-) create mode 100644 dspace-server-webapp/src/test/data/dspaceFolder/config/item-submission.xml diff --git a/dspace-server-webapp/src/test/data/dspaceFolder/config/item-submission.xml b/dspace-server-webapp/src/test/data/dspaceFolder/config/item-submission.xml new file mode 100644 index 0000000000..481b508176 --- /dev/null +++ b/dspace-server-webapp/src/test/data/dspaceFolder/config/item-submission.xml @@ -0,0 +1,282 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + org.dspace.app.rest.submit.step.CollectionStep + collection + submission + + + submit.progressbar.describe.stepone + org.dspace.app.rest.submit.step.DescribeStep + submission-form + + + submit.progressbar.describe.steptwo + org.dspace.app.rest.submit.step.DescribeStep + submission-form + + + + submit.progressbar.describe.stepone + org.dspace.app.rest.submit.step.DescribeStep + submission-form + + + submit.progressbar.describe.stepone + org.dspace.app.rest.submit.step.DescribeStep + submission-form + + + submit.progressbar.describe.stepone + org.dspace.app.rest.submit.step.DescribeStep + submission-form + + + submit.progressbar.describe.stepone + org.dspace.app.rest.submit.step.DescribeStep + submission-form + + + submit.progressbar.describe.stepone + org.dspace.app.rest.submit.step.DescribeStep + submission-form + + + submit.progressbar.describe.stepone + org.dspace.app.rest.submit.step.DescribeStep + submission-form + + + + submit.progressbar.upload + org.dspace.app.rest.submit.step.UploadStep + upload + + + submit.progressbar.license + org.dspace.app.rest.submit.step.LicenseStep + license + submission + + + + + + + + submit.progressbar.CClicense + org.dspace.app.rest.submit.step.CCLicenseStep + cclicense + + + + + + + + + + + + + submit.progressbar.describe.stepone + org.dspace.app.rest.submit.step.DescribeStep + submission-form + + + submit.progressbar.describe.stepone + org.dspace.app.rest.submit.step.DescribeStep + submission-form + + + submit.progressbar.describe.stepone + org.dspace.app.rest.submit.step.DescribeStep + submission-form + + + submit.progressbar.describe.stepone + org.dspace.app.rest.submit.step.DescribeStep + submission-form + + + submit.progressbar.describe.stepone + org.dspace.app.rest.submit.step.DescribeStep + submission-form + + + + + Sample + org.dspace.submit.step.SampleStep + sample + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/dspace/config/item-submission.xml b/dspace/config/item-submission.xml index 481b508176..25162341e4 100644 --- a/dspace/config/item-submission.xml +++ b/dspace/config/item-submission.xml @@ -115,9 +115,9 @@ - submit.progressbar.CClicense + - + + + From 6f5d6625b498f7b1071e8ce4c2ebf55c51e696a8 Mon Sep 17 00:00:00 2001 From: Mykhaylo Date: Thu, 21 May 2020 13:12:03 +0200 Subject: [PATCH 054/125] added the class that has responsible to add to the root endpoint the links to standard nested endpoint, plus IT --- .../link/RootDiscoverableNestedLinks.java | 70 +++++++++++++++++++ .../rest/RootDiscoverableNestedLinksIT.java | 49 +++++++++++++ 2 files changed, 119 insertions(+) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/link/RootDiscoverableNestedLinks.java create mode 100644 dspace-server-webapp/src/test/java/org/dspace/app/rest/RootDiscoverableNestedLinksIT.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/RootDiscoverableNestedLinks.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/RootDiscoverableNestedLinks.java new file mode 100644 index 0000000000..00a43b9db1 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/RootDiscoverableNestedLinks.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.rest.link; + +import java.util.Arrays; + +import org.dspace.app.rest.DiscoverableEndpointsService; +import org.dspace.app.rest.model.AuthorizationRest; +import org.dspace.app.rest.model.ClaimedTaskRest; +import org.dspace.app.rest.model.EPersonRest; +import org.dspace.app.rest.model.PoolTaskRest; +import org.dspace.app.rest.model.ResourcePolicyRest; +import org.dspace.app.rest.repository.AuthorityRestRepository; +import org.dspace.app.rest.repository.ClaimedTaskRestRepository; +import org.dspace.app.rest.repository.EPersonRestRepository; +import org.dspace.app.rest.repository.PoolTaskRestRepository; +import org.dspace.app.rest.repository.ResourcePolicyRestRepository; +import org.springframework.beans.factory.InitializingBean; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.hateoas.Link; +import org.springframework.stereotype.Component; + +/** + * This class is responsible to add to the root endpoint the links to standard nested endpoint + * that are not discoverable due to limitation to access some resource collection endpoint via GET. + * If a custom endpoint should require to add extra links to the root is recommended to register + * them directly from the Repository class implementation or the custom controller. + * + * @author Mykhaylo Boychuk (mykhaylo.boychuk at 4science) + */ +@Component +public class RootDiscoverableNestedLinks implements InitializingBean { + + @Autowired + DiscoverableEndpointsService discoverableEndpointsService; + + @Override + public void afterPropertiesSet() throws Exception { + discoverableEndpointsService + .register(ResourcePolicyRestRepository.class , Arrays.asList(new Link("/api/" + + ResourcePolicyRest.CATEGORY + "/" + ResourcePolicyRest.NAME + "/search", + ResourcePolicyRest.NAME + "-search"))); + + discoverableEndpointsService + .register(AuthorityRestRepository.class , Arrays.asList(new Link("/api/" + + AuthorizationRest.CATEGORY + "/" + AuthorizationRest.NAME + "/search", + AuthorizationRest.NAME + "-search"))); + + discoverableEndpointsService + .register(ClaimedTaskRestRepository.class , Arrays.asList(new Link("/api/" + + ClaimedTaskRest.CATEGORY + "/" + ClaimedTaskRest.NAME + "/search", + ClaimedTaskRest.NAME + "-search"))); + + discoverableEndpointsService + .register(PoolTaskRestRepository.class , Arrays.asList(new Link("/api/" + + PoolTaskRest.CATEGORY + "/" + PoolTaskRest.NAME + "/search", + PoolTaskRest.NAME + "-search"))); + + discoverableEndpointsService + .register(EPersonRestRepository.class , Arrays.asList(new Link("/api/" + + EPersonRest.CATEGORY + "/registrations", EPersonRest.NAME + "-registration"))); + + } + +} diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/RootDiscoverableNestedLinksIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/RootDiscoverableNestedLinksIT.java new file mode 100644 index 0000000000..46f6acbc58 --- /dev/null +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/RootDiscoverableNestedLinksIT.java @@ -0,0 +1,49 @@ +/** + * 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.rest; + +import static com.jayway.jsonpath.matchers.JsonPathMatchers.hasJsonPath; +import static org.hamcrest.Matchers.is; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +import org.dspace.app.rest.test.AbstractControllerIntegrationTest; +import org.hamcrest.Matchers; +import org.junit.Test; + +public class RootDiscoverableNestedLinksIT extends AbstractControllerIntegrationTest { + + @Test + public void rootDiscoverableNestedLinksTest() throws Exception { + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform(get("/api")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._links",Matchers.allOf( + hasJsonPath("$.authorizations.href", + is("http://localhost/api/authz/authorizations")), + hasJsonPath("$.authorization-search.href", + is("http://localhost/api/authz/authorization/search")), + hasJsonPath("$.resourcepolicies.href", + is("http://localhost/api/authz/resourcepolicies")), + hasJsonPath("$.resourcepolicy-search.href", + is("http://localhost/api/authz/resourcepolicy/search")), + hasJsonPath("$.claimedtasks.href", + is("http://localhost/api/workflow/claimedtasks")), + hasJsonPath("$.claimedtask-search.href", + is("http://localhost/api/workflow/claimedtask/search")), + hasJsonPath("$.pooltasks.href", + is("http://localhost/api/workflow/pooltasks")), + hasJsonPath("$.pooltask-search.href", + is("http://localhost/api/workflow/pooltask/search")), + hasJsonPath("$.eperson-registration.href", + is("http://localhost/api/eperson/registrations")) + ))); + } + +} From 7e0a0793a2d1916e1620e448ae3c6e5b41bc5ac2 Mon Sep 17 00:00:00 2001 From: Tim Donohue Date: Wed, 20 May 2020 15:21:53 -0500 Subject: [PATCH 055/125] Fix headers in files borrowed from HAL Browser. These should retain original licensing --- dspace-server-webapp/pom.xml | 16 ++++++++++++++ .../src/main/webapp/index.html | 18 ++++++++-------- .../src/main/webapp/js/hal/http/client.js | 16 +++++++------- .../src/main/webapp/login.html | 21 ++++++++++--------- 4 files changed, 45 insertions(+), 26 deletions(-) diff --git a/dspace-server-webapp/pom.xml b/dspace-server-webapp/pom.xml index 88e31751f3..fa6fd8bc4f 100644 --- a/dspace-server-webapp/pom.xml +++ b/dspace-server-webapp/pom.xml @@ -172,6 +172,22 @@ + + + com.mycila + license-maven-plugin + + + **/src/test/resources/** + **/src/test/data/** + + src/main/webapp/index.html + src/main/webapp/login.html + src/main/webapp/js/hal/** + src/main/webapp/vendor/** + + + diff --git a/dspace-server-webapp/src/main/webapp/index.html b/dspace-server-webapp/src/main/webapp/index.html index 15661c654a..3cc828dd89 100644 --- a/dspace-server-webapp/src/main/webapp/index.html +++ b/dspace-server-webapp/src/main/webapp/index.html @@ -1,17 +1,17 @@ - - The HAL Browser (customized for Spring Data REST) + The HAL Browser (customized for DSpace Server Webapp) - + diff --git a/dspace-server-webapp/src/main/webapp/vendor/js/jquery-3.5.1.js b/dspace-server-webapp/src/main/webapp/vendor/js/jquery-3.5.1.js new file mode 100644 index 0000000000..50937333b9 --- /dev/null +++ b/dspace-server-webapp/src/main/webapp/vendor/js/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " From 4a54aadf997ddbb5698fa32897e19c4bc230ab76 Mon Sep 17 00:00:00 2001 From: Tim Donohue Date: Thu, 21 May 2020 15:45:03 -0500 Subject: [PATCH 058/125] Switch to using WebJARs to dynamically pull in JQuery 3.5.1 --- dspace-server-webapp/pom.xml | 10 +- .../java/org/dspace/app/rest/Application.java | 13 + .../src/main/webapp/index.html | 2 +- .../src/main/webapp/login.html | 2 +- .../src/main/webapp/vendor/js/jquery-3.5.1.js | 10872 ---------------- .../main/webapp/vendor/js/jquery-3.5.1.min.js | 2 - .../webapp/vendor/js/jquery-3.5.1.min.map | 1 - 7 files changed, 24 insertions(+), 10878 deletions(-) delete mode 100644 dspace-server-webapp/src/main/webapp/vendor/js/jquery-3.5.1.js delete mode 100644 dspace-server-webapp/src/main/webapp/vendor/js/jquery-3.5.1.min.js delete mode 100644 dspace-server-webapp/src/main/webapp/vendor/js/jquery-3.5.1.min.map diff --git a/dspace-server-webapp/pom.xml b/dspace-server-webapp/pom.xml index fa6fd8bc4f..d9eb3174e2 100644 --- a/dspace-server-webapp/pom.xml +++ b/dspace-server-webapp/pom.xml @@ -184,7 +184,6 @@ src/main/webapp/index.html src/main/webapp/login.html src/main/webapp/js/hal/** - src/main/webapp/vendor/** @@ -258,6 +257,15 @@ ${spring-hal-browser.version} + + + + org.webjars.bowergithub.jquery + jquery-dist + 3.5.1 + + org.springframework.boot diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/Application.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/Application.java index c89dd77f4f..18d06c87e8 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/Application.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/Application.java @@ -32,6 +32,7 @@ import org.springframework.web.context.request.RequestContextListener; import org.springframework.web.cors.CorsConfiguration; import org.springframework.web.method.support.HandlerMethodArgumentResolver; import org.springframework.web.servlet.config.annotation.CorsRegistry; +import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; /** @@ -149,6 +150,18 @@ public class Application extends SpringBootServletInitializer { } } + /** + * Add a new ResourceHandler to allow us to use WebJars.org to pull in web dependencies + * dynamically for HAL Browser, and access them off the /webjars path. + * @param registry ResourceHandlerRegistry + */ + @Override + public void addResourceHandlers(ResourceHandlerRegistry registry) { + registry + .addResourceHandler("/webjars/**") + .addResourceLocations("/webjars/"); + } + @Override public void addArgumentResolvers(@NonNull List argumentResolvers) { argumentResolvers.add(new SearchFilterResolver()); diff --git a/dspace-server-webapp/src/main/webapp/index.html b/dspace-server-webapp/src/main/webapp/index.html index f53b2ea0c6..41bd71c78b 100644 --- a/dspace-server-webapp/src/main/webapp/index.html +++ b/dspace-server-webapp/src/main/webapp/index.html @@ -250,7 +250,7 @@ Content-Type: application/json - + diff --git a/dspace-server-webapp/src/main/webapp/login.html b/dspace-server-webapp/src/main/webapp/login.html index 21a9543148..e085fa496f 100644 --- a/dspace-server-webapp/src/main/webapp/login.html +++ b/dspace-server-webapp/src/main/webapp/login.html @@ -50,7 +50,7 @@ margin-bottom: 10px; } - + diff --git a/dspace-server-webapp/src/main/webapp/vendor/js/jquery-3.5.1.js b/dspace-server-webapp/src/main/webapp/vendor/js/jquery-3.5.1.js deleted file mode 100644 index 50937333b9..0000000000 --- a/dspace-server-webapp/src/main/webapp/vendor/js/jquery-3.5.1.js +++ /dev/null @@ -1,10872 +0,0 @@ -/*! - * jQuery JavaScript Library v3.5.1 - * https://jquery.com/ - * - * Includes Sizzle.js - * https://sizzlejs.com/ - * - * Copyright JS Foundation and other contributors - * Released under the MIT license - * https://jquery.org/license - * - * Date: 2020-05-04T22:49Z - */ -( function( global, factory ) { - - "use strict"; - - if ( typeof module === "object" && typeof module.exports === "object" ) { - - // For CommonJS and CommonJS-like environments where a proper `window` - // is present, execute the factory and get jQuery. - // For environments that do not have a `window` with a `document` - // (such as Node.js), expose a factory as module.exports. - // This accentuates the need for the creation of a real `window`. - // e.g. var jQuery = require("jquery")(window); - // See ticket #14549 for more info. - module.exports = global.document ? - factory( global, true ) : - function( w ) { - if ( !w.document ) { - throw new Error( "jQuery requires a window with a document" ); - } - return factory( w ); - }; - } else { - factory( global ); - } - -// Pass this if window is not defined yet -} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { - -// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 -// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode -// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common -// enough that all such attempts are guarded in a try block. -"use strict"; - -var arr = []; - -var getProto = Object.getPrototypeOf; - -var slice = arr.slice; - -var flat = arr.flat ? function( array ) { - return arr.flat.call( array ); -} : function( array ) { - return arr.concat.apply( [], array ); -}; - - -var push = arr.push; - -var indexOf = arr.indexOf; - -var class2type = {}; - -var toString = class2type.toString; - -var hasOwn = class2type.hasOwnProperty; - -var fnToString = hasOwn.toString; - -var ObjectFunctionString = fnToString.call( Object ); - -var support = {}; - -var isFunction = function isFunction( obj ) { - - // Support: Chrome <=57, Firefox <=52 - // In some browsers, typeof returns "function" for HTML elements - // (i.e., `typeof document.createElement( "object" ) === "function"`). - // We don't want to classify *any* DOM node as a function. - return typeof obj === "function" && typeof obj.nodeType !== "number"; - }; - - -var isWindow = function isWindow( obj ) { - return obj != null && obj === obj.window; - }; - - -var document = window.document; - - - - var preservedScriptAttributes = { - type: true, - src: true, - nonce: true, - noModule: true - }; - - function DOMEval( code, node, doc ) { - doc = doc || document; - - var i, val, - script = doc.createElement( "script" ); - - script.text = code; - if ( node ) { - for ( i in preservedScriptAttributes ) { - - // Support: Firefox 64+, Edge 18+ - // Some browsers don't support the "nonce" property on scripts. - // On the other hand, just using `getAttribute` is not enough as - // the `nonce` attribute is reset to an empty string whenever it - // becomes browsing-context connected. - // See https://github.com/whatwg/html/issues/2369 - // See https://html.spec.whatwg.org/#nonce-attributes - // The `node.getAttribute` check was added for the sake of - // `jQuery.globalEval` so that it can fake a nonce-containing node - // via an object. - val = node[ i ] || node.getAttribute && node.getAttribute( i ); - if ( val ) { - script.setAttribute( i, val ); - } - } - } - doc.head.appendChild( script ).parentNode.removeChild( script ); - } - - -function toType( obj ) { - if ( obj == null ) { - return obj + ""; - } - - // Support: Android <=2.3 only (functionish RegExp) - return typeof obj === "object" || typeof obj === "function" ? - class2type[ toString.call( obj ) ] || "object" : - typeof obj; -} -/* global Symbol */ -// Defining this global in .eslintrc.json would create a danger of using the global -// unguarded in another place, it seems safer to define global only for this module - - - -var - version = "3.5.1", - - // Define a local copy of jQuery - jQuery = function( selector, context ) { - - // The jQuery object is actually just the init constructor 'enhanced' - // Need init if jQuery is called (just allow error to be thrown if not included) - return new jQuery.fn.init( selector, context ); - }; - -jQuery.fn = jQuery.prototype = { - - // The current version of jQuery being used - jquery: version, - - constructor: jQuery, - - // The default length of a jQuery object is 0 - length: 0, - - toArray: function() { - return slice.call( this ); - }, - - // Get the Nth element in the matched element set OR - // Get the whole matched element set as a clean array - get: function( num ) { - - // Return all the elements in a clean array - if ( num == null ) { - return slice.call( this ); - } - - // Return just the one element from the set - return num < 0 ? this[ num + this.length ] : this[ num ]; - }, - - // Take an array of elements and push it onto the stack - // (returning the new matched element set) - pushStack: function( elems ) { - - // Build a new jQuery matched element set - var ret = jQuery.merge( this.constructor(), elems ); - - // Add the old object onto the stack (as a reference) - ret.prevObject = this; - - // Return the newly-formed element set - return ret; - }, - - // Execute a callback for every element in the matched set. - each: function( callback ) { - return jQuery.each( this, callback ); - }, - - map: function( callback ) { - return this.pushStack( jQuery.map( this, function( elem, i ) { - return callback.call( elem, i, elem ); - } ) ); - }, - - slice: function() { - return this.pushStack( slice.apply( this, arguments ) ); - }, - - first: function() { - return this.eq( 0 ); - }, - - last: function() { - return this.eq( -1 ); - }, - - even: function() { - return this.pushStack( jQuery.grep( this, function( _elem, i ) { - return ( i + 1 ) % 2; - } ) ); - }, - - odd: function() { - return this.pushStack( jQuery.grep( this, function( _elem, i ) { - return i % 2; - } ) ); - }, - - eq: function( i ) { - var len = this.length, - j = +i + ( i < 0 ? len : 0 ); - return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); - }, - - end: function() { - return this.prevObject || this.constructor(); - }, - - // For internal use only. - // Behaves like an Array's method, not like a jQuery method. - push: push, - sort: arr.sort, - splice: arr.splice -}; - -jQuery.extend = jQuery.fn.extend = function() { - var options, name, src, copy, copyIsArray, clone, - target = arguments[ 0 ] || {}, - i = 1, - length = arguments.length, - deep = false; - - // Handle a deep copy situation - if ( typeof target === "boolean" ) { - deep = target; - - // Skip the boolean and the target - target = arguments[ i ] || {}; - i++; - } - - // Handle case when target is a string or something (possible in deep copy) - if ( typeof target !== "object" && !isFunction( target ) ) { - target = {}; - } - - // Extend jQuery itself if only one argument is passed - if ( i === length ) { - target = this; - i--; - } - - for ( ; i < length; i++ ) { - - // Only deal with non-null/undefined values - if ( ( options = arguments[ i ] ) != null ) { - - // Extend the base object - for ( name in options ) { - copy = options[ name ]; - - // Prevent Object.prototype pollution - // Prevent never-ending loop - if ( name === "__proto__" || target === copy ) { - continue; - } - - // Recurse if we're merging plain objects or arrays - if ( deep && copy && ( jQuery.isPlainObject( copy ) || - ( copyIsArray = Array.isArray( copy ) ) ) ) { - src = target[ name ]; - - // Ensure proper type for the source value - if ( copyIsArray && !Array.isArray( src ) ) { - clone = []; - } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { - clone = {}; - } else { - clone = src; - } - copyIsArray = false; - - // Never move original objects, clone them - target[ name ] = jQuery.extend( deep, clone, copy ); - - // Don't bring in undefined values - } else if ( copy !== undefined ) { - target[ name ] = copy; - } - } - } - } - - // Return the modified object - return target; -}; - -jQuery.extend( { - - // Unique for each copy of jQuery on the page - expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), - - // Assume jQuery is ready without the ready module - isReady: true, - - error: function( msg ) { - throw new Error( msg ); - }, - - noop: function() {}, - - isPlainObject: function( obj ) { - var proto, Ctor; - - // Detect obvious negatives - // Use toString instead of jQuery.type to catch host objects - if ( !obj || toString.call( obj ) !== "[object Object]" ) { - return false; - } - - proto = getProto( obj ); - - // Objects with no prototype (e.g., `Object.create( null )`) are plain - if ( !proto ) { - return true; - } - - // Objects with prototype are plain iff they were constructed by a global Object function - Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; - return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; - }, - - isEmptyObject: function( obj ) { - var name; - - for ( name in obj ) { - return false; - } - return true; - }, - - // Evaluates a script in a provided context; falls back to the global one - // if not specified. - globalEval: function( code, options, doc ) { - DOMEval( code, { nonce: options && options.nonce }, doc ); - }, - - each: function( obj, callback ) { - var length, i = 0; - - if ( isArrayLike( obj ) ) { - length = obj.length; - for ( ; i < length; i++ ) { - if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { - break; - } - } - } else { - for ( i in obj ) { - if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { - break; - } - } - } - - return obj; - }, - - // results is for internal usage only - makeArray: function( arr, results ) { - var ret = results || []; - - if ( arr != null ) { - if ( isArrayLike( Object( arr ) ) ) { - jQuery.merge( ret, - typeof arr === "string" ? - [ arr ] : arr - ); - } else { - push.call( ret, arr ); - } - } - - return ret; - }, - - inArray: function( elem, arr, i ) { - return arr == null ? -1 : indexOf.call( arr, elem, i ); - }, - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - merge: function( first, second ) { - var len = +second.length, - j = 0, - i = first.length; - - for ( ; j < len; j++ ) { - first[ i++ ] = second[ j ]; - } - - first.length = i; - - return first; - }, - - grep: function( elems, callback, invert ) { - var callbackInverse, - matches = [], - i = 0, - length = elems.length, - callbackExpect = !invert; - - // Go through the array, only saving the items - // that pass the validator function - for ( ; i < length; i++ ) { - callbackInverse = !callback( elems[ i ], i ); - if ( callbackInverse !== callbackExpect ) { - matches.push( elems[ i ] ); - } - } - - return matches; - }, - - // arg is for internal usage only - map: function( elems, callback, arg ) { - var length, value, - i = 0, - ret = []; - - // Go through the array, translating each of the items to their new values - if ( isArrayLike( elems ) ) { - length = elems.length; - for ( ; i < length; i++ ) { - value = callback( elems[ i ], i, arg ); - - if ( value != null ) { - ret.push( value ); - } - } - - // Go through every key on the object, - } else { - for ( i in elems ) { - value = callback( elems[ i ], i, arg ); - - if ( value != null ) { - ret.push( value ); - } - } - } - - // Flatten any nested arrays - return flat( ret ); - }, - - // A global GUID counter for objects - guid: 1, - - // jQuery.support is not used in Core but other projects attach their - // properties to it so it needs to exist. - support: support -} ); - -if ( typeof Symbol === "function" ) { - jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; -} - -// Populate the class2type map -jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), -function( _i, name ) { - class2type[ "[object " + name + "]" ] = name.toLowerCase(); -} ); - -function isArrayLike( obj ) { - - // Support: real iOS 8.2 only (not reproducible in simulator) - // `in` check used to prevent JIT error (gh-2145) - // hasOwn isn't used here due to false negatives - // regarding Nodelist length in IE - var length = !!obj && "length" in obj && obj.length, - type = toType( obj ); - - if ( isFunction( obj ) || isWindow( obj ) ) { - return false; - } - - return type === "array" || length === 0 || - typeof length === "number" && length > 0 && ( length - 1 ) in obj; -} -var Sizzle = -/*! - * Sizzle CSS Selector Engine v2.3.5 - * https://sizzlejs.com/ - * - * Copyright JS Foundation and other contributors - * Released under the MIT license - * https://js.foundation/ - * - * Date: 2020-03-14 - */ -( function( window ) { -var i, - support, - Expr, - getText, - isXML, - tokenize, - compile, - select, - outermostContext, - sortInput, - hasDuplicate, - - // Local document vars - setDocument, - document, - docElem, - documentIsHTML, - rbuggyQSA, - rbuggyMatches, - matches, - contains, - - // Instance-specific data - expando = "sizzle" + 1 * new Date(), - preferredDoc = window.document, - dirruns = 0, - done = 0, - classCache = createCache(), - tokenCache = createCache(), - compilerCache = createCache(), - nonnativeSelectorCache = createCache(), - sortOrder = function( a, b ) { - if ( a === b ) { - hasDuplicate = true; - } - return 0; - }, - - // Instance methods - hasOwn = ( {} ).hasOwnProperty, - arr = [], - pop = arr.pop, - pushNative = arr.push, - push = arr.push, - slice = arr.slice, - - // Use a stripped-down indexOf as it's faster than native - // https://jsperf.com/thor-indexof-vs-for/5 - indexOf = function( list, elem ) { - var i = 0, - len = list.length; - for ( ; i < len; i++ ) { - if ( list[ i ] === elem ) { - return i; - } - } - return -1; - }, - - booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + - "ismap|loop|multiple|open|readonly|required|scoped", - - // Regular expressions - - // http://www.w3.org/TR/css3-selectors/#whitespace - whitespace = "[\\x20\\t\\r\\n\\f]", - - // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram - identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + - "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", - - // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors - attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + - - // Operator (capture 2) - "*([*^$|!~]?=)" + whitespace + - - // "Attribute values must be CSS identifiers [capture 5] - // or strings [capture 3 or capture 4]" - "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + - whitespace + "*\\]", - - pseudos = ":(" + identifier + ")(?:\\((" + - - // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: - // 1. quoted (capture 3; capture 4 or capture 5) - "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + - - // 2. simple (capture 6) - "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + - - // 3. anything else (capture 2) - ".*" + - ")\\)|)", - - // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter - rwhitespace = new RegExp( whitespace + "+", "g" ), - rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + - whitespace + "+$", "g" ), - - rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), - rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + - "*" ), - rdescend = new RegExp( whitespace + "|>" ), - - rpseudo = new RegExp( pseudos ), - ridentifier = new RegExp( "^" + identifier + "$" ), - - matchExpr = { - "ID": new RegExp( "^#(" + identifier + ")" ), - "CLASS": new RegExp( "^\\.(" + identifier + ")" ), - "TAG": new RegExp( "^(" + identifier + "|[*])" ), - "ATTR": new RegExp( "^" + attributes ), - "PSEUDO": new RegExp( "^" + pseudos ), - "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + - whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + - whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), - "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), - - // For use in libraries implementing .is() - // We use this for POS matching in `select` - "needsContext": new RegExp( "^" + whitespace + - "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + - "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) - }, - - rhtml = /HTML$/i, - rinputs = /^(?:input|select|textarea|button)$/i, - rheader = /^h\d$/i, - - rnative = /^[^{]+\{\s*\[native \w/, - - // Easily-parseable/retrievable ID or TAG or CLASS selectors - rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, - - rsibling = /[+~]/, - - // CSS escapes - // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters - runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), - funescape = function( escape, nonHex ) { - var high = "0x" + escape.slice( 1 ) - 0x10000; - - return nonHex ? - - // Strip the backslash prefix from a non-hex escape sequence - nonHex : - - // Replace a hexadecimal escape sequence with the encoded Unicode code point - // Support: IE <=11+ - // For values outside the Basic Multilingual Plane (BMP), manually construct a - // surrogate pair - high < 0 ? - String.fromCharCode( high + 0x10000 ) : - String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); - }, - - // CSS string/identifier serialization - // https://drafts.csswg.org/cssom/#common-serializing-idioms - rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, - fcssescape = function( ch, asCodePoint ) { - if ( asCodePoint ) { - - // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER - if ( ch === "\0" ) { - return "\uFFFD"; - } - - // Control characters and (dependent upon position) numbers get escaped as code points - return ch.slice( 0, -1 ) + "\\" + - ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; - } - - // Other potentially-special ASCII characters get backslash-escaped - return "\\" + ch; - }, - - // Used for iframes - // See setDocument() - // Removing the function wrapper causes a "Permission Denied" - // error in IE - unloadHandler = function() { - setDocument(); - }, - - inDisabledFieldset = addCombinator( - function( elem ) { - return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; - }, - { dir: "parentNode", next: "legend" } - ); - -// Optimize for push.apply( _, NodeList ) -try { - push.apply( - ( arr = slice.call( preferredDoc.childNodes ) ), - preferredDoc.childNodes - ); - - // Support: Android<4.0 - // Detect silently failing push.apply - // eslint-disable-next-line no-unused-expressions - arr[ preferredDoc.childNodes.length ].nodeType; -} catch ( e ) { - push = { apply: arr.length ? - - // Leverage slice if possible - function( target, els ) { - pushNative.apply( target, slice.call( els ) ); - } : - - // Support: IE<9 - // Otherwise append directly - function( target, els ) { - var j = target.length, - i = 0; - - // Can't trust NodeList.length - while ( ( target[ j++ ] = els[ i++ ] ) ) {} - target.length = j - 1; - } - }; -} - -function Sizzle( selector, context, results, seed ) { - var m, i, elem, nid, match, groups, newSelector, - newContext = context && context.ownerDocument, - - // nodeType defaults to 9, since context defaults to document - nodeType = context ? context.nodeType : 9; - - results = results || []; - - // Return early from calls with invalid selector or context - if ( typeof selector !== "string" || !selector || - nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { - - return results; - } - - // Try to shortcut find operations (as opposed to filters) in HTML documents - if ( !seed ) { - setDocument( context ); - context = context || document; - - if ( documentIsHTML ) { - - // If the selector is sufficiently simple, try using a "get*By*" DOM method - // (excepting DocumentFragment context, where the methods don't exist) - if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { - - // ID selector - if ( ( m = match[ 1 ] ) ) { - - // Document context - if ( nodeType === 9 ) { - if ( ( elem = context.getElementById( m ) ) ) { - - // Support: IE, Opera, Webkit - // TODO: identify versions - // getElementById can match elements by name instead of ID - if ( elem.id === m ) { - results.push( elem ); - return results; - } - } else { - return results; - } - - // Element context - } else { - - // Support: IE, Opera, Webkit - // TODO: identify versions - // getElementById can match elements by name instead of ID - if ( newContext && ( elem = newContext.getElementById( m ) ) && - contains( context, elem ) && - elem.id === m ) { - - results.push( elem ); - return results; - } - } - - // Type selector - } else if ( match[ 2 ] ) { - push.apply( results, context.getElementsByTagName( selector ) ); - return results; - - // Class selector - } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && - context.getElementsByClassName ) { - - push.apply( results, context.getElementsByClassName( m ) ); - return results; - } - } - - // Take advantage of querySelectorAll - if ( support.qsa && - !nonnativeSelectorCache[ selector + " " ] && - ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && - - // Support: IE 8 only - // Exclude object elements - ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { - - newSelector = selector; - newContext = context; - - // qSA considers elements outside a scoping root when evaluating child or - // descendant combinators, which is not what we want. - // In such cases, we work around the behavior by prefixing every selector in the - // list with an ID selector referencing the scope context. - // The technique has to be used as well when a leading combinator is used - // as such selectors are not recognized by querySelectorAll. - // Thanks to Andrew Dupont for this technique. - if ( nodeType === 1 && - ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { - - // Expand context for sibling selectors - newContext = rsibling.test( selector ) && testContext( context.parentNode ) || - context; - - // We can use :scope instead of the ID hack if the browser - // supports it & if we're not changing the context. - if ( newContext !== context || !support.scope ) { - - // Capture the context ID, setting it first if necessary - if ( ( nid = context.getAttribute( "id" ) ) ) { - nid = nid.replace( rcssescape, fcssescape ); - } else { - context.setAttribute( "id", ( nid = expando ) ); - } - } - - // Prefix every selector in the list - groups = tokenize( selector ); - i = groups.length; - while ( i-- ) { - groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + - toSelector( groups[ i ] ); - } - newSelector = groups.join( "," ); - } - - try { - push.apply( results, - newContext.querySelectorAll( newSelector ) - ); - return results; - } catch ( qsaError ) { - nonnativeSelectorCache( selector, true ); - } finally { - if ( nid === expando ) { - context.removeAttribute( "id" ); - } - } - } - } - } - - // All others - return select( selector.replace( rtrim, "$1" ), context, results, seed ); -} - -/** - * Create key-value caches of limited size - * @returns {function(string, object)} Returns the Object data after storing it on itself with - * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) - * deleting the oldest entry - */ -function createCache() { - var keys = []; - - function cache( key, value ) { - - // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) - if ( keys.push( key + " " ) > Expr.cacheLength ) { - - // Only keep the most recent entries - delete cache[ keys.shift() ]; - } - return ( cache[ key + " " ] = value ); - } - return cache; -} - -/** - * Mark a function for special use by Sizzle - * @param {Function} fn The function to mark - */ -function markFunction( fn ) { - fn[ expando ] = true; - return fn; -} - -/** - * Support testing using an element - * @param {Function} fn Passed the created element and returns a boolean result - */ -function assert( fn ) { - var el = document.createElement( "fieldset" ); - - try { - return !!fn( el ); - } catch ( e ) { - return false; - } finally { - - // Remove from its parent by default - if ( el.parentNode ) { - el.parentNode.removeChild( el ); - } - - // release memory in IE - el = null; - } -} - -/** - * Adds the same handler for all of the specified attrs - * @param {String} attrs Pipe-separated list of attributes - * @param {Function} handler The method that will be applied - */ -function addHandle( attrs, handler ) { - var arr = attrs.split( "|" ), - i = arr.length; - - while ( i-- ) { - Expr.attrHandle[ arr[ i ] ] = handler; - } -} - -/** - * Checks document order of two siblings - * @param {Element} a - * @param {Element} b - * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b - */ -function siblingCheck( a, b ) { - var cur = b && a, - diff = cur && a.nodeType === 1 && b.nodeType === 1 && - a.sourceIndex - b.sourceIndex; - - // Use IE sourceIndex if available on both nodes - if ( diff ) { - return diff; - } - - // Check if b follows a - if ( cur ) { - while ( ( cur = cur.nextSibling ) ) { - if ( cur === b ) { - return -1; - } - } - } - - return a ? 1 : -1; -} - -/** - * Returns a function to use in pseudos for input types - * @param {String} type - */ -function createInputPseudo( type ) { - return function( elem ) { - var name = elem.nodeName.toLowerCase(); - return name === "input" && elem.type === type; - }; -} - -/** - * Returns a function to use in pseudos for buttons - * @param {String} type - */ -function createButtonPseudo( type ) { - return function( elem ) { - var name = elem.nodeName.toLowerCase(); - return ( name === "input" || name === "button" ) && elem.type === type; - }; -} - -/** - * Returns a function to use in pseudos for :enabled/:disabled - * @param {Boolean} disabled true for :disabled; false for :enabled - */ -function createDisabledPseudo( disabled ) { - - // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable - return function( elem ) { - - // Only certain elements can match :enabled or :disabled - // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled - // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled - if ( "form" in elem ) { - - // Check for inherited disabledness on relevant non-disabled elements: - // * listed form-associated elements in a disabled fieldset - // https://html.spec.whatwg.org/multipage/forms.html#category-listed - // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled - // * option elements in a disabled optgroup - // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled - // All such elements have a "form" property. - if ( elem.parentNode && elem.disabled === false ) { - - // Option elements defer to a parent optgroup if present - if ( "label" in elem ) { - if ( "label" in elem.parentNode ) { - return elem.parentNode.disabled === disabled; - } else { - return elem.disabled === disabled; - } - } - - // Support: IE 6 - 11 - // Use the isDisabled shortcut property to check for disabled fieldset ancestors - return elem.isDisabled === disabled || - - // Where there is no isDisabled, check manually - /* jshint -W018 */ - elem.isDisabled !== !disabled && - inDisabledFieldset( elem ) === disabled; - } - - return elem.disabled === disabled; - - // Try to winnow out elements that can't be disabled before trusting the disabled property. - // Some victims get caught in our net (label, legend, menu, track), but it shouldn't - // even exist on them, let alone have a boolean value. - } else if ( "label" in elem ) { - return elem.disabled === disabled; - } - - // Remaining elements are neither :enabled nor :disabled - return false; - }; -} - -/** - * Returns a function to use in pseudos for positionals - * @param {Function} fn - */ -function createPositionalPseudo( fn ) { - return markFunction( function( argument ) { - argument = +argument; - return markFunction( function( seed, matches ) { - var j, - matchIndexes = fn( [], seed.length, argument ), - i = matchIndexes.length; - - // Match elements found at the specified indexes - while ( i-- ) { - if ( seed[ ( j = matchIndexes[ i ] ) ] ) { - seed[ j ] = !( matches[ j ] = seed[ j ] ); - } - } - } ); - } ); -} - -/** - * Checks a node for validity as a Sizzle context - * @param {Element|Object=} context - * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value - */ -function testContext( context ) { - return context && typeof context.getElementsByTagName !== "undefined" && context; -} - -// Expose support vars for convenience -support = Sizzle.support = {}; - -/** - * Detects XML nodes - * @param {Element|Object} elem An element or a document - * @returns {Boolean} True iff elem is a non-HTML XML node - */ -isXML = Sizzle.isXML = function( elem ) { - var namespace = elem.namespaceURI, - docElem = ( elem.ownerDocument || elem ).documentElement; - - // Support: IE <=8 - // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes - // https://bugs.jquery.com/ticket/4833 - return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); -}; - -/** - * Sets document-related variables once based on the current document - * @param {Element|Object} [doc] An element or document object to use to set the document - * @returns {Object} Returns the current document - */ -setDocument = Sizzle.setDocument = function( node ) { - var hasCompare, subWindow, - doc = node ? node.ownerDocument || node : preferredDoc; - - // Return early if doc is invalid or already selected - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { - return document; - } - - // Update global variables - document = doc; - docElem = document.documentElement; - documentIsHTML = !isXML( document ); - - // Support: IE 9 - 11+, Edge 12 - 18+ - // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( preferredDoc != document && - ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { - - // Support: IE 11, Edge - if ( subWindow.addEventListener ) { - subWindow.addEventListener( "unload", unloadHandler, false ); - - // Support: IE 9 - 10 only - } else if ( subWindow.attachEvent ) { - subWindow.attachEvent( "onunload", unloadHandler ); - } - } - - // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, - // Safari 4 - 5 only, Opera <=11.6 - 12.x only - // IE/Edge & older browsers don't support the :scope pseudo-class. - // Support: Safari 6.0 only - // Safari 6.0 supports :scope but it's an alias of :root there. - support.scope = assert( function( el ) { - docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); - return typeof el.querySelectorAll !== "undefined" && - !el.querySelectorAll( ":scope fieldset div" ).length; - } ); - - /* Attributes - ---------------------------------------------------------------------- */ - - // Support: IE<8 - // Verify that getAttribute really returns attributes and not properties - // (excepting IE8 booleans) - support.attributes = assert( function( el ) { - el.className = "i"; - return !el.getAttribute( "className" ); - } ); - - /* getElement(s)By* - ---------------------------------------------------------------------- */ - - // Check if getElementsByTagName("*") returns only elements - support.getElementsByTagName = assert( function( el ) { - el.appendChild( document.createComment( "" ) ); - return !el.getElementsByTagName( "*" ).length; - } ); - - // Support: IE<9 - support.getElementsByClassName = rnative.test( document.getElementsByClassName ); - - // Support: IE<10 - // Check if getElementById returns elements by name - // The broken getElementById methods don't pick up programmatically-set names, - // so use a roundabout getElementsByName test - support.getById = assert( function( el ) { - docElem.appendChild( el ).id = expando; - return !document.getElementsByName || !document.getElementsByName( expando ).length; - } ); - - // ID filter and find - if ( support.getById ) { - Expr.filter[ "ID" ] = function( id ) { - var attrId = id.replace( runescape, funescape ); - return function( elem ) { - return elem.getAttribute( "id" ) === attrId; - }; - }; - Expr.find[ "ID" ] = function( id, context ) { - if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { - var elem = context.getElementById( id ); - return elem ? [ elem ] : []; - } - }; - } else { - Expr.filter[ "ID" ] = function( id ) { - var attrId = id.replace( runescape, funescape ); - return function( elem ) { - var node = typeof elem.getAttributeNode !== "undefined" && - elem.getAttributeNode( "id" ); - return node && node.value === attrId; - }; - }; - - // Support: IE 6 - 7 only - // getElementById is not reliable as a find shortcut - Expr.find[ "ID" ] = function( id, context ) { - if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { - var node, i, elems, - elem = context.getElementById( id ); - - if ( elem ) { - - // Verify the id attribute - node = elem.getAttributeNode( "id" ); - if ( node && node.value === id ) { - return [ elem ]; - } - - // Fall back on getElementsByName - elems = context.getElementsByName( id ); - i = 0; - while ( ( elem = elems[ i++ ] ) ) { - node = elem.getAttributeNode( "id" ); - if ( node && node.value === id ) { - return [ elem ]; - } - } - } - - return []; - } - }; - } - - // Tag - Expr.find[ "TAG" ] = support.getElementsByTagName ? - function( tag, context ) { - if ( typeof context.getElementsByTagName !== "undefined" ) { - return context.getElementsByTagName( tag ); - - // DocumentFragment nodes don't have gEBTN - } else if ( support.qsa ) { - return context.querySelectorAll( tag ); - } - } : - - function( tag, context ) { - var elem, - tmp = [], - i = 0, - - // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too - results = context.getElementsByTagName( tag ); - - // Filter out possible comments - if ( tag === "*" ) { - while ( ( elem = results[ i++ ] ) ) { - if ( elem.nodeType === 1 ) { - tmp.push( elem ); - } - } - - return tmp; - } - return results; - }; - - // Class - Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { - if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { - return context.getElementsByClassName( className ); - } - }; - - /* QSA/matchesSelector - ---------------------------------------------------------------------- */ - - // QSA and matchesSelector support - - // matchesSelector(:active) reports false when true (IE9/Opera 11.5) - rbuggyMatches = []; - - // qSa(:focus) reports false when true (Chrome 21) - // We allow this because of a bug in IE8/9 that throws an error - // whenever `document.activeElement` is accessed on an iframe - // So, we allow :focus to pass through QSA all the time to avoid the IE error - // See https://bugs.jquery.com/ticket/13378 - rbuggyQSA = []; - - if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { - - // Build QSA regex - // Regex strategy adopted from Diego Perini - assert( function( el ) { - - var input; - - // Select is set to empty string on purpose - // This is to test IE's treatment of not explicitly - // setting a boolean content attribute, - // since its presence should be enough - // https://bugs.jquery.com/ticket/12359 - docElem.appendChild( el ).innerHTML = "" + - ""; - - // Support: IE8, Opera 11-12.16 - // Nothing should be selected when empty strings follow ^= or $= or *= - // The test attribute must be unknown in Opera but "safe" for WinRT - // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section - if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { - rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); - } - - // Support: IE8 - // Boolean attributes and "value" are not treated correctly - if ( !el.querySelectorAll( "[selected]" ).length ) { - rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); - } - - // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ - if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { - rbuggyQSA.push( "~=" ); - } - - // Support: IE 11+, Edge 15 - 18+ - // IE 11/Edge don't find elements on a `[name='']` query in some cases. - // Adding a temporary attribute to the document before the selection works - // around the issue. - // Interestingly, IE 10 & older don't seem to have the issue. - input = document.createElement( "input" ); - input.setAttribute( "name", "" ); - el.appendChild( input ); - if ( !el.querySelectorAll( "[name='']" ).length ) { - rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + - whitespace + "*(?:''|\"\")" ); - } - - // Webkit/Opera - :checked should return selected option elements - // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked - // IE8 throws error here and will not see later tests - if ( !el.querySelectorAll( ":checked" ).length ) { - rbuggyQSA.push( ":checked" ); - } - - // Support: Safari 8+, iOS 8+ - // https://bugs.webkit.org/show_bug.cgi?id=136851 - // In-page `selector#id sibling-combinator selector` fails - if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { - rbuggyQSA.push( ".#.+[+~]" ); - } - - // Support: Firefox <=3.6 - 5 only - // Old Firefox doesn't throw on a badly-escaped identifier. - el.querySelectorAll( "\\\f" ); - rbuggyQSA.push( "[\\r\\n\\f]" ); - } ); - - assert( function( el ) { - el.innerHTML = "" + - ""; - - // Support: Windows 8 Native Apps - // The type and name attributes are restricted during .innerHTML assignment - var input = document.createElement( "input" ); - input.setAttribute( "type", "hidden" ); - el.appendChild( input ).setAttribute( "name", "D" ); - - // Support: IE8 - // Enforce case-sensitivity of name attribute - if ( el.querySelectorAll( "[name=d]" ).length ) { - rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); - } - - // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) - // IE8 throws error here and will not see later tests - if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { - rbuggyQSA.push( ":enabled", ":disabled" ); - } - - // Support: IE9-11+ - // IE's :disabled selector does not pick up the children of disabled fieldsets - docElem.appendChild( el ).disabled = true; - if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { - rbuggyQSA.push( ":enabled", ":disabled" ); - } - - // Support: Opera 10 - 11 only - // Opera 10-11 does not throw on post-comma invalid pseudos - el.querySelectorAll( "*,:x" ); - rbuggyQSA.push( ",.*:" ); - } ); - } - - if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || - docElem.webkitMatchesSelector || - docElem.mozMatchesSelector || - docElem.oMatchesSelector || - docElem.msMatchesSelector ) ) ) ) { - - assert( function( el ) { - - // Check to see if it's possible to do matchesSelector - // on a disconnected node (IE 9) - support.disconnectedMatch = matches.call( el, "*" ); - - // This should fail with an exception - // Gecko does not error, returns false instead - matches.call( el, "[s!='']:x" ); - rbuggyMatches.push( "!=", pseudos ); - } ); - } - - rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); - rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); - - /* Contains - ---------------------------------------------------------------------- */ - hasCompare = rnative.test( docElem.compareDocumentPosition ); - - // Element contains another - // Purposefully self-exclusive - // As in, an element does not contain itself - contains = hasCompare || rnative.test( docElem.contains ) ? - function( a, b ) { - var adown = a.nodeType === 9 ? a.documentElement : a, - bup = b && b.parentNode; - return a === bup || !!( bup && bup.nodeType === 1 && ( - adown.contains ? - adown.contains( bup ) : - a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 - ) ); - } : - function( a, b ) { - if ( b ) { - while ( ( b = b.parentNode ) ) { - if ( b === a ) { - return true; - } - } - } - return false; - }; - - /* Sorting - ---------------------------------------------------------------------- */ - - // Document order sorting - sortOrder = hasCompare ? - function( a, b ) { - - // Flag for duplicate removal - if ( a === b ) { - hasDuplicate = true; - return 0; - } - - // Sort on method existence if only one input has compareDocumentPosition - var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; - if ( compare ) { - return compare; - } - - // Calculate position if both inputs belong to the same document - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? - a.compareDocumentPosition( b ) : - - // Otherwise we know they are disconnected - 1; - - // Disconnected nodes - if ( compare & 1 || - ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { - - // Choose the first element that is related to our preferred document - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( a == document || a.ownerDocument == preferredDoc && - contains( preferredDoc, a ) ) { - return -1; - } - - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( b == document || b.ownerDocument == preferredDoc && - contains( preferredDoc, b ) ) { - return 1; - } - - // Maintain original order - return sortInput ? - ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : - 0; - } - - return compare & 4 ? -1 : 1; - } : - function( a, b ) { - - // Exit early if the nodes are identical - if ( a === b ) { - hasDuplicate = true; - return 0; - } - - var cur, - i = 0, - aup = a.parentNode, - bup = b.parentNode, - ap = [ a ], - bp = [ b ]; - - // Parentless nodes are either documents or disconnected - if ( !aup || !bup ) { - - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - /* eslint-disable eqeqeq */ - return a == document ? -1 : - b == document ? 1 : - /* eslint-enable eqeqeq */ - aup ? -1 : - bup ? 1 : - sortInput ? - ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : - 0; - - // If the nodes are siblings, we can do a quick check - } else if ( aup === bup ) { - return siblingCheck( a, b ); - } - - // Otherwise we need full lists of their ancestors for comparison - cur = a; - while ( ( cur = cur.parentNode ) ) { - ap.unshift( cur ); - } - cur = b; - while ( ( cur = cur.parentNode ) ) { - bp.unshift( cur ); - } - - // Walk down the tree looking for a discrepancy - while ( ap[ i ] === bp[ i ] ) { - i++; - } - - return i ? - - // Do a sibling check if the nodes have a common ancestor - siblingCheck( ap[ i ], bp[ i ] ) : - - // Otherwise nodes in our document sort first - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - /* eslint-disable eqeqeq */ - ap[ i ] == preferredDoc ? -1 : - bp[ i ] == preferredDoc ? 1 : - /* eslint-enable eqeqeq */ - 0; - }; - - return document; -}; - -Sizzle.matches = function( expr, elements ) { - return Sizzle( expr, null, null, elements ); -}; - -Sizzle.matchesSelector = function( elem, expr ) { - setDocument( elem ); - - if ( support.matchesSelector && documentIsHTML && - !nonnativeSelectorCache[ expr + " " ] && - ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && - ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { - - try { - var ret = matches.call( elem, expr ); - - // IE 9's matchesSelector returns false on disconnected nodes - if ( ret || support.disconnectedMatch || - - // As well, disconnected nodes are said to be in a document - // fragment in IE 9 - elem.document && elem.document.nodeType !== 11 ) { - return ret; - } - } catch ( e ) { - nonnativeSelectorCache( expr, true ); - } - } - - return Sizzle( expr, document, null, [ elem ] ).length > 0; -}; - -Sizzle.contains = function( context, elem ) { - - // Set document vars if needed - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( ( context.ownerDocument || context ) != document ) { - setDocument( context ); - } - return contains( context, elem ); -}; - -Sizzle.attr = function( elem, name ) { - - // Set document vars if needed - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( ( elem.ownerDocument || elem ) != document ) { - setDocument( elem ); - } - - var fn = Expr.attrHandle[ name.toLowerCase() ], - - // Don't get fooled by Object.prototype properties (jQuery #13807) - val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? - fn( elem, name, !documentIsHTML ) : - undefined; - - return val !== undefined ? - val : - support.attributes || !documentIsHTML ? - elem.getAttribute( name ) : - ( val = elem.getAttributeNode( name ) ) && val.specified ? - val.value : - null; -}; - -Sizzle.escape = function( sel ) { - return ( sel + "" ).replace( rcssescape, fcssescape ); -}; - -Sizzle.error = function( msg ) { - throw new Error( "Syntax error, unrecognized expression: " + msg ); -}; - -/** - * Document sorting and removing duplicates - * @param {ArrayLike} results - */ -Sizzle.uniqueSort = function( results ) { - var elem, - duplicates = [], - j = 0, - i = 0; - - // Unless we *know* we can detect duplicates, assume their presence - hasDuplicate = !support.detectDuplicates; - sortInput = !support.sortStable && results.slice( 0 ); - results.sort( sortOrder ); - - if ( hasDuplicate ) { - while ( ( elem = results[ i++ ] ) ) { - if ( elem === results[ i ] ) { - j = duplicates.push( i ); - } - } - while ( j-- ) { - results.splice( duplicates[ j ], 1 ); - } - } - - // Clear input after sorting to release objects - // See https://github.com/jquery/sizzle/pull/225 - sortInput = null; - - return results; -}; - -/** - * Utility function for retrieving the text value of an array of DOM nodes - * @param {Array|Element} elem - */ -getText = Sizzle.getText = function( elem ) { - var node, - ret = "", - i = 0, - nodeType = elem.nodeType; - - if ( !nodeType ) { - - // If no nodeType, this is expected to be an array - while ( ( node = elem[ i++ ] ) ) { - - // Do not traverse comment nodes - ret += getText( node ); - } - } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { - - // Use textContent for elements - // innerText usage removed for consistency of new lines (jQuery #11153) - if ( typeof elem.textContent === "string" ) { - return elem.textContent; - } else { - - // Traverse its children - for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { - ret += getText( elem ); - } - } - } else if ( nodeType === 3 || nodeType === 4 ) { - return elem.nodeValue; - } - - // Do not include comment or processing instruction nodes - - return ret; -}; - -Expr = Sizzle.selectors = { - - // Can be adjusted by the user - cacheLength: 50, - - createPseudo: markFunction, - - match: matchExpr, - - attrHandle: {}, - - find: {}, - - relative: { - ">": { dir: "parentNode", first: true }, - " ": { dir: "parentNode" }, - "+": { dir: "previousSibling", first: true }, - "~": { dir: "previousSibling" } - }, - - preFilter: { - "ATTR": function( match ) { - match[ 1 ] = match[ 1 ].replace( runescape, funescape ); - - // Move the given value to match[3] whether quoted or unquoted - match[ 3 ] = ( match[ 3 ] || match[ 4 ] || - match[ 5 ] || "" ).replace( runescape, funescape ); - - if ( match[ 2 ] === "~=" ) { - match[ 3 ] = " " + match[ 3 ] + " "; - } - - return match.slice( 0, 4 ); - }, - - "CHILD": function( match ) { - - /* matches from matchExpr["CHILD"] - 1 type (only|nth|...) - 2 what (child|of-type) - 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) - 4 xn-component of xn+y argument ([+-]?\d*n|) - 5 sign of xn-component - 6 x of xn-component - 7 sign of y-component - 8 y of y-component - */ - match[ 1 ] = match[ 1 ].toLowerCase(); - - if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { - - // nth-* requires argument - if ( !match[ 3 ] ) { - Sizzle.error( match[ 0 ] ); - } - - // numeric x and y parameters for Expr.filter.CHILD - // remember that false/true cast respectively to 0/1 - match[ 4 ] = +( match[ 4 ] ? - match[ 5 ] + ( match[ 6 ] || 1 ) : - 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); - match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); - - // other types prohibit arguments - } else if ( match[ 3 ] ) { - Sizzle.error( match[ 0 ] ); - } - - return match; - }, - - "PSEUDO": function( match ) { - var excess, - unquoted = !match[ 6 ] && match[ 2 ]; - - if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { - return null; - } - - // Accept quoted arguments as-is - if ( match[ 3 ] ) { - match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; - - // Strip excess characters from unquoted arguments - } else if ( unquoted && rpseudo.test( unquoted ) && - - // Get excess from tokenize (recursively) - ( excess = tokenize( unquoted, true ) ) && - - // advance to the next closing parenthesis - ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { - - // excess is a negative index - match[ 0 ] = match[ 0 ].slice( 0, excess ); - match[ 2 ] = unquoted.slice( 0, excess ); - } - - // Return only captures needed by the pseudo filter method (type and argument) - return match.slice( 0, 3 ); - } - }, - - filter: { - - "TAG": function( nodeNameSelector ) { - var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); - return nodeNameSelector === "*" ? - function() { - return true; - } : - function( elem ) { - return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; - }; - }, - - "CLASS": function( className ) { - var pattern = classCache[ className + " " ]; - - return pattern || - ( pattern = new RegExp( "(^|" + whitespace + - ")" + className + "(" + whitespace + "|$)" ) ) && classCache( - className, function( elem ) { - return pattern.test( - typeof elem.className === "string" && elem.className || - typeof elem.getAttribute !== "undefined" && - elem.getAttribute( "class" ) || - "" - ); - } ); - }, - - "ATTR": function( name, operator, check ) { - return function( elem ) { - var result = Sizzle.attr( elem, name ); - - if ( result == null ) { - return operator === "!="; - } - if ( !operator ) { - return true; - } - - result += ""; - - /* eslint-disable max-len */ - - return operator === "=" ? result === check : - operator === "!=" ? result !== check : - operator === "^=" ? check && result.indexOf( check ) === 0 : - operator === "*=" ? check && result.indexOf( check ) > -1 : - operator === "$=" ? check && result.slice( -check.length ) === check : - operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : - operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : - false; - /* eslint-enable max-len */ - - }; - }, - - "CHILD": function( type, what, _argument, first, last ) { - var simple = type.slice( 0, 3 ) !== "nth", - forward = type.slice( -4 ) !== "last", - ofType = what === "of-type"; - - return first === 1 && last === 0 ? - - // Shortcut for :nth-*(n) - function( elem ) { - return !!elem.parentNode; - } : - - function( elem, _context, xml ) { - var cache, uniqueCache, outerCache, node, nodeIndex, start, - dir = simple !== forward ? "nextSibling" : "previousSibling", - parent = elem.parentNode, - name = ofType && elem.nodeName.toLowerCase(), - useCache = !xml && !ofType, - diff = false; - - if ( parent ) { - - // :(first|last|only)-(child|of-type) - if ( simple ) { - while ( dir ) { - node = elem; - while ( ( node = node[ dir ] ) ) { - if ( ofType ? - node.nodeName.toLowerCase() === name : - node.nodeType === 1 ) { - - return false; - } - } - - // Reverse direction for :only-* (if we haven't yet done so) - start = dir = type === "only" && !start && "nextSibling"; - } - return true; - } - - start = [ forward ? parent.firstChild : parent.lastChild ]; - - // non-xml :nth-child(...) stores cache data on `parent` - if ( forward && useCache ) { - - // Seek `elem` from a previously-cached index - - // ...in a gzip-friendly way - node = parent; - outerCache = node[ expando ] || ( node[ expando ] = {} ); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ node.uniqueID ] || - ( outerCache[ node.uniqueID ] = {} ); - - cache = uniqueCache[ type ] || []; - nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; - diff = nodeIndex && cache[ 2 ]; - node = nodeIndex && parent.childNodes[ nodeIndex ]; - - while ( ( node = ++nodeIndex && node && node[ dir ] || - - // Fallback to seeking `elem` from the start - ( diff = nodeIndex = 0 ) || start.pop() ) ) { - - // When found, cache indexes on `parent` and break - if ( node.nodeType === 1 && ++diff && node === elem ) { - uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; - break; - } - } - - } else { - - // Use previously-cached element index if available - if ( useCache ) { - - // ...in a gzip-friendly way - node = elem; - outerCache = node[ expando ] || ( node[ expando ] = {} ); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ node.uniqueID ] || - ( outerCache[ node.uniqueID ] = {} ); - - cache = uniqueCache[ type ] || []; - nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; - diff = nodeIndex; - } - - // xml :nth-child(...) - // or :nth-last-child(...) or :nth(-last)?-of-type(...) - if ( diff === false ) { - - // Use the same loop as above to seek `elem` from the start - while ( ( node = ++nodeIndex && node && node[ dir ] || - ( diff = nodeIndex = 0 ) || start.pop() ) ) { - - if ( ( ofType ? - node.nodeName.toLowerCase() === name : - node.nodeType === 1 ) && - ++diff ) { - - // Cache the index of each encountered element - if ( useCache ) { - outerCache = node[ expando ] || - ( node[ expando ] = {} ); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ node.uniqueID ] || - ( outerCache[ node.uniqueID ] = {} ); - - uniqueCache[ type ] = [ dirruns, diff ]; - } - - if ( node === elem ) { - break; - } - } - } - } - } - - // Incorporate the offset, then check against cycle size - diff -= last; - return diff === first || ( diff % first === 0 && diff / first >= 0 ); - } - }; - }, - - "PSEUDO": function( pseudo, argument ) { - - // pseudo-class names are case-insensitive - // http://www.w3.org/TR/selectors/#pseudo-classes - // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters - // Remember that setFilters inherits from pseudos - var args, - fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || - Sizzle.error( "unsupported pseudo: " + pseudo ); - - // The user may use createPseudo to indicate that - // arguments are needed to create the filter function - // just as Sizzle does - if ( fn[ expando ] ) { - return fn( argument ); - } - - // But maintain support for old signatures - if ( fn.length > 1 ) { - args = [ pseudo, pseudo, "", argument ]; - return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? - markFunction( function( seed, matches ) { - var idx, - matched = fn( seed, argument ), - i = matched.length; - while ( i-- ) { - idx = indexOf( seed, matched[ i ] ); - seed[ idx ] = !( matches[ idx ] = matched[ i ] ); - } - } ) : - function( elem ) { - return fn( elem, 0, args ); - }; - } - - return fn; - } - }, - - pseudos: { - - // Potentially complex pseudos - "not": markFunction( function( selector ) { - - // Trim the selector passed to compile - // to avoid treating leading and trailing - // spaces as combinators - var input = [], - results = [], - matcher = compile( selector.replace( rtrim, "$1" ) ); - - return matcher[ expando ] ? - markFunction( function( seed, matches, _context, xml ) { - var elem, - unmatched = matcher( seed, null, xml, [] ), - i = seed.length; - - // Match elements unmatched by `matcher` - while ( i-- ) { - if ( ( elem = unmatched[ i ] ) ) { - seed[ i ] = !( matches[ i ] = elem ); - } - } - } ) : - function( elem, _context, xml ) { - input[ 0 ] = elem; - matcher( input, null, xml, results ); - - // Don't keep the element (issue #299) - input[ 0 ] = null; - return !results.pop(); - }; - } ), - - "has": markFunction( function( selector ) { - return function( elem ) { - return Sizzle( selector, elem ).length > 0; - }; - } ), - - "contains": markFunction( function( text ) { - text = text.replace( runescape, funescape ); - return function( elem ) { - return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; - }; - } ), - - // "Whether an element is represented by a :lang() selector - // is based solely on the element's language value - // being equal to the identifier C, - // or beginning with the identifier C immediately followed by "-". - // The matching of C against the element's language value is performed case-insensitively. - // The identifier C does not have to be a valid language name." - // http://www.w3.org/TR/selectors/#lang-pseudo - "lang": markFunction( function( lang ) { - - // lang value must be a valid identifier - if ( !ridentifier.test( lang || "" ) ) { - Sizzle.error( "unsupported lang: " + lang ); - } - lang = lang.replace( runescape, funescape ).toLowerCase(); - return function( elem ) { - var elemLang; - do { - if ( ( elemLang = documentIsHTML ? - elem.lang : - elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { - - elemLang = elemLang.toLowerCase(); - return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; - } - } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); - return false; - }; - } ), - - // Miscellaneous - "target": function( elem ) { - var hash = window.location && window.location.hash; - return hash && hash.slice( 1 ) === elem.id; - }, - - "root": function( elem ) { - return elem === docElem; - }, - - "focus": function( elem ) { - return elem === document.activeElement && - ( !document.hasFocus || document.hasFocus() ) && - !!( elem.type || elem.href || ~elem.tabIndex ); - }, - - // Boolean properties - "enabled": createDisabledPseudo( false ), - "disabled": createDisabledPseudo( true ), - - "checked": function( elem ) { - - // In CSS3, :checked should return both checked and selected elements - // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked - var nodeName = elem.nodeName.toLowerCase(); - return ( nodeName === "input" && !!elem.checked ) || - ( nodeName === "option" && !!elem.selected ); - }, - - "selected": function( elem ) { - - // Accessing this property makes selected-by-default - // options in Safari work properly - if ( elem.parentNode ) { - // eslint-disable-next-line no-unused-expressions - elem.parentNode.selectedIndex; - } - - return elem.selected === true; - }, - - // Contents - "empty": function( elem ) { - - // http://www.w3.org/TR/selectors/#empty-pseudo - // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), - // but not by others (comment: 8; processing instruction: 7; etc.) - // nodeType < 6 works because attributes (2) do not appear as children - for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { - if ( elem.nodeType < 6 ) { - return false; - } - } - return true; - }, - - "parent": function( elem ) { - return !Expr.pseudos[ "empty" ]( elem ); - }, - - // Element/input types - "header": function( elem ) { - return rheader.test( elem.nodeName ); - }, - - "input": function( elem ) { - return rinputs.test( elem.nodeName ); - }, - - "button": function( elem ) { - var name = elem.nodeName.toLowerCase(); - return name === "input" && elem.type === "button" || name === "button"; - }, - - "text": function( elem ) { - var attr; - return elem.nodeName.toLowerCase() === "input" && - elem.type === "text" && - - // Support: IE<8 - // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" - ( ( attr = elem.getAttribute( "type" ) ) == null || - attr.toLowerCase() === "text" ); - }, - - // Position-in-collection - "first": createPositionalPseudo( function() { - return [ 0 ]; - } ), - - "last": createPositionalPseudo( function( _matchIndexes, length ) { - return [ length - 1 ]; - } ), - - "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { - return [ argument < 0 ? argument + length : argument ]; - } ), - - "even": createPositionalPseudo( function( matchIndexes, length ) { - var i = 0; - for ( ; i < length; i += 2 ) { - matchIndexes.push( i ); - } - return matchIndexes; - } ), - - "odd": createPositionalPseudo( function( matchIndexes, length ) { - var i = 1; - for ( ; i < length; i += 2 ) { - matchIndexes.push( i ); - } - return matchIndexes; - } ), - - "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { - var i = argument < 0 ? - argument + length : - argument > length ? - length : - argument; - for ( ; --i >= 0; ) { - matchIndexes.push( i ); - } - return matchIndexes; - } ), - - "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { - var i = argument < 0 ? argument + length : argument; - for ( ; ++i < length; ) { - matchIndexes.push( i ); - } - return matchIndexes; - } ) - } -}; - -Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; - -// Add button/input type pseudos -for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { - Expr.pseudos[ i ] = createInputPseudo( i ); -} -for ( i in { submit: true, reset: true } ) { - Expr.pseudos[ i ] = createButtonPseudo( i ); -} - -// Easy API for creating new setFilters -function setFilters() {} -setFilters.prototype = Expr.filters = Expr.pseudos; -Expr.setFilters = new setFilters(); - -tokenize = Sizzle.tokenize = function( selector, parseOnly ) { - var matched, match, tokens, type, - soFar, groups, preFilters, - cached = tokenCache[ selector + " " ]; - - if ( cached ) { - return parseOnly ? 0 : cached.slice( 0 ); - } - - soFar = selector; - groups = []; - preFilters = Expr.preFilter; - - while ( soFar ) { - - // Comma and first run - if ( !matched || ( match = rcomma.exec( soFar ) ) ) { - if ( match ) { - - // Don't consume trailing commas as valid - soFar = soFar.slice( match[ 0 ].length ) || soFar; - } - groups.push( ( tokens = [] ) ); - } - - matched = false; - - // Combinators - if ( ( match = rcombinators.exec( soFar ) ) ) { - matched = match.shift(); - tokens.push( { - value: matched, - - // Cast descendant combinators to space - type: match[ 0 ].replace( rtrim, " " ) - } ); - soFar = soFar.slice( matched.length ); - } - - // Filters - for ( type in Expr.filter ) { - if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || - ( match = preFilters[ type ]( match ) ) ) ) { - matched = match.shift(); - tokens.push( { - value: matched, - type: type, - matches: match - } ); - soFar = soFar.slice( matched.length ); - } - } - - if ( !matched ) { - break; - } - } - - // Return the length of the invalid excess - // if we're just parsing - // Otherwise, throw an error or return tokens - return parseOnly ? - soFar.length : - soFar ? - Sizzle.error( selector ) : - - // Cache the tokens - tokenCache( selector, groups ).slice( 0 ); -}; - -function toSelector( tokens ) { - var i = 0, - len = tokens.length, - selector = ""; - for ( ; i < len; i++ ) { - selector += tokens[ i ].value; - } - return selector; -} - -function addCombinator( matcher, combinator, base ) { - var dir = combinator.dir, - skip = combinator.next, - key = skip || dir, - checkNonElements = base && key === "parentNode", - doneName = done++; - - return combinator.first ? - - // Check against closest ancestor/preceding element - function( elem, context, xml ) { - while ( ( elem = elem[ dir ] ) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - return matcher( elem, context, xml ); - } - } - return false; - } : - - // Check against all ancestor/preceding elements - function( elem, context, xml ) { - var oldCache, uniqueCache, outerCache, - newCache = [ dirruns, doneName ]; - - // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching - if ( xml ) { - while ( ( elem = elem[ dir ] ) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - if ( matcher( elem, context, xml ) ) { - return true; - } - } - } - } else { - while ( ( elem = elem[ dir ] ) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - outerCache = elem[ expando ] || ( elem[ expando ] = {} ); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ elem.uniqueID ] || - ( outerCache[ elem.uniqueID ] = {} ); - - if ( skip && skip === elem.nodeName.toLowerCase() ) { - elem = elem[ dir ] || elem; - } else if ( ( oldCache = uniqueCache[ key ] ) && - oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { - - // Assign to newCache so results back-propagate to previous elements - return ( newCache[ 2 ] = oldCache[ 2 ] ); - } else { - - // Reuse newcache so results back-propagate to previous elements - uniqueCache[ key ] = newCache; - - // A match means we're done; a fail means we have to keep checking - if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { - return true; - } - } - } - } - } - return false; - }; -} - -function elementMatcher( matchers ) { - return matchers.length > 1 ? - function( elem, context, xml ) { - var i = matchers.length; - while ( i-- ) { - if ( !matchers[ i ]( elem, context, xml ) ) { - return false; - } - } - return true; - } : - matchers[ 0 ]; -} - -function multipleContexts( selector, contexts, results ) { - var i = 0, - len = contexts.length; - for ( ; i < len; i++ ) { - Sizzle( selector, contexts[ i ], results ); - } - return results; -} - -function condense( unmatched, map, filter, context, xml ) { - var elem, - newUnmatched = [], - i = 0, - len = unmatched.length, - mapped = map != null; - - for ( ; i < len; i++ ) { - if ( ( elem = unmatched[ i ] ) ) { - if ( !filter || filter( elem, context, xml ) ) { - newUnmatched.push( elem ); - if ( mapped ) { - map.push( i ); - } - } - } - } - - return newUnmatched; -} - -function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { - if ( postFilter && !postFilter[ expando ] ) { - postFilter = setMatcher( postFilter ); - } - if ( postFinder && !postFinder[ expando ] ) { - postFinder = setMatcher( postFinder, postSelector ); - } - return markFunction( function( seed, results, context, xml ) { - var temp, i, elem, - preMap = [], - postMap = [], - preexisting = results.length, - - // Get initial elements from seed or context - elems = seed || multipleContexts( - selector || "*", - context.nodeType ? [ context ] : context, - [] - ), - - // Prefilter to get matcher input, preserving a map for seed-results synchronization - matcherIn = preFilter && ( seed || !selector ) ? - condense( elems, preMap, preFilter, context, xml ) : - elems, - - matcherOut = matcher ? - - // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, - postFinder || ( seed ? preFilter : preexisting || postFilter ) ? - - // ...intermediate processing is necessary - [] : - - // ...otherwise use results directly - results : - matcherIn; - - // Find primary matches - if ( matcher ) { - matcher( matcherIn, matcherOut, context, xml ); - } - - // Apply postFilter - if ( postFilter ) { - temp = condense( matcherOut, postMap ); - postFilter( temp, [], context, xml ); - - // Un-match failing elements by moving them back to matcherIn - i = temp.length; - while ( i-- ) { - if ( ( elem = temp[ i ] ) ) { - matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); - } - } - } - - if ( seed ) { - if ( postFinder || preFilter ) { - if ( postFinder ) { - - // Get the final matcherOut by condensing this intermediate into postFinder contexts - temp = []; - i = matcherOut.length; - while ( i-- ) { - if ( ( elem = matcherOut[ i ] ) ) { - - // Restore matcherIn since elem is not yet a final match - temp.push( ( matcherIn[ i ] = elem ) ); - } - } - postFinder( null, ( matcherOut = [] ), temp, xml ); - } - - // Move matched elements from seed to results to keep them synchronized - i = matcherOut.length; - while ( i-- ) { - if ( ( elem = matcherOut[ i ] ) && - ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { - - seed[ temp ] = !( results[ temp ] = elem ); - } - } - } - - // Add elements to results, through postFinder if defined - } else { - matcherOut = condense( - matcherOut === results ? - matcherOut.splice( preexisting, matcherOut.length ) : - matcherOut - ); - if ( postFinder ) { - postFinder( null, results, matcherOut, xml ); - } else { - push.apply( results, matcherOut ); - } - } - } ); -} - -function matcherFromTokens( tokens ) { - var checkContext, matcher, j, - len = tokens.length, - leadingRelative = Expr.relative[ tokens[ 0 ].type ], - implicitRelative = leadingRelative || Expr.relative[ " " ], - i = leadingRelative ? 1 : 0, - - // The foundational matcher ensures that elements are reachable from top-level context(s) - matchContext = addCombinator( function( elem ) { - return elem === checkContext; - }, implicitRelative, true ), - matchAnyContext = addCombinator( function( elem ) { - return indexOf( checkContext, elem ) > -1; - }, implicitRelative, true ), - matchers = [ function( elem, context, xml ) { - var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( - ( checkContext = context ).nodeType ? - matchContext( elem, context, xml ) : - matchAnyContext( elem, context, xml ) ); - - // Avoid hanging onto element (issue #299) - checkContext = null; - return ret; - } ]; - - for ( ; i < len; i++ ) { - if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { - matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; - } else { - matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); - - // Return special upon seeing a positional matcher - if ( matcher[ expando ] ) { - - // Find the next relative operator (if any) for proper handling - j = ++i; - for ( ; j < len; j++ ) { - if ( Expr.relative[ tokens[ j ].type ] ) { - break; - } - } - return setMatcher( - i > 1 && elementMatcher( matchers ), - i > 1 && toSelector( - - // If the preceding token was a descendant combinator, insert an implicit any-element `*` - tokens - .slice( 0, i - 1 ) - .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) - ).replace( rtrim, "$1" ), - matcher, - i < j && matcherFromTokens( tokens.slice( i, j ) ), - j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), - j < len && toSelector( tokens ) - ); - } - matchers.push( matcher ); - } - } - - return elementMatcher( matchers ); -} - -function matcherFromGroupMatchers( elementMatchers, setMatchers ) { - var bySet = setMatchers.length > 0, - byElement = elementMatchers.length > 0, - superMatcher = function( seed, context, xml, results, outermost ) { - var elem, j, matcher, - matchedCount = 0, - i = "0", - unmatched = seed && [], - setMatched = [], - contextBackup = outermostContext, - - // We must always have either seed elements or outermost context - elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), - - // Use integer dirruns iff this is the outermost matcher - dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), - len = elems.length; - - if ( outermost ) { - - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - outermostContext = context == document || context || outermost; - } - - // Add elements passing elementMatchers directly to results - // Support: IE<9, Safari - // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id - for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { - if ( byElement && elem ) { - j = 0; - - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( !context && elem.ownerDocument != document ) { - setDocument( elem ); - xml = !documentIsHTML; - } - while ( ( matcher = elementMatchers[ j++ ] ) ) { - if ( matcher( elem, context || document, xml ) ) { - results.push( elem ); - break; - } - } - if ( outermost ) { - dirruns = dirrunsUnique; - } - } - - // Track unmatched elements for set filters - if ( bySet ) { - - // They will have gone through all possible matchers - if ( ( elem = !matcher && elem ) ) { - matchedCount--; - } - - // Lengthen the array for every element, matched or not - if ( seed ) { - unmatched.push( elem ); - } - } - } - - // `i` is now the count of elements visited above, and adding it to `matchedCount` - // makes the latter nonnegative. - matchedCount += i; - - // Apply set filters to unmatched elements - // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` - // equals `i`), unless we didn't visit _any_ elements in the above loop because we have - // no element matchers and no seed. - // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that - // case, which will result in a "00" `matchedCount` that differs from `i` but is also - // numerically zero. - if ( bySet && i !== matchedCount ) { - j = 0; - while ( ( matcher = setMatchers[ j++ ] ) ) { - matcher( unmatched, setMatched, context, xml ); - } - - if ( seed ) { - - // Reintegrate element matches to eliminate the need for sorting - if ( matchedCount > 0 ) { - while ( i-- ) { - if ( !( unmatched[ i ] || setMatched[ i ] ) ) { - setMatched[ i ] = pop.call( results ); - } - } - } - - // Discard index placeholder values to get only actual matches - setMatched = condense( setMatched ); - } - - // Add matches to results - push.apply( results, setMatched ); - - // Seedless set matches succeeding multiple successful matchers stipulate sorting - if ( outermost && !seed && setMatched.length > 0 && - ( matchedCount + setMatchers.length ) > 1 ) { - - Sizzle.uniqueSort( results ); - } - } - - // Override manipulation of globals by nested matchers - if ( outermost ) { - dirruns = dirrunsUnique; - outermostContext = contextBackup; - } - - return unmatched; - }; - - return bySet ? - markFunction( superMatcher ) : - superMatcher; -} - -compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { - var i, - setMatchers = [], - elementMatchers = [], - cached = compilerCache[ selector + " " ]; - - if ( !cached ) { - - // Generate a function of recursive functions that can be used to check each element - if ( !match ) { - match = tokenize( selector ); - } - i = match.length; - while ( i-- ) { - cached = matcherFromTokens( match[ i ] ); - if ( cached[ expando ] ) { - setMatchers.push( cached ); - } else { - elementMatchers.push( cached ); - } - } - - // Cache the compiled function - cached = compilerCache( - selector, - matcherFromGroupMatchers( elementMatchers, setMatchers ) - ); - - // Save selector and tokenization - cached.selector = selector; - } - return cached; -}; - -/** - * A low-level selection function that works with Sizzle's compiled - * selector functions - * @param {String|Function} selector A selector or a pre-compiled - * selector function built with Sizzle.compile - * @param {Element} context - * @param {Array} [results] - * @param {Array} [seed] A set of elements to match against - */ -select = Sizzle.select = function( selector, context, results, seed ) { - var i, tokens, token, type, find, - compiled = typeof selector === "function" && selector, - match = !seed && tokenize( ( selector = compiled.selector || selector ) ); - - results = results || []; - - // Try to minimize operations if there is only one selector in the list and no seed - // (the latter of which guarantees us context) - if ( match.length === 1 ) { - - // Reduce context if the leading compound selector is an ID - tokens = match[ 0 ] = match[ 0 ].slice( 0 ); - if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && - context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { - - context = ( Expr.find[ "ID" ]( token.matches[ 0 ] - .replace( runescape, funescape ), context ) || [] )[ 0 ]; - if ( !context ) { - return results; - - // Precompiled matchers will still verify ancestry, so step up a level - } else if ( compiled ) { - context = context.parentNode; - } - - selector = selector.slice( tokens.shift().value.length ); - } - - // Fetch a seed set for right-to-left matching - i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; - while ( i-- ) { - token = tokens[ i ]; - - // Abort if we hit a combinator - if ( Expr.relative[ ( type = token.type ) ] ) { - break; - } - if ( ( find = Expr.find[ type ] ) ) { - - // Search, expanding context for leading sibling combinators - if ( ( seed = find( - token.matches[ 0 ].replace( runescape, funescape ), - rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || - context - ) ) ) { - - // If seed is empty or no tokens remain, we can return early - tokens.splice( i, 1 ); - selector = seed.length && toSelector( tokens ); - if ( !selector ) { - push.apply( results, seed ); - return results; - } - - break; - } - } - } - } - - // Compile and execute a filtering function if one is not provided - // Provide `match` to avoid retokenization if we modified the selector above - ( compiled || compile( selector, match ) )( - seed, - context, - !documentIsHTML, - results, - !context || rsibling.test( selector ) && testContext( context.parentNode ) || context - ); - return results; -}; - -// One-time assignments - -// Sort stability -support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; - -// Support: Chrome 14-35+ -// Always assume duplicates if they aren't passed to the comparison function -support.detectDuplicates = !!hasDuplicate; - -// Initialize against the default document -setDocument(); - -// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) -// Detached nodes confoundingly follow *each other* -support.sortDetached = assert( function( el ) { - - // Should return 1, but returns 4 (following) - return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; -} ); - -// Support: IE<8 -// Prevent attribute/property "interpolation" -// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx -if ( !assert( function( el ) { - el.innerHTML = ""; - return el.firstChild.getAttribute( "href" ) === "#"; -} ) ) { - addHandle( "type|href|height|width", function( elem, name, isXML ) { - if ( !isXML ) { - return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); - } - } ); -} - -// Support: IE<9 -// Use defaultValue in place of getAttribute("value") -if ( !support.attributes || !assert( function( el ) { - el.innerHTML = ""; - el.firstChild.setAttribute( "value", "" ); - return el.firstChild.getAttribute( "value" ) === ""; -} ) ) { - addHandle( "value", function( elem, _name, isXML ) { - if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { - return elem.defaultValue; - } - } ); -} - -// Support: IE<9 -// Use getAttributeNode to fetch booleans when getAttribute lies -if ( !assert( function( el ) { - return el.getAttribute( "disabled" ) == null; -} ) ) { - addHandle( booleans, function( elem, name, isXML ) { - var val; - if ( !isXML ) { - return elem[ name ] === true ? name.toLowerCase() : - ( val = elem.getAttributeNode( name ) ) && val.specified ? - val.value : - null; - } - } ); -} - -return Sizzle; - -} )( window ); - - - -jQuery.find = Sizzle; -jQuery.expr = Sizzle.selectors; - -// Deprecated -jQuery.expr[ ":" ] = jQuery.expr.pseudos; -jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; -jQuery.text = Sizzle.getText; -jQuery.isXMLDoc = Sizzle.isXML; -jQuery.contains = Sizzle.contains; -jQuery.escapeSelector = Sizzle.escape; - - - - -var dir = function( elem, dir, until ) { - var matched = [], - truncate = until !== undefined; - - while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { - if ( elem.nodeType === 1 ) { - if ( truncate && jQuery( elem ).is( until ) ) { - break; - } - matched.push( elem ); - } - } - return matched; -}; - - -var siblings = function( n, elem ) { - var matched = []; - - for ( ; n; n = n.nextSibling ) { - if ( n.nodeType === 1 && n !== elem ) { - matched.push( n ); - } - } - - return matched; -}; - - -var rneedsContext = jQuery.expr.match.needsContext; - - - -function nodeName( elem, name ) { - - return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); - -}; -var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); - - - -// Implement the identical functionality for filter and not -function winnow( elements, qualifier, not ) { - if ( isFunction( qualifier ) ) { - return jQuery.grep( elements, function( elem, i ) { - return !!qualifier.call( elem, i, elem ) !== not; - } ); - } - - // Single element - if ( qualifier.nodeType ) { - return jQuery.grep( elements, function( elem ) { - return ( elem === qualifier ) !== not; - } ); - } - - // Arraylike of elements (jQuery, arguments, Array) - if ( typeof qualifier !== "string" ) { - return jQuery.grep( elements, function( elem ) { - return ( indexOf.call( qualifier, elem ) > -1 ) !== not; - } ); - } - - // Filtered directly for both simple and complex selectors - return jQuery.filter( qualifier, elements, not ); -} - -jQuery.filter = function( expr, elems, not ) { - var elem = elems[ 0 ]; - - if ( not ) { - expr = ":not(" + expr + ")"; - } - - if ( elems.length === 1 && elem.nodeType === 1 ) { - return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; - } - - return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { - return elem.nodeType === 1; - } ) ); -}; - -jQuery.fn.extend( { - find: function( selector ) { - var i, ret, - len = this.length, - self = this; - - if ( typeof selector !== "string" ) { - return this.pushStack( jQuery( selector ).filter( function() { - for ( i = 0; i < len; i++ ) { - if ( jQuery.contains( self[ i ], this ) ) { - return true; - } - } - } ) ); - } - - ret = this.pushStack( [] ); - - for ( i = 0; i < len; i++ ) { - jQuery.find( selector, self[ i ], ret ); - } - - return len > 1 ? jQuery.uniqueSort( ret ) : ret; - }, - filter: function( selector ) { - return this.pushStack( winnow( this, selector || [], false ) ); - }, - not: function( selector ) { - return this.pushStack( winnow( this, selector || [], true ) ); - }, - is: function( selector ) { - return !!winnow( - this, - - // If this is a positional/relative selector, check membership in the returned set - // so $("p:first").is("p:last") won't return true for a doc with two "p". - typeof selector === "string" && rneedsContext.test( selector ) ? - jQuery( selector ) : - selector || [], - false - ).length; - } -} ); - - -// Initialize a jQuery object - - -// A central reference to the root jQuery(document) -var rootjQuery, - - // A simple way to check for HTML strings - // Prioritize #id over to avoid XSS via location.hash (#9521) - // Strict HTML recognition (#11290: must start with <) - // Shortcut simple #id case for speed - rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, - - init = jQuery.fn.init = function( selector, context, root ) { - var match, elem; - - // HANDLE: $(""), $(null), $(undefined), $(false) - if ( !selector ) { - return this; - } - - // Method init() accepts an alternate rootjQuery - // so migrate can support jQuery.sub (gh-2101) - root = root || rootjQuery; - - // Handle HTML strings - if ( typeof selector === "string" ) { - if ( selector[ 0 ] === "<" && - selector[ selector.length - 1 ] === ">" && - selector.length >= 3 ) { - - // Assume that strings that start and end with <> are HTML and skip the regex check - match = [ null, selector, null ]; - - } else { - match = rquickExpr.exec( selector ); - } - - // Match html or make sure no context is specified for #id - if ( match && ( match[ 1 ] || !context ) ) { - - // HANDLE: $(html) -> $(array) - if ( match[ 1 ] ) { - context = context instanceof jQuery ? context[ 0 ] : context; - - // Option to run scripts is true for back-compat - // Intentionally let the error be thrown if parseHTML is not present - jQuery.merge( this, jQuery.parseHTML( - match[ 1 ], - context && context.nodeType ? context.ownerDocument || context : document, - true - ) ); - - // HANDLE: $(html, props) - if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { - for ( match in context ) { - - // Properties of context are called as methods if possible - if ( isFunction( this[ match ] ) ) { - this[ match ]( context[ match ] ); - - // ...and otherwise set as attributes - } else { - this.attr( match, context[ match ] ); - } - } - } - - return this; - - // HANDLE: $(#id) - } else { - elem = document.getElementById( match[ 2 ] ); - - if ( elem ) { - - // Inject the element directly into the jQuery object - this[ 0 ] = elem; - this.length = 1; - } - return this; - } - - // HANDLE: $(expr, $(...)) - } else if ( !context || context.jquery ) { - return ( context || root ).find( selector ); - - // HANDLE: $(expr, context) - // (which is just equivalent to: $(context).find(expr) - } else { - return this.constructor( context ).find( selector ); - } - - // HANDLE: $(DOMElement) - } else if ( selector.nodeType ) { - this[ 0 ] = selector; - this.length = 1; - return this; - - // HANDLE: $(function) - // Shortcut for document ready - } else if ( isFunction( selector ) ) { - return root.ready !== undefined ? - root.ready( selector ) : - - // Execute immediately if ready is not present - selector( jQuery ); - } - - return jQuery.makeArray( selector, this ); - }; - -// Give the init function the jQuery prototype for later instantiation -init.prototype = jQuery.fn; - -// Initialize central reference -rootjQuery = jQuery( document ); - - -var rparentsprev = /^(?:parents|prev(?:Until|All))/, - - // Methods guaranteed to produce a unique set when starting from a unique set - guaranteedUnique = { - children: true, - contents: true, - next: true, - prev: true - }; - -jQuery.fn.extend( { - has: function( target ) { - var targets = jQuery( target, this ), - l = targets.length; - - return this.filter( function() { - var i = 0; - for ( ; i < l; i++ ) { - if ( jQuery.contains( this, targets[ i ] ) ) { - return true; - } - } - } ); - }, - - closest: function( selectors, context ) { - var cur, - i = 0, - l = this.length, - matched = [], - targets = typeof selectors !== "string" && jQuery( selectors ); - - // Positional selectors never match, since there's no _selection_ context - if ( !rneedsContext.test( selectors ) ) { - for ( ; i < l; i++ ) { - for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { - - // Always skip document fragments - if ( cur.nodeType < 11 && ( targets ? - targets.index( cur ) > -1 : - - // Don't pass non-elements to Sizzle - cur.nodeType === 1 && - jQuery.find.matchesSelector( cur, selectors ) ) ) { - - matched.push( cur ); - break; - } - } - } - } - - return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); - }, - - // Determine the position of an element within the set - index: function( elem ) { - - // No argument, return index in parent - if ( !elem ) { - return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; - } - - // Index in selector - if ( typeof elem === "string" ) { - return indexOf.call( jQuery( elem ), this[ 0 ] ); - } - - // Locate the position of the desired element - return indexOf.call( this, - - // If it receives a jQuery object, the first element is used - elem.jquery ? elem[ 0 ] : elem - ); - }, - - add: function( selector, context ) { - return this.pushStack( - jQuery.uniqueSort( - jQuery.merge( this.get(), jQuery( selector, context ) ) - ) - ); - }, - - addBack: function( selector ) { - return this.add( selector == null ? - this.prevObject : this.prevObject.filter( selector ) - ); - } -} ); - -function sibling( cur, dir ) { - while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} - return cur; -} - -jQuery.each( { - parent: function( elem ) { - var parent = elem.parentNode; - return parent && parent.nodeType !== 11 ? parent : null; - }, - parents: function( elem ) { - return dir( elem, "parentNode" ); - }, - parentsUntil: function( elem, _i, until ) { - return dir( elem, "parentNode", until ); - }, - next: function( elem ) { - return sibling( elem, "nextSibling" ); - }, - prev: function( elem ) { - return sibling( elem, "previousSibling" ); - }, - nextAll: function( elem ) { - return dir( elem, "nextSibling" ); - }, - prevAll: function( elem ) { - return dir( elem, "previousSibling" ); - }, - nextUntil: function( elem, _i, until ) { - return dir( elem, "nextSibling", until ); - }, - prevUntil: function( elem, _i, until ) { - return dir( elem, "previousSibling", until ); - }, - siblings: function( elem ) { - return siblings( ( elem.parentNode || {} ).firstChild, elem ); - }, - children: function( elem ) { - return siblings( elem.firstChild ); - }, - contents: function( elem ) { - if ( elem.contentDocument != null && - - // Support: IE 11+ - // elements with no `data` attribute has an object - // `contentDocument` with a `null` prototype. - getProto( elem.contentDocument ) ) { - - return elem.contentDocument; - } - - // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only - // Treat the template element as a regular one in browsers that - // don't support it. - if ( nodeName( elem, "template" ) ) { - elem = elem.content || elem; - } - - return jQuery.merge( [], elem.childNodes ); - } -}, function( name, fn ) { - jQuery.fn[ name ] = function( until, selector ) { - var matched = jQuery.map( this, fn, until ); - - if ( name.slice( -5 ) !== "Until" ) { - selector = until; - } - - if ( selector && typeof selector === "string" ) { - matched = jQuery.filter( selector, matched ); - } - - if ( this.length > 1 ) { - - // Remove duplicates - if ( !guaranteedUnique[ name ] ) { - jQuery.uniqueSort( matched ); - } - - // Reverse order for parents* and prev-derivatives - if ( rparentsprev.test( name ) ) { - matched.reverse(); - } - } - - return this.pushStack( matched ); - }; -} ); -var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); - - - -// Convert String-formatted options into Object-formatted ones -function createOptions( options ) { - var object = {}; - jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { - object[ flag ] = true; - } ); - return object; -} - -/* - * Create a callback list using the following parameters: - * - * options: an optional list of space-separated options that will change how - * the callback list behaves or a more traditional option object - * - * By default a callback list will act like an event callback list and can be - * "fired" multiple times. - * - * Possible options: - * - * once: will ensure the callback list can only be fired once (like a Deferred) - * - * memory: will keep track of previous values and will call any callback added - * after the list has been fired right away with the latest "memorized" - * values (like a Deferred) - * - * unique: will ensure a callback can only be added once (no duplicate in the list) - * - * stopOnFalse: interrupt callings when a callback returns false - * - */ -jQuery.Callbacks = function( options ) { - - // Convert options from String-formatted to Object-formatted if needed - // (we check in cache first) - options = typeof options === "string" ? - createOptions( options ) : - jQuery.extend( {}, options ); - - var // Flag to know if list is currently firing - firing, - - // Last fire value for non-forgettable lists - memory, - - // Flag to know if list was already fired - fired, - - // Flag to prevent firing - locked, - - // Actual callback list - list = [], - - // Queue of execution data for repeatable lists - queue = [], - - // Index of currently firing callback (modified by add/remove as needed) - firingIndex = -1, - - // Fire callbacks - fire = function() { - - // Enforce single-firing - locked = locked || options.once; - - // Execute callbacks for all pending executions, - // respecting firingIndex overrides and runtime changes - fired = firing = true; - for ( ; queue.length; firingIndex = -1 ) { - memory = queue.shift(); - while ( ++firingIndex < list.length ) { - - // Run callback and check for early termination - if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && - options.stopOnFalse ) { - - // Jump to end and forget the data so .add doesn't re-fire - firingIndex = list.length; - memory = false; - } - } - } - - // Forget the data if we're done with it - if ( !options.memory ) { - memory = false; - } - - firing = false; - - // Clean up if we're done firing for good - if ( locked ) { - - // Keep an empty list if we have data for future add calls - if ( memory ) { - list = []; - - // Otherwise, this object is spent - } else { - list = ""; - } - } - }, - - // Actual Callbacks object - self = { - - // Add a callback or a collection of callbacks to the list - add: function() { - if ( list ) { - - // If we have memory from a past run, we should fire after adding - if ( memory && !firing ) { - firingIndex = list.length - 1; - queue.push( memory ); - } - - ( function add( args ) { - jQuery.each( args, function( _, arg ) { - if ( isFunction( arg ) ) { - if ( !options.unique || !self.has( arg ) ) { - list.push( arg ); - } - } else if ( arg && arg.length && toType( arg ) !== "string" ) { - - // Inspect recursively - add( arg ); - } - } ); - } )( arguments ); - - if ( memory && !firing ) { - fire(); - } - } - return this; - }, - - // Remove a callback from the list - remove: function() { - jQuery.each( arguments, function( _, arg ) { - var index; - while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { - list.splice( index, 1 ); - - // Handle firing indexes - if ( index <= firingIndex ) { - firingIndex--; - } - } - } ); - return this; - }, - - // Check if a given callback is in the list. - // If no argument is given, return whether or not list has callbacks attached. - has: function( fn ) { - return fn ? - jQuery.inArray( fn, list ) > -1 : - list.length > 0; - }, - - // Remove all callbacks from the list - empty: function() { - if ( list ) { - list = []; - } - return this; - }, - - // Disable .fire and .add - // Abort any current/pending executions - // Clear all callbacks and values - disable: function() { - locked = queue = []; - list = memory = ""; - return this; - }, - disabled: function() { - return !list; - }, - - // Disable .fire - // Also disable .add unless we have memory (since it would have no effect) - // Abort any pending executions - lock: function() { - locked = queue = []; - if ( !memory && !firing ) { - list = memory = ""; - } - return this; - }, - locked: function() { - return !!locked; - }, - - // Call all callbacks with the given context and arguments - fireWith: function( context, args ) { - if ( !locked ) { - args = args || []; - args = [ context, args.slice ? args.slice() : args ]; - queue.push( args ); - if ( !firing ) { - fire(); - } - } - return this; - }, - - // Call all the callbacks with the given arguments - fire: function() { - self.fireWith( this, arguments ); - return this; - }, - - // To know if the callbacks have already been called at least once - fired: function() { - return !!fired; - } - }; - - return self; -}; - - -function Identity( v ) { - return v; -} -function Thrower( ex ) { - throw ex; -} - -function adoptValue( value, resolve, reject, noValue ) { - var method; - - try { - - // Check for promise aspect first to privilege synchronous behavior - if ( value && isFunction( ( method = value.promise ) ) ) { - method.call( value ).done( resolve ).fail( reject ); - - // Other thenables - } else if ( value && isFunction( ( method = value.then ) ) ) { - method.call( value, resolve, reject ); - - // Other non-thenables - } else { - - // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: - // * false: [ value ].slice( 0 ) => resolve( value ) - // * true: [ value ].slice( 1 ) => resolve() - resolve.apply( undefined, [ value ].slice( noValue ) ); - } - - // For Promises/A+, convert exceptions into rejections - // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in - // Deferred#then to conditionally suppress rejection. - } catch ( value ) { - - // Support: Android 4.0 only - // Strict mode functions invoked without .call/.apply get global-object context - reject.apply( undefined, [ value ] ); - } -} - -jQuery.extend( { - - Deferred: function( func ) { - var tuples = [ - - // action, add listener, callbacks, - // ... .then handlers, argument index, [final state] - [ "notify", "progress", jQuery.Callbacks( "memory" ), - jQuery.Callbacks( "memory" ), 2 ], - [ "resolve", "done", jQuery.Callbacks( "once memory" ), - jQuery.Callbacks( "once memory" ), 0, "resolved" ], - [ "reject", "fail", jQuery.Callbacks( "once memory" ), - jQuery.Callbacks( "once memory" ), 1, "rejected" ] - ], - state = "pending", - promise = { - state: function() { - return state; - }, - always: function() { - deferred.done( arguments ).fail( arguments ); - return this; - }, - "catch": function( fn ) { - return promise.then( null, fn ); - }, - - // Keep pipe for back-compat - pipe: function( /* fnDone, fnFail, fnProgress */ ) { - var fns = arguments; - - return jQuery.Deferred( function( newDefer ) { - jQuery.each( tuples, function( _i, tuple ) { - - // Map tuples (progress, done, fail) to arguments (done, fail, progress) - var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; - - // deferred.progress(function() { bind to newDefer or newDefer.notify }) - // deferred.done(function() { bind to newDefer or newDefer.resolve }) - // deferred.fail(function() { bind to newDefer or newDefer.reject }) - deferred[ tuple[ 1 ] ]( function() { - var returned = fn && fn.apply( this, arguments ); - if ( returned && isFunction( returned.promise ) ) { - returned.promise() - .progress( newDefer.notify ) - .done( newDefer.resolve ) - .fail( newDefer.reject ); - } else { - newDefer[ tuple[ 0 ] + "With" ]( - this, - fn ? [ returned ] : arguments - ); - } - } ); - } ); - fns = null; - } ).promise(); - }, - then: function( onFulfilled, onRejected, onProgress ) { - var maxDepth = 0; - function resolve( depth, deferred, handler, special ) { - return function() { - var that = this, - args = arguments, - mightThrow = function() { - var returned, then; - - // Support: Promises/A+ section 2.3.3.3.3 - // https://promisesaplus.com/#point-59 - // Ignore double-resolution attempts - if ( depth < maxDepth ) { - return; - } - - returned = handler.apply( that, args ); - - // Support: Promises/A+ section 2.3.1 - // https://promisesaplus.com/#point-48 - if ( returned === deferred.promise() ) { - throw new TypeError( "Thenable self-resolution" ); - } - - // Support: Promises/A+ sections 2.3.3.1, 3.5 - // https://promisesaplus.com/#point-54 - // https://promisesaplus.com/#point-75 - // Retrieve `then` only once - then = returned && - - // Support: Promises/A+ section 2.3.4 - // https://promisesaplus.com/#point-64 - // Only check objects and functions for thenability - ( typeof returned === "object" || - typeof returned === "function" ) && - returned.then; - - // Handle a returned thenable - if ( isFunction( then ) ) { - - // Special processors (notify) just wait for resolution - if ( special ) { - then.call( - returned, - resolve( maxDepth, deferred, Identity, special ), - resolve( maxDepth, deferred, Thrower, special ) - ); - - // Normal processors (resolve) also hook into progress - } else { - - // ...and disregard older resolution values - maxDepth++; - - then.call( - returned, - resolve( maxDepth, deferred, Identity, special ), - resolve( maxDepth, deferred, Thrower, special ), - resolve( maxDepth, deferred, Identity, - deferred.notifyWith ) - ); - } - - // Handle all other returned values - } else { - - // Only substitute handlers pass on context - // and multiple values (non-spec behavior) - if ( handler !== Identity ) { - that = undefined; - args = [ returned ]; - } - - // Process the value(s) - // Default process is resolve - ( special || deferred.resolveWith )( that, args ); - } - }, - - // Only normal processors (resolve) catch and reject exceptions - process = special ? - mightThrow : - function() { - try { - mightThrow(); - } catch ( e ) { - - if ( jQuery.Deferred.exceptionHook ) { - jQuery.Deferred.exceptionHook( e, - process.stackTrace ); - } - - // Support: Promises/A+ section 2.3.3.3.4.1 - // https://promisesaplus.com/#point-61 - // Ignore post-resolution exceptions - if ( depth + 1 >= maxDepth ) { - - // Only substitute handlers pass on context - // and multiple values (non-spec behavior) - if ( handler !== Thrower ) { - that = undefined; - args = [ e ]; - } - - deferred.rejectWith( that, args ); - } - } - }; - - // Support: Promises/A+ section 2.3.3.3.1 - // https://promisesaplus.com/#point-57 - // Re-resolve promises immediately to dodge false rejection from - // subsequent errors - if ( depth ) { - process(); - } else { - - // Call an optional hook to record the stack, in case of exception - // since it's otherwise lost when execution goes async - if ( jQuery.Deferred.getStackHook ) { - process.stackTrace = jQuery.Deferred.getStackHook(); - } - window.setTimeout( process ); - } - }; - } - - return jQuery.Deferred( function( newDefer ) { - - // progress_handlers.add( ... ) - tuples[ 0 ][ 3 ].add( - resolve( - 0, - newDefer, - isFunction( onProgress ) ? - onProgress : - Identity, - newDefer.notifyWith - ) - ); - - // fulfilled_handlers.add( ... ) - tuples[ 1 ][ 3 ].add( - resolve( - 0, - newDefer, - isFunction( onFulfilled ) ? - onFulfilled : - Identity - ) - ); - - // rejected_handlers.add( ... ) - tuples[ 2 ][ 3 ].add( - resolve( - 0, - newDefer, - isFunction( onRejected ) ? - onRejected : - Thrower - ) - ); - } ).promise(); - }, - - // Get a promise for this deferred - // If obj is provided, the promise aspect is added to the object - promise: function( obj ) { - return obj != null ? jQuery.extend( obj, promise ) : promise; - } - }, - deferred = {}; - - // Add list-specific methods - jQuery.each( tuples, function( i, tuple ) { - var list = tuple[ 2 ], - stateString = tuple[ 5 ]; - - // promise.progress = list.add - // promise.done = list.add - // promise.fail = list.add - promise[ tuple[ 1 ] ] = list.add; - - // Handle state - if ( stateString ) { - list.add( - function() { - - // state = "resolved" (i.e., fulfilled) - // state = "rejected" - state = stateString; - }, - - // rejected_callbacks.disable - // fulfilled_callbacks.disable - tuples[ 3 - i ][ 2 ].disable, - - // rejected_handlers.disable - // fulfilled_handlers.disable - tuples[ 3 - i ][ 3 ].disable, - - // progress_callbacks.lock - tuples[ 0 ][ 2 ].lock, - - // progress_handlers.lock - tuples[ 0 ][ 3 ].lock - ); - } - - // progress_handlers.fire - // fulfilled_handlers.fire - // rejected_handlers.fire - list.add( tuple[ 3 ].fire ); - - // deferred.notify = function() { deferred.notifyWith(...) } - // deferred.resolve = function() { deferred.resolveWith(...) } - // deferred.reject = function() { deferred.rejectWith(...) } - deferred[ tuple[ 0 ] ] = function() { - deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); - return this; - }; - - // deferred.notifyWith = list.fireWith - // deferred.resolveWith = list.fireWith - // deferred.rejectWith = list.fireWith - deferred[ tuple[ 0 ] + "With" ] = list.fireWith; - } ); - - // Make the deferred a promise - promise.promise( deferred ); - - // Call given func if any - if ( func ) { - func.call( deferred, deferred ); - } - - // All done! - return deferred; - }, - - // Deferred helper - when: function( singleValue ) { - var - - // count of uncompleted subordinates - remaining = arguments.length, - - // count of unprocessed arguments - i = remaining, - - // subordinate fulfillment data - resolveContexts = Array( i ), - resolveValues = slice.call( arguments ), - - // the master Deferred - master = jQuery.Deferred(), - - // subordinate callback factory - updateFunc = function( i ) { - return function( value ) { - resolveContexts[ i ] = this; - resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; - if ( !( --remaining ) ) { - master.resolveWith( resolveContexts, resolveValues ); - } - }; - }; - - // Single- and empty arguments are adopted like Promise.resolve - if ( remaining <= 1 ) { - adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, - !remaining ); - - // Use .then() to unwrap secondary thenables (cf. gh-3000) - if ( master.state() === "pending" || - isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { - - return master.then(); - } - } - - // Multiple arguments are aggregated like Promise.all array elements - while ( i-- ) { - adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); - } - - return master.promise(); - } -} ); - - -// These usually indicate a programmer mistake during development, -// warn about them ASAP rather than swallowing them by default. -var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; - -jQuery.Deferred.exceptionHook = function( error, stack ) { - - // Support: IE 8 - 9 only - // Console exists when dev tools are open, which can happen at any time - if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { - window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); - } -}; - - - - -jQuery.readyException = function( error ) { - window.setTimeout( function() { - throw error; - } ); -}; - - - - -// The deferred used on DOM ready -var readyList = jQuery.Deferred(); - -jQuery.fn.ready = function( fn ) { - - readyList - .then( fn ) - - // Wrap jQuery.readyException in a function so that the lookup - // happens at the time of error handling instead of callback - // registration. - .catch( function( error ) { - jQuery.readyException( error ); - } ); - - return this; -}; - -jQuery.extend( { - - // Is the DOM ready to be used? Set to true once it occurs. - isReady: false, - - // A counter to track how many items to wait for before - // the ready event fires. See #6781 - readyWait: 1, - - // Handle when the DOM is ready - ready: function( wait ) { - - // Abort if there are pending holds or we're already ready - if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { - return; - } - - // Remember that the DOM is ready - jQuery.isReady = true; - - // If a normal DOM Ready event fired, decrement, and wait if need be - if ( wait !== true && --jQuery.readyWait > 0 ) { - return; - } - - // If there are functions bound, to execute - readyList.resolveWith( document, [ jQuery ] ); - } -} ); - -jQuery.ready.then = readyList.then; - -// The ready event handler and self cleanup method -function completed() { - document.removeEventListener( "DOMContentLoaded", completed ); - window.removeEventListener( "load", completed ); - jQuery.ready(); -} - -// Catch cases where $(document).ready() is called -// after the browser event has already occurred. -// Support: IE <=9 - 10 only -// Older IE sometimes signals "interactive" too soon -if ( document.readyState === "complete" || - ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { - - // Handle it asynchronously to allow scripts the opportunity to delay ready - window.setTimeout( jQuery.ready ); - -} else { - - // Use the handy event callback - document.addEventListener( "DOMContentLoaded", completed ); - - // A fallback to window.onload, that will always work - window.addEventListener( "load", completed ); -} - - - - -// Multifunctional method to get and set values of a collection -// The value/s can optionally be executed if it's a function -var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { - var i = 0, - len = elems.length, - bulk = key == null; - - // Sets many values - if ( toType( key ) === "object" ) { - chainable = true; - for ( i in key ) { - access( elems, fn, i, key[ i ], true, emptyGet, raw ); - } - - // Sets one value - } else if ( value !== undefined ) { - chainable = true; - - if ( !isFunction( value ) ) { - raw = true; - } - - if ( bulk ) { - - // Bulk operations run against the entire set - if ( raw ) { - fn.call( elems, value ); - fn = null; - - // ...except when executing function values - } else { - bulk = fn; - fn = function( elem, _key, value ) { - return bulk.call( jQuery( elem ), value ); - }; - } - } - - if ( fn ) { - for ( ; i < len; i++ ) { - fn( - elems[ i ], key, raw ? - value : - value.call( elems[ i ], i, fn( elems[ i ], key ) ) - ); - } - } - } - - if ( chainable ) { - return elems; - } - - // Gets - if ( bulk ) { - return fn.call( elems ); - } - - return len ? fn( elems[ 0 ], key ) : emptyGet; -}; - - -// Matches dashed string for camelizing -var rmsPrefix = /^-ms-/, - rdashAlpha = /-([a-z])/g; - -// Used by camelCase as callback to replace() -function fcamelCase( _all, letter ) { - return letter.toUpperCase(); -} - -// Convert dashed to camelCase; used by the css and data modules -// Support: IE <=9 - 11, Edge 12 - 15 -// Microsoft forgot to hump their vendor prefix (#9572) -function camelCase( string ) { - return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); -} -var acceptData = function( owner ) { - - // Accepts only: - // - Node - // - Node.ELEMENT_NODE - // - Node.DOCUMENT_NODE - // - Object - // - Any - return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); -}; - - - - -function Data() { - this.expando = jQuery.expando + Data.uid++; -} - -Data.uid = 1; - -Data.prototype = { - - cache: function( owner ) { - - // Check if the owner object already has a cache - var value = owner[ this.expando ]; - - // If not, create one - if ( !value ) { - value = {}; - - // We can accept data for non-element nodes in modern browsers, - // but we should not, see #8335. - // Always return an empty object. - if ( acceptData( owner ) ) { - - // If it is a node unlikely to be stringify-ed or looped over - // use plain assignment - if ( owner.nodeType ) { - owner[ this.expando ] = value; - - // Otherwise secure it in a non-enumerable property - // configurable must be true to allow the property to be - // deleted when data is removed - } else { - Object.defineProperty( owner, this.expando, { - value: value, - configurable: true - } ); - } - } - } - - return value; - }, - set: function( owner, data, value ) { - var prop, - cache = this.cache( owner ); - - // Handle: [ owner, key, value ] args - // Always use camelCase key (gh-2257) - if ( typeof data === "string" ) { - cache[ camelCase( data ) ] = value; - - // Handle: [ owner, { properties } ] args - } else { - - // Copy the properties one-by-one to the cache object - for ( prop in data ) { - cache[ camelCase( prop ) ] = data[ prop ]; - } - } - return cache; - }, - get: function( owner, key ) { - return key === undefined ? - this.cache( owner ) : - - // Always use camelCase key (gh-2257) - owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; - }, - access: function( owner, key, value ) { - - // In cases where either: - // - // 1. No key was specified - // 2. A string key was specified, but no value provided - // - // Take the "read" path and allow the get method to determine - // which value to return, respectively either: - // - // 1. The entire cache object - // 2. The data stored at the key - // - if ( key === undefined || - ( ( key && typeof key === "string" ) && value === undefined ) ) { - - return this.get( owner, key ); - } - - // When the key is not a string, or both a key and value - // are specified, set or extend (existing objects) with either: - // - // 1. An object of properties - // 2. A key and value - // - this.set( owner, key, value ); - - // Since the "set" path can have two possible entry points - // return the expected data based on which path was taken[*] - return value !== undefined ? value : key; - }, - remove: function( owner, key ) { - var i, - cache = owner[ this.expando ]; - - if ( cache === undefined ) { - return; - } - - if ( key !== undefined ) { - - // Support array or space separated string of keys - if ( Array.isArray( key ) ) { - - // If key is an array of keys... - // We always set camelCase keys, so remove that. - key = key.map( camelCase ); - } else { - key = camelCase( key ); - - // If a key with the spaces exists, use it. - // Otherwise, create an array by matching non-whitespace - key = key in cache ? - [ key ] : - ( key.match( rnothtmlwhite ) || [] ); - } - - i = key.length; - - while ( i-- ) { - delete cache[ key[ i ] ]; - } - } - - // Remove the expando if there's no more data - if ( key === undefined || jQuery.isEmptyObject( cache ) ) { - - // Support: Chrome <=35 - 45 - // Webkit & Blink performance suffers when deleting properties - // from DOM nodes, so set to undefined instead - // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) - if ( owner.nodeType ) { - owner[ this.expando ] = undefined; - } else { - delete owner[ this.expando ]; - } - } - }, - hasData: function( owner ) { - var cache = owner[ this.expando ]; - return cache !== undefined && !jQuery.isEmptyObject( cache ); - } -}; -var dataPriv = new Data(); - -var dataUser = new Data(); - - - -// Implementation Summary -// -// 1. Enforce API surface and semantic compatibility with 1.9.x branch -// 2. Improve the module's maintainability by reducing the storage -// paths to a single mechanism. -// 3. Use the same single mechanism to support "private" and "user" data. -// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) -// 5. Avoid exposing implementation details on user objects (eg. expando properties) -// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 - -var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, - rmultiDash = /[A-Z]/g; - -function getData( data ) { - if ( data === "true" ) { - return true; - } - - if ( data === "false" ) { - return false; - } - - if ( data === "null" ) { - return null; - } - - // Only convert to a number if it doesn't change the string - if ( data === +data + "" ) { - return +data; - } - - if ( rbrace.test( data ) ) { - return JSON.parse( data ); - } - - return data; -} - -function dataAttr( elem, key, data ) { - var name; - - // If nothing was found internally, try to fetch any - // data from the HTML5 data-* attribute - if ( data === undefined && elem.nodeType === 1 ) { - name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); - data = elem.getAttribute( name ); - - if ( typeof data === "string" ) { - try { - data = getData( data ); - } catch ( e ) {} - - // Make sure we set the data so it isn't changed later - dataUser.set( elem, key, data ); - } else { - data = undefined; - } - } - return data; -} - -jQuery.extend( { - hasData: function( elem ) { - return dataUser.hasData( elem ) || dataPriv.hasData( elem ); - }, - - data: function( elem, name, data ) { - return dataUser.access( elem, name, data ); - }, - - removeData: function( elem, name ) { - dataUser.remove( elem, name ); - }, - - // TODO: Now that all calls to _data and _removeData have been replaced - // with direct calls to dataPriv methods, these can be deprecated. - _data: function( elem, name, data ) { - return dataPriv.access( elem, name, data ); - }, - - _removeData: function( elem, name ) { - dataPriv.remove( elem, name ); - } -} ); - -jQuery.fn.extend( { - data: function( key, value ) { - var i, name, data, - elem = this[ 0 ], - attrs = elem && elem.attributes; - - // Gets all values - if ( key === undefined ) { - if ( this.length ) { - data = dataUser.get( elem ); - - if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { - i = attrs.length; - while ( i-- ) { - - // Support: IE 11 only - // The attrs elements can be null (#14894) - if ( attrs[ i ] ) { - name = attrs[ i ].name; - if ( name.indexOf( "data-" ) === 0 ) { - name = camelCase( name.slice( 5 ) ); - dataAttr( elem, name, data[ name ] ); - } - } - } - dataPriv.set( elem, "hasDataAttrs", true ); - } - } - - return data; - } - - // Sets multiple values - if ( typeof key === "object" ) { - return this.each( function() { - dataUser.set( this, key ); - } ); - } - - return access( this, function( value ) { - var data; - - // The calling jQuery object (element matches) is not empty - // (and therefore has an element appears at this[ 0 ]) and the - // `value` parameter was not undefined. An empty jQuery object - // will result in `undefined` for elem = this[ 0 ] which will - // throw an exception if an attempt to read a data cache is made. - if ( elem && value === undefined ) { - - // Attempt to get data from the cache - // The key will always be camelCased in Data - data = dataUser.get( elem, key ); - if ( data !== undefined ) { - return data; - } - - // Attempt to "discover" the data in - // HTML5 custom data-* attrs - data = dataAttr( elem, key ); - if ( data !== undefined ) { - return data; - } - - // We tried really hard, but the data doesn't exist. - return; - } - - // Set the data... - this.each( function() { - - // We always store the camelCased key - dataUser.set( this, key, value ); - } ); - }, null, value, arguments.length > 1, null, true ); - }, - - removeData: function( key ) { - return this.each( function() { - dataUser.remove( this, key ); - } ); - } -} ); - - -jQuery.extend( { - queue: function( elem, type, data ) { - var queue; - - if ( elem ) { - type = ( type || "fx" ) + "queue"; - queue = dataPriv.get( elem, type ); - - // Speed up dequeue by getting out quickly if this is just a lookup - if ( data ) { - if ( !queue || Array.isArray( data ) ) { - queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); - } else { - queue.push( data ); - } - } - return queue || []; - } - }, - - dequeue: function( elem, type ) { - type = type || "fx"; - - var queue = jQuery.queue( elem, type ), - startLength = queue.length, - fn = queue.shift(), - hooks = jQuery._queueHooks( elem, type ), - next = function() { - jQuery.dequeue( elem, type ); - }; - - // If the fx queue is dequeued, always remove the progress sentinel - if ( fn === "inprogress" ) { - fn = queue.shift(); - startLength--; - } - - if ( fn ) { - - // Add a progress sentinel to prevent the fx queue from being - // automatically dequeued - if ( type === "fx" ) { - queue.unshift( "inprogress" ); - } - - // Clear up the last queue stop function - delete hooks.stop; - fn.call( elem, next, hooks ); - } - - if ( !startLength && hooks ) { - hooks.empty.fire(); - } - }, - - // Not public - generate a queueHooks object, or return the current one - _queueHooks: function( elem, type ) { - var key = type + "queueHooks"; - return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { - empty: jQuery.Callbacks( "once memory" ).add( function() { - dataPriv.remove( elem, [ type + "queue", key ] ); - } ) - } ); - } -} ); - -jQuery.fn.extend( { - queue: function( type, data ) { - var setter = 2; - - if ( typeof type !== "string" ) { - data = type; - type = "fx"; - setter--; - } - - if ( arguments.length < setter ) { - return jQuery.queue( this[ 0 ], type ); - } - - return data === undefined ? - this : - this.each( function() { - var queue = jQuery.queue( this, type, data ); - - // Ensure a hooks for this queue - jQuery._queueHooks( this, type ); - - if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { - jQuery.dequeue( this, type ); - } - } ); - }, - dequeue: function( type ) { - return this.each( function() { - jQuery.dequeue( this, type ); - } ); - }, - clearQueue: function( type ) { - return this.queue( type || "fx", [] ); - }, - - // Get a promise resolved when queues of a certain type - // are emptied (fx is the type by default) - promise: function( type, obj ) { - var tmp, - count = 1, - defer = jQuery.Deferred(), - elements = this, - i = this.length, - resolve = function() { - if ( !( --count ) ) { - defer.resolveWith( elements, [ elements ] ); - } - }; - - if ( typeof type !== "string" ) { - obj = type; - type = undefined; - } - type = type || "fx"; - - while ( i-- ) { - tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); - if ( tmp && tmp.empty ) { - count++; - tmp.empty.add( resolve ); - } - } - resolve(); - return defer.promise( obj ); - } -} ); -var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; - -var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); - - -var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; - -var documentElement = document.documentElement; - - - - var isAttached = function( elem ) { - return jQuery.contains( elem.ownerDocument, elem ); - }, - composed = { composed: true }; - - // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only - // Check attachment across shadow DOM boundaries when possible (gh-3504) - // Support: iOS 10.0-10.2 only - // Early iOS 10 versions support `attachShadow` but not `getRootNode`, - // leading to errors. We need to check for `getRootNode`. - if ( documentElement.getRootNode ) { - isAttached = function( elem ) { - return jQuery.contains( elem.ownerDocument, elem ) || - elem.getRootNode( composed ) === elem.ownerDocument; - }; - } -var isHiddenWithinTree = function( elem, el ) { - - // isHiddenWithinTree might be called from jQuery#filter function; - // in that case, element will be second argument - elem = el || elem; - - // Inline style trumps all - return elem.style.display === "none" || - elem.style.display === "" && - - // Otherwise, check computed style - // Support: Firefox <=43 - 45 - // Disconnected elements can have computed display: none, so first confirm that elem is - // in the document. - isAttached( elem ) && - - jQuery.css( elem, "display" ) === "none"; - }; - - - -function adjustCSS( elem, prop, valueParts, tween ) { - var adjusted, scale, - maxIterations = 20, - currentValue = tween ? - function() { - return tween.cur(); - } : - function() { - return jQuery.css( elem, prop, "" ); - }, - initial = currentValue(), - unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), - - // Starting value computation is required for potential unit mismatches - initialInUnit = elem.nodeType && - ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && - rcssNum.exec( jQuery.css( elem, prop ) ); - - if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { - - // Support: Firefox <=54 - // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) - initial = initial / 2; - - // Trust units reported by jQuery.css - unit = unit || initialInUnit[ 3 ]; - - // Iteratively approximate from a nonzero starting point - initialInUnit = +initial || 1; - - while ( maxIterations-- ) { - - // Evaluate and update our best guess (doubling guesses that zero out). - // Finish if the scale equals or crosses 1 (making the old*new product non-positive). - jQuery.style( elem, prop, initialInUnit + unit ); - if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { - maxIterations = 0; - } - initialInUnit = initialInUnit / scale; - - } - - initialInUnit = initialInUnit * 2; - jQuery.style( elem, prop, initialInUnit + unit ); - - // Make sure we update the tween properties later on - valueParts = valueParts || []; - } - - if ( valueParts ) { - initialInUnit = +initialInUnit || +initial || 0; - - // Apply relative offset (+=/-=) if specified - adjusted = valueParts[ 1 ] ? - initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : - +valueParts[ 2 ]; - if ( tween ) { - tween.unit = unit; - tween.start = initialInUnit; - tween.end = adjusted; - } - } - return adjusted; -} - - -var defaultDisplayMap = {}; - -function getDefaultDisplay( elem ) { - var temp, - doc = elem.ownerDocument, - nodeName = elem.nodeName, - display = defaultDisplayMap[ nodeName ]; - - if ( display ) { - return display; - } - - temp = doc.body.appendChild( doc.createElement( nodeName ) ); - display = jQuery.css( temp, "display" ); - - temp.parentNode.removeChild( temp ); - - if ( display === "none" ) { - display = "block"; - } - defaultDisplayMap[ nodeName ] = display; - - return display; -} - -function showHide( elements, show ) { - var display, elem, - values = [], - index = 0, - length = elements.length; - - // Determine new display value for elements that need to change - for ( ; index < length; index++ ) { - elem = elements[ index ]; - if ( !elem.style ) { - continue; - } - - display = elem.style.display; - if ( show ) { - - // Since we force visibility upon cascade-hidden elements, an immediate (and slow) - // check is required in this first loop unless we have a nonempty display value (either - // inline or about-to-be-restored) - if ( display === "none" ) { - values[ index ] = dataPriv.get( elem, "display" ) || null; - if ( !values[ index ] ) { - elem.style.display = ""; - } - } - if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { - values[ index ] = getDefaultDisplay( elem ); - } - } else { - if ( display !== "none" ) { - values[ index ] = "none"; - - // Remember what we're overwriting - dataPriv.set( elem, "display", display ); - } - } - } - - // Set the display of the elements in a second loop to avoid constant reflow - for ( index = 0; index < length; index++ ) { - if ( values[ index ] != null ) { - elements[ index ].style.display = values[ index ]; - } - } - - return elements; -} - -jQuery.fn.extend( { - show: function() { - return showHide( this, true ); - }, - hide: function() { - return showHide( this ); - }, - toggle: function( state ) { - if ( typeof state === "boolean" ) { - return state ? this.show() : this.hide(); - } - - return this.each( function() { - if ( isHiddenWithinTree( this ) ) { - jQuery( this ).show(); - } else { - jQuery( this ).hide(); - } - } ); - } -} ); -var rcheckableType = ( /^(?:checkbox|radio)$/i ); - -var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); - -var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); - - - -( function() { - var fragment = document.createDocumentFragment(), - div = fragment.appendChild( document.createElement( "div" ) ), - input = document.createElement( "input" ); - - // Support: Android 4.0 - 4.3 only - // Check state lost if the name is set (#11217) - // Support: Windows Web Apps (WWA) - // `name` and `type` must use .setAttribute for WWA (#14901) - input.setAttribute( "type", "radio" ); - input.setAttribute( "checked", "checked" ); - input.setAttribute( "name", "t" ); - - div.appendChild( input ); - - // Support: Android <=4.1 only - // Older WebKit doesn't clone checked state correctly in fragments - support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; - - // Support: IE <=11 only - // Make sure textarea (and checkbox) defaultValue is properly cloned - div.innerHTML = ""; - support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; - - // Support: IE <=9 only - // IE <=9 replaces "; - support.option = !!div.lastChild; -} )(); - - -// We have to close these tags to support XHTML (#13200) -var wrapMap = { - - // XHTML parsers do not magically insert elements in the - // same way that tag soup parsers do. So we cannot shorten - // this by omitting or other required elements. - thead: [ 1, "", "
" ], - col: [ 2, "", "
" ], - tr: [ 2, "", "
" ], - td: [ 3, "", "
" ], - - _default: [ 0, "", "" ] -}; - -wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; -wrapMap.th = wrapMap.td; - -// Support: IE <=9 only -if ( !support.option ) { - wrapMap.optgroup = wrapMap.option = [ 1, "" ]; -} - - -function getAll( context, tag ) { - - // Support: IE <=9 - 11 only - // Use typeof to avoid zero-argument method invocation on host objects (#15151) - var ret; - - if ( typeof context.getElementsByTagName !== "undefined" ) { - ret = context.getElementsByTagName( tag || "*" ); - - } else if ( typeof context.querySelectorAll !== "undefined" ) { - ret = context.querySelectorAll( tag || "*" ); - - } else { - ret = []; - } - - if ( tag === undefined || tag && nodeName( context, tag ) ) { - return jQuery.merge( [ context ], ret ); - } - - return ret; -} - - -// Mark scripts as having already been evaluated -function setGlobalEval( elems, refElements ) { - var i = 0, - l = elems.length; - - for ( ; i < l; i++ ) { - dataPriv.set( - elems[ i ], - "globalEval", - !refElements || dataPriv.get( refElements[ i ], "globalEval" ) - ); - } -} - - -var rhtml = /<|&#?\w+;/; - -function buildFragment( elems, context, scripts, selection, ignored ) { - var elem, tmp, tag, wrap, attached, j, - fragment = context.createDocumentFragment(), - nodes = [], - i = 0, - l = elems.length; - - for ( ; i < l; i++ ) { - elem = elems[ i ]; - - if ( elem || elem === 0 ) { - - // Add nodes directly - if ( toType( elem ) === "object" ) { - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); - - // Convert non-html into a text node - } else if ( !rhtml.test( elem ) ) { - nodes.push( context.createTextNode( elem ) ); - - // Convert html into DOM nodes - } else { - tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); - - // Deserialize a standard representation - tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); - wrap = wrapMap[ tag ] || wrapMap._default; - tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; - - // Descend through wrappers to the right content - j = wrap[ 0 ]; - while ( j-- ) { - tmp = tmp.lastChild; - } - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - jQuery.merge( nodes, tmp.childNodes ); - - // Remember the top-level container - tmp = fragment.firstChild; - - // Ensure the created nodes are orphaned (#12392) - tmp.textContent = ""; - } - } - } - - // Remove wrapper from fragment - fragment.textContent = ""; - - i = 0; - while ( ( elem = nodes[ i++ ] ) ) { - - // Skip elements already in the context collection (trac-4087) - if ( selection && jQuery.inArray( elem, selection ) > -1 ) { - if ( ignored ) { - ignored.push( elem ); - } - continue; - } - - attached = isAttached( elem ); - - // Append to fragment - tmp = getAll( fragment.appendChild( elem ), "script" ); - - // Preserve script evaluation history - if ( attached ) { - setGlobalEval( tmp ); - } - - // Capture executables - if ( scripts ) { - j = 0; - while ( ( elem = tmp[ j++ ] ) ) { - if ( rscriptType.test( elem.type || "" ) ) { - scripts.push( elem ); - } - } - } - } - - return fragment; -} - - -var - rkeyEvent = /^key/, - rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, - rtypenamespace = /^([^.]*)(?:\.(.+)|)/; - -function returnTrue() { - return true; -} - -function returnFalse() { - return false; -} - -// Support: IE <=9 - 11+ -// focus() and blur() are asynchronous, except when they are no-op. -// So expect focus to be synchronous when the element is already active, -// and blur to be synchronous when the element is not already active. -// (focus and blur are always synchronous in other supported browsers, -// this just defines when we can count on it). -function expectSync( elem, type ) { - return ( elem === safeActiveElement() ) === ( type === "focus" ); -} - -// Support: IE <=9 only -// Accessing document.activeElement can throw unexpectedly -// https://bugs.jquery.com/ticket/13393 -function safeActiveElement() { - try { - return document.activeElement; - } catch ( err ) { } -} - -function on( elem, types, selector, data, fn, one ) { - var origFn, type; - - // Types can be a map of types/handlers - if ( typeof types === "object" ) { - - // ( types-Object, selector, data ) - if ( typeof selector !== "string" ) { - - // ( types-Object, data ) - data = data || selector; - selector = undefined; - } - for ( type in types ) { - on( elem, type, selector, data, types[ type ], one ); - } - return elem; - } - - if ( data == null && fn == null ) { - - // ( types, fn ) - fn = selector; - data = selector = undefined; - } else if ( fn == null ) { - if ( typeof selector === "string" ) { - - // ( types, selector, fn ) - fn = data; - data = undefined; - } else { - - // ( types, data, fn ) - fn = data; - data = selector; - selector = undefined; - } - } - if ( fn === false ) { - fn = returnFalse; - } else if ( !fn ) { - return elem; - } - - if ( one === 1 ) { - origFn = fn; - fn = function( event ) { - - // Can use an empty set, since event contains the info - jQuery().off( event ); - return origFn.apply( this, arguments ); - }; - - // Use same guid so caller can remove using origFn - fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); - } - return elem.each( function() { - jQuery.event.add( this, types, fn, data, selector ); - } ); -} - -/* - * Helper functions for managing events -- not part of the public interface. - * Props to Dean Edwards' addEvent library for many of the ideas. - */ -jQuery.event = { - - global: {}, - - add: function( elem, types, handler, data, selector ) { - - var handleObjIn, eventHandle, tmp, - events, t, handleObj, - special, handlers, type, namespaces, origType, - elemData = dataPriv.get( elem ); - - // Only attach events to objects that accept data - if ( !acceptData( elem ) ) { - return; - } - - // Caller can pass in an object of custom data in lieu of the handler - if ( handler.handler ) { - handleObjIn = handler; - handler = handleObjIn.handler; - selector = handleObjIn.selector; - } - - // Ensure that invalid selectors throw exceptions at attach time - // Evaluate against documentElement in case elem is a non-element node (e.g., document) - if ( selector ) { - jQuery.find.matchesSelector( documentElement, selector ); - } - - // Make sure that the handler has a unique ID, used to find/remove it later - if ( !handler.guid ) { - handler.guid = jQuery.guid++; - } - - // Init the element's event structure and main handler, if this is the first - if ( !( events = elemData.events ) ) { - events = elemData.events = Object.create( null ); - } - if ( !( eventHandle = elemData.handle ) ) { - eventHandle = elemData.handle = function( e ) { - - // Discard the second event of a jQuery.event.trigger() and - // when an event is called after a page has unloaded - return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? - jQuery.event.dispatch.apply( elem, arguments ) : undefined; - }; - } - - // Handle multiple events separated by a space - types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; - t = types.length; - while ( t-- ) { - tmp = rtypenamespace.exec( types[ t ] ) || []; - type = origType = tmp[ 1 ]; - namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); - - // There *must* be a type, no attaching namespace-only handlers - if ( !type ) { - continue; - } - - // If event changes its type, use the special event handlers for the changed type - special = jQuery.event.special[ type ] || {}; - - // If selector defined, determine special event api type, otherwise given type - type = ( selector ? special.delegateType : special.bindType ) || type; - - // Update special based on newly reset type - special = jQuery.event.special[ type ] || {}; - - // handleObj is passed to all event handlers - handleObj = jQuery.extend( { - type: type, - origType: origType, - data: data, - handler: handler, - guid: handler.guid, - selector: selector, - needsContext: selector && jQuery.expr.match.needsContext.test( selector ), - namespace: namespaces.join( "." ) - }, handleObjIn ); - - // Init the event handler queue if we're the first - if ( !( handlers = events[ type ] ) ) { - handlers = events[ type ] = []; - handlers.delegateCount = 0; - - // Only use addEventListener if the special events handler returns false - if ( !special.setup || - special.setup.call( elem, data, namespaces, eventHandle ) === false ) { - - if ( elem.addEventListener ) { - elem.addEventListener( type, eventHandle ); - } - } - } - - if ( special.add ) { - special.add.call( elem, handleObj ); - - if ( !handleObj.handler.guid ) { - handleObj.handler.guid = handler.guid; - } - } - - // Add to the element's handler list, delegates in front - if ( selector ) { - handlers.splice( handlers.delegateCount++, 0, handleObj ); - } else { - handlers.push( handleObj ); - } - - // Keep track of which events have ever been used, for event optimization - jQuery.event.global[ type ] = true; - } - - }, - - // Detach an event or set of events from an element - remove: function( elem, types, handler, selector, mappedTypes ) { - - var j, origCount, tmp, - events, t, handleObj, - special, handlers, type, namespaces, origType, - elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); - - if ( !elemData || !( events = elemData.events ) ) { - return; - } - - // Once for each type.namespace in types; type may be omitted - types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; - t = types.length; - while ( t-- ) { - tmp = rtypenamespace.exec( types[ t ] ) || []; - type = origType = tmp[ 1 ]; - namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); - - // Unbind all events (on this namespace, if provided) for the element - if ( !type ) { - for ( type in events ) { - jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); - } - continue; - } - - special = jQuery.event.special[ type ] || {}; - type = ( selector ? special.delegateType : special.bindType ) || type; - handlers = events[ type ] || []; - tmp = tmp[ 2 ] && - new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); - - // Remove matching events - origCount = j = handlers.length; - while ( j-- ) { - handleObj = handlers[ j ]; - - if ( ( mappedTypes || origType === handleObj.origType ) && - ( !handler || handler.guid === handleObj.guid ) && - ( !tmp || tmp.test( handleObj.namespace ) ) && - ( !selector || selector === handleObj.selector || - selector === "**" && handleObj.selector ) ) { - handlers.splice( j, 1 ); - - if ( handleObj.selector ) { - handlers.delegateCount--; - } - if ( special.remove ) { - special.remove.call( elem, handleObj ); - } - } - } - - // Remove generic event handler if we removed something and no more handlers exist - // (avoids potential for endless recursion during removal of special event handlers) - if ( origCount && !handlers.length ) { - if ( !special.teardown || - special.teardown.call( elem, namespaces, elemData.handle ) === false ) { - - jQuery.removeEvent( elem, type, elemData.handle ); - } - - delete events[ type ]; - } - } - - // Remove data and the expando if it's no longer used - if ( jQuery.isEmptyObject( events ) ) { - dataPriv.remove( elem, "handle events" ); - } - }, - - dispatch: function( nativeEvent ) { - - var i, j, ret, matched, handleObj, handlerQueue, - args = new Array( arguments.length ), - - // Make a writable jQuery.Event from the native event object - event = jQuery.event.fix( nativeEvent ), - - handlers = ( - dataPriv.get( this, "events" ) || Object.create( null ) - )[ event.type ] || [], - special = jQuery.event.special[ event.type ] || {}; - - // Use the fix-ed jQuery.Event rather than the (read-only) native event - args[ 0 ] = event; - - for ( i = 1; i < arguments.length; i++ ) { - args[ i ] = arguments[ i ]; - } - - event.delegateTarget = this; - - // Call the preDispatch hook for the mapped type, and let it bail if desired - if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { - return; - } - - // Determine handlers - handlerQueue = jQuery.event.handlers.call( this, event, handlers ); - - // Run delegates first; they may want to stop propagation beneath us - i = 0; - while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { - event.currentTarget = matched.elem; - - j = 0; - while ( ( handleObj = matched.handlers[ j++ ] ) && - !event.isImmediatePropagationStopped() ) { - - // If the event is namespaced, then each handler is only invoked if it is - // specially universal or its namespaces are a superset of the event's. - if ( !event.rnamespace || handleObj.namespace === false || - event.rnamespace.test( handleObj.namespace ) ) { - - event.handleObj = handleObj; - event.data = handleObj.data; - - ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || - handleObj.handler ).apply( matched.elem, args ); - - if ( ret !== undefined ) { - if ( ( event.result = ret ) === false ) { - event.preventDefault(); - event.stopPropagation(); - } - } - } - } - } - - // Call the postDispatch hook for the mapped type - if ( special.postDispatch ) { - special.postDispatch.call( this, event ); - } - - return event.result; - }, - - handlers: function( event, handlers ) { - var i, handleObj, sel, matchedHandlers, matchedSelectors, - handlerQueue = [], - delegateCount = handlers.delegateCount, - cur = event.target; - - // Find delegate handlers - if ( delegateCount && - - // Support: IE <=9 - // Black-hole SVG instance trees (trac-13180) - cur.nodeType && - - // Support: Firefox <=42 - // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) - // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click - // Support: IE 11 only - // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) - !( event.type === "click" && event.button >= 1 ) ) { - - for ( ; cur !== this; cur = cur.parentNode || this ) { - - // Don't check non-elements (#13208) - // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) - if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { - matchedHandlers = []; - matchedSelectors = {}; - for ( i = 0; i < delegateCount; i++ ) { - handleObj = handlers[ i ]; - - // Don't conflict with Object.prototype properties (#13203) - sel = handleObj.selector + " "; - - if ( matchedSelectors[ sel ] === undefined ) { - matchedSelectors[ sel ] = handleObj.needsContext ? - jQuery( sel, this ).index( cur ) > -1 : - jQuery.find( sel, this, null, [ cur ] ).length; - } - if ( matchedSelectors[ sel ] ) { - matchedHandlers.push( handleObj ); - } - } - if ( matchedHandlers.length ) { - handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); - } - } - } - } - - // Add the remaining (directly-bound) handlers - cur = this; - if ( delegateCount < handlers.length ) { - handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); - } - - return handlerQueue; - }, - - addProp: function( name, hook ) { - Object.defineProperty( jQuery.Event.prototype, name, { - enumerable: true, - configurable: true, - - get: isFunction( hook ) ? - function() { - if ( this.originalEvent ) { - return hook( this.originalEvent ); - } - } : - function() { - if ( this.originalEvent ) { - return this.originalEvent[ name ]; - } - }, - - set: function( value ) { - Object.defineProperty( this, name, { - enumerable: true, - configurable: true, - writable: true, - value: value - } ); - } - } ); - }, - - fix: function( originalEvent ) { - return originalEvent[ jQuery.expando ] ? - originalEvent : - new jQuery.Event( originalEvent ); - }, - - special: { - load: { - - // Prevent triggered image.load events from bubbling to window.load - noBubble: true - }, - click: { - - // Utilize native event to ensure correct state for checkable inputs - setup: function( data ) { - - // For mutual compressibility with _default, replace `this` access with a local var. - // `|| data` is dead code meant only to preserve the variable through minification. - var el = this || data; - - // Claim the first handler - if ( rcheckableType.test( el.type ) && - el.click && nodeName( el, "input" ) ) { - - // dataPriv.set( el, "click", ... ) - leverageNative( el, "click", returnTrue ); - } - - // Return false to allow normal processing in the caller - return false; - }, - trigger: function( data ) { - - // For mutual compressibility with _default, replace `this` access with a local var. - // `|| data` is dead code meant only to preserve the variable through minification. - var el = this || data; - - // Force setup before triggering a click - if ( rcheckableType.test( el.type ) && - el.click && nodeName( el, "input" ) ) { - - leverageNative( el, "click" ); - } - - // Return non-false to allow normal event-path propagation - return true; - }, - - // For cross-browser consistency, suppress native .click() on links - // Also prevent it if we're currently inside a leveraged native-event stack - _default: function( event ) { - var target = event.target; - return rcheckableType.test( target.type ) && - target.click && nodeName( target, "input" ) && - dataPriv.get( target, "click" ) || - nodeName( target, "a" ); - } - }, - - beforeunload: { - postDispatch: function( event ) { - - // Support: Firefox 20+ - // Firefox doesn't alert if the returnValue field is not set. - if ( event.result !== undefined && event.originalEvent ) { - event.originalEvent.returnValue = event.result; - } - } - } - } -}; - -// Ensure the presence of an event listener that handles manually-triggered -// synthetic events by interrupting progress until reinvoked in response to -// *native* events that it fires directly, ensuring that state changes have -// already occurred before other listeners are invoked. -function leverageNative( el, type, expectSync ) { - - // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add - if ( !expectSync ) { - if ( dataPriv.get( el, type ) === undefined ) { - jQuery.event.add( el, type, returnTrue ); - } - return; - } - - // Register the controller as a special universal handler for all event namespaces - dataPriv.set( el, type, false ); - jQuery.event.add( el, type, { - namespace: false, - handler: function( event ) { - var notAsync, result, - saved = dataPriv.get( this, type ); - - if ( ( event.isTrigger & 1 ) && this[ type ] ) { - - // Interrupt processing of the outer synthetic .trigger()ed event - // Saved data should be false in such cases, but might be a leftover capture object - // from an async native handler (gh-4350) - if ( !saved.length ) { - - // Store arguments for use when handling the inner native event - // There will always be at least one argument (an event object), so this array - // will not be confused with a leftover capture object. - saved = slice.call( arguments ); - dataPriv.set( this, type, saved ); - - // Trigger the native event and capture its result - // Support: IE <=9 - 11+ - // focus() and blur() are asynchronous - notAsync = expectSync( this, type ); - this[ type ](); - result = dataPriv.get( this, type ); - if ( saved !== result || notAsync ) { - dataPriv.set( this, type, false ); - } else { - result = {}; - } - if ( saved !== result ) { - - // Cancel the outer synthetic event - event.stopImmediatePropagation(); - event.preventDefault(); - return result.value; - } - - // If this is an inner synthetic event for an event with a bubbling surrogate - // (focus or blur), assume that the surrogate already propagated from triggering the - // native event and prevent that from happening again here. - // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the - // bubbling surrogate propagates *after* the non-bubbling base), but that seems - // less bad than duplication. - } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { - event.stopPropagation(); - } - - // If this is a native event triggered above, everything is now in order - // Fire an inner synthetic event with the original arguments - } else if ( saved.length ) { - - // ...and capture the result - dataPriv.set( this, type, { - value: jQuery.event.trigger( - - // Support: IE <=9 - 11+ - // Extend with the prototype to reset the above stopImmediatePropagation() - jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), - saved.slice( 1 ), - this - ) - } ); - - // Abort handling of the native event - event.stopImmediatePropagation(); - } - } - } ); -} - -jQuery.removeEvent = function( elem, type, handle ) { - - // This "if" is needed for plain objects - if ( elem.removeEventListener ) { - elem.removeEventListener( type, handle ); - } -}; - -jQuery.Event = function( src, props ) { - - // Allow instantiation without the 'new' keyword - if ( !( this instanceof jQuery.Event ) ) { - return new jQuery.Event( src, props ); - } - - // Event object - if ( src && src.type ) { - this.originalEvent = src; - this.type = src.type; - - // Events bubbling up the document may have been marked as prevented - // by a handler lower down the tree; reflect the correct value. - this.isDefaultPrevented = src.defaultPrevented || - src.defaultPrevented === undefined && - - // Support: Android <=2.3 only - src.returnValue === false ? - returnTrue : - returnFalse; - - // Create target properties - // Support: Safari <=6 - 7 only - // Target should not be a text node (#504, #13143) - this.target = ( src.target && src.target.nodeType === 3 ) ? - src.target.parentNode : - src.target; - - this.currentTarget = src.currentTarget; - this.relatedTarget = src.relatedTarget; - - // Event type - } else { - this.type = src; - } - - // Put explicitly provided properties onto the event object - if ( props ) { - jQuery.extend( this, props ); - } - - // Create a timestamp if incoming event doesn't have one - this.timeStamp = src && src.timeStamp || Date.now(); - - // Mark it as fixed - this[ jQuery.expando ] = true; -}; - -// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding -// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html -jQuery.Event.prototype = { - constructor: jQuery.Event, - isDefaultPrevented: returnFalse, - isPropagationStopped: returnFalse, - isImmediatePropagationStopped: returnFalse, - isSimulated: false, - - preventDefault: function() { - var e = this.originalEvent; - - this.isDefaultPrevented = returnTrue; - - if ( e && !this.isSimulated ) { - e.preventDefault(); - } - }, - stopPropagation: function() { - var e = this.originalEvent; - - this.isPropagationStopped = returnTrue; - - if ( e && !this.isSimulated ) { - e.stopPropagation(); - } - }, - stopImmediatePropagation: function() { - var e = this.originalEvent; - - this.isImmediatePropagationStopped = returnTrue; - - if ( e && !this.isSimulated ) { - e.stopImmediatePropagation(); - } - - this.stopPropagation(); - } -}; - -// Includes all common event props including KeyEvent and MouseEvent specific props -jQuery.each( { - altKey: true, - bubbles: true, - cancelable: true, - changedTouches: true, - ctrlKey: true, - detail: true, - eventPhase: true, - metaKey: true, - pageX: true, - pageY: true, - shiftKey: true, - view: true, - "char": true, - code: true, - charCode: true, - key: true, - keyCode: true, - button: true, - buttons: true, - clientX: true, - clientY: true, - offsetX: true, - offsetY: true, - pointerId: true, - pointerType: true, - screenX: true, - screenY: true, - targetTouches: true, - toElement: true, - touches: true, - - which: function( event ) { - var button = event.button; - - // Add which for key events - if ( event.which == null && rkeyEvent.test( event.type ) ) { - return event.charCode != null ? event.charCode : event.keyCode; - } - - // Add which for click: 1 === left; 2 === middle; 3 === right - if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { - if ( button & 1 ) { - return 1; - } - - if ( button & 2 ) { - return 3; - } - - if ( button & 4 ) { - return 2; - } - - return 0; - } - - return event.which; - } -}, jQuery.event.addProp ); - -jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { - jQuery.event.special[ type ] = { - - // Utilize native event if possible so blur/focus sequence is correct - setup: function() { - - // Claim the first handler - // dataPriv.set( this, "focus", ... ) - // dataPriv.set( this, "blur", ... ) - leverageNative( this, type, expectSync ); - - // Return false to allow normal processing in the caller - return false; - }, - trigger: function() { - - // Force setup before trigger - leverageNative( this, type ); - - // Return non-false to allow normal event-path propagation - return true; - }, - - delegateType: delegateType - }; -} ); - -// Create mouseenter/leave events using mouseover/out and event-time checks -// so that event delegation works in jQuery. -// Do the same for pointerenter/pointerleave and pointerover/pointerout -// -// Support: Safari 7 only -// Safari sends mouseenter too often; see: -// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 -// for the description of the bug (it existed in older Chrome versions as well). -jQuery.each( { - mouseenter: "mouseover", - mouseleave: "mouseout", - pointerenter: "pointerover", - pointerleave: "pointerout" -}, function( orig, fix ) { - jQuery.event.special[ orig ] = { - delegateType: fix, - bindType: fix, - - handle: function( event ) { - var ret, - target = this, - related = event.relatedTarget, - handleObj = event.handleObj; - - // For mouseenter/leave call the handler if related is outside the target. - // NB: No relatedTarget if the mouse left/entered the browser window - if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { - event.type = handleObj.origType; - ret = handleObj.handler.apply( this, arguments ); - event.type = fix; - } - return ret; - } - }; -} ); - -jQuery.fn.extend( { - - on: function( types, selector, data, fn ) { - return on( this, types, selector, data, fn ); - }, - one: function( types, selector, data, fn ) { - return on( this, types, selector, data, fn, 1 ); - }, - off: function( types, selector, fn ) { - var handleObj, type; - if ( types && types.preventDefault && types.handleObj ) { - - // ( event ) dispatched jQuery.Event - handleObj = types.handleObj; - jQuery( types.delegateTarget ).off( - handleObj.namespace ? - handleObj.origType + "." + handleObj.namespace : - handleObj.origType, - handleObj.selector, - handleObj.handler - ); - return this; - } - if ( typeof types === "object" ) { - - // ( types-object [, selector] ) - for ( type in types ) { - this.off( type, selector, types[ type ] ); - } - return this; - } - if ( selector === false || typeof selector === "function" ) { - - // ( types [, fn] ) - fn = selector; - selector = undefined; - } - if ( fn === false ) { - fn = returnFalse; - } - return this.each( function() { - jQuery.event.remove( this, types, fn, selector ); - } ); - } -} ); - - -var - - // Support: IE <=10 - 11, Edge 12 - 13 only - // In IE/Edge using regex groups here causes severe slowdowns. - // See https://connect.microsoft.com/IE/feedback/details/1736512/ - rnoInnerhtml = /\s*$/g; - -// Prefer a tbody over its parent table for containing new rows -function manipulationTarget( elem, content ) { - if ( nodeName( elem, "table" ) && - nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { - - return jQuery( elem ).children( "tbody" )[ 0 ] || elem; - } - - return elem; -} - -// Replace/restore the type attribute of script elements for safe DOM manipulation -function disableScript( elem ) { - elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; - return elem; -} -function restoreScript( elem ) { - if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { - elem.type = elem.type.slice( 5 ); - } else { - elem.removeAttribute( "type" ); - } - - return elem; -} - -function cloneCopyEvent( src, dest ) { - var i, l, type, pdataOld, udataOld, udataCur, events; - - if ( dest.nodeType !== 1 ) { - return; - } - - // 1. Copy private data: events, handlers, etc. - if ( dataPriv.hasData( src ) ) { - pdataOld = dataPriv.get( src ); - events = pdataOld.events; - - if ( events ) { - dataPriv.remove( dest, "handle events" ); - - for ( type in events ) { - for ( i = 0, l = events[ type ].length; i < l; i++ ) { - jQuery.event.add( dest, type, events[ type ][ i ] ); - } - } - } - } - - // 2. Copy user data - if ( dataUser.hasData( src ) ) { - udataOld = dataUser.access( src ); - udataCur = jQuery.extend( {}, udataOld ); - - dataUser.set( dest, udataCur ); - } -} - -// Fix IE bugs, see support tests -function fixInput( src, dest ) { - var nodeName = dest.nodeName.toLowerCase(); - - // Fails to persist the checked state of a cloned checkbox or radio button. - if ( nodeName === "input" && rcheckableType.test( src.type ) ) { - dest.checked = src.checked; - - // Fails to return the selected option to the default selected state when cloning options - } else if ( nodeName === "input" || nodeName === "textarea" ) { - dest.defaultValue = src.defaultValue; - } -} - -function domManip( collection, args, callback, ignored ) { - - // Flatten any nested arrays - args = flat( args ); - - var fragment, first, scripts, hasScripts, node, doc, - i = 0, - l = collection.length, - iNoClone = l - 1, - value = args[ 0 ], - valueIsFunction = isFunction( value ); - - // We can't cloneNode fragments that contain checked, in WebKit - if ( valueIsFunction || - ( l > 1 && typeof value === "string" && - !support.checkClone && rchecked.test( value ) ) ) { - return collection.each( function( index ) { - var self = collection.eq( index ); - if ( valueIsFunction ) { - args[ 0 ] = value.call( this, index, self.html() ); - } - domManip( self, args, callback, ignored ); - } ); - } - - if ( l ) { - fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); - first = fragment.firstChild; - - if ( fragment.childNodes.length === 1 ) { - fragment = first; - } - - // Require either new content or an interest in ignored elements to invoke the callback - if ( first || ignored ) { - scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); - hasScripts = scripts.length; - - // Use the original fragment for the last item - // instead of the first because it can end up - // being emptied incorrectly in certain situations (#8070). - for ( ; i < l; i++ ) { - node = fragment; - - if ( i !== iNoClone ) { - node = jQuery.clone( node, true, true ); - - // Keep references to cloned scripts for later restoration - if ( hasScripts ) { - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - jQuery.merge( scripts, getAll( node, "script" ) ); - } - } - - callback.call( collection[ i ], node, i ); - } - - if ( hasScripts ) { - doc = scripts[ scripts.length - 1 ].ownerDocument; - - // Reenable scripts - jQuery.map( scripts, restoreScript ); - - // Evaluate executable scripts on first document insertion - for ( i = 0; i < hasScripts; i++ ) { - node = scripts[ i ]; - if ( rscriptType.test( node.type || "" ) && - !dataPriv.access( node, "globalEval" ) && - jQuery.contains( doc, node ) ) { - - if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { - - // Optional AJAX dependency, but won't run scripts if not present - if ( jQuery._evalUrl && !node.noModule ) { - jQuery._evalUrl( node.src, { - nonce: node.nonce || node.getAttribute( "nonce" ) - }, doc ); - } - } else { - DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); - } - } - } - } - } - } - - return collection; -} - -function remove( elem, selector, keepData ) { - var node, - nodes = selector ? jQuery.filter( selector, elem ) : elem, - i = 0; - - for ( ; ( node = nodes[ i ] ) != null; i++ ) { - if ( !keepData && node.nodeType === 1 ) { - jQuery.cleanData( getAll( node ) ); - } - - if ( node.parentNode ) { - if ( keepData && isAttached( node ) ) { - setGlobalEval( getAll( node, "script" ) ); - } - node.parentNode.removeChild( node ); - } - } - - return elem; -} - -jQuery.extend( { - htmlPrefilter: function( html ) { - return html; - }, - - clone: function( elem, dataAndEvents, deepDataAndEvents ) { - var i, l, srcElements, destElements, - clone = elem.cloneNode( true ), - inPage = isAttached( elem ); - - // Fix IE cloning issues - if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && - !jQuery.isXMLDoc( elem ) ) { - - // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 - destElements = getAll( clone ); - srcElements = getAll( elem ); - - for ( i = 0, l = srcElements.length; i < l; i++ ) { - fixInput( srcElements[ i ], destElements[ i ] ); - } - } - - // Copy the events from the original to the clone - if ( dataAndEvents ) { - if ( deepDataAndEvents ) { - srcElements = srcElements || getAll( elem ); - destElements = destElements || getAll( clone ); - - for ( i = 0, l = srcElements.length; i < l; i++ ) { - cloneCopyEvent( srcElements[ i ], destElements[ i ] ); - } - } else { - cloneCopyEvent( elem, clone ); - } - } - - // Preserve script evaluation history - destElements = getAll( clone, "script" ); - if ( destElements.length > 0 ) { - setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); - } - - // Return the cloned set - return clone; - }, - - cleanData: function( elems ) { - var data, elem, type, - special = jQuery.event.special, - i = 0; - - for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { - if ( acceptData( elem ) ) { - if ( ( data = elem[ dataPriv.expando ] ) ) { - if ( data.events ) { - for ( type in data.events ) { - if ( special[ type ] ) { - jQuery.event.remove( elem, type ); - - // This is a shortcut to avoid jQuery.event.remove's overhead - } else { - jQuery.removeEvent( elem, type, data.handle ); - } - } - } - - // Support: Chrome <=35 - 45+ - // Assign undefined instead of using delete, see Data#remove - elem[ dataPriv.expando ] = undefined; - } - if ( elem[ dataUser.expando ] ) { - - // Support: Chrome <=35 - 45+ - // Assign undefined instead of using delete, see Data#remove - elem[ dataUser.expando ] = undefined; - } - } - } - } -} ); - -jQuery.fn.extend( { - detach: function( selector ) { - return remove( this, selector, true ); - }, - - remove: function( selector ) { - return remove( this, selector ); - }, - - text: function( value ) { - return access( this, function( value ) { - return value === undefined ? - jQuery.text( this ) : - this.empty().each( function() { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - this.textContent = value; - } - } ); - }, null, value, arguments.length ); - }, - - append: function() { - return domManip( this, arguments, function( elem ) { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - var target = manipulationTarget( this, elem ); - target.appendChild( elem ); - } - } ); - }, - - prepend: function() { - return domManip( this, arguments, function( elem ) { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - var target = manipulationTarget( this, elem ); - target.insertBefore( elem, target.firstChild ); - } - } ); - }, - - before: function() { - return domManip( this, arguments, function( elem ) { - if ( this.parentNode ) { - this.parentNode.insertBefore( elem, this ); - } - } ); - }, - - after: function() { - return domManip( this, arguments, function( elem ) { - if ( this.parentNode ) { - this.parentNode.insertBefore( elem, this.nextSibling ); - } - } ); - }, - - empty: function() { - var elem, - i = 0; - - for ( ; ( elem = this[ i ] ) != null; i++ ) { - if ( elem.nodeType === 1 ) { - - // Prevent memory leaks - jQuery.cleanData( getAll( elem, false ) ); - - // Remove any remaining nodes - elem.textContent = ""; - } - } - - return this; - }, - - clone: function( dataAndEvents, deepDataAndEvents ) { - dataAndEvents = dataAndEvents == null ? false : dataAndEvents; - deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; - - return this.map( function() { - return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); - } ); - }, - - html: function( value ) { - return access( this, function( value ) { - var elem = this[ 0 ] || {}, - i = 0, - l = this.length; - - if ( value === undefined && elem.nodeType === 1 ) { - return elem.innerHTML; - } - - // See if we can take a shortcut and just use innerHTML - if ( typeof value === "string" && !rnoInnerhtml.test( value ) && - !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { - - value = jQuery.htmlPrefilter( value ); - - try { - for ( ; i < l; i++ ) { - elem = this[ i ] || {}; - - // Remove element nodes and prevent memory leaks - if ( elem.nodeType === 1 ) { - jQuery.cleanData( getAll( elem, false ) ); - elem.innerHTML = value; - } - } - - elem = 0; - - // If using innerHTML throws an exception, use the fallback method - } catch ( e ) {} - } - - if ( elem ) { - this.empty().append( value ); - } - }, null, value, arguments.length ); - }, - - replaceWith: function() { - var ignored = []; - - // Make the changes, replacing each non-ignored context element with the new content - return domManip( this, arguments, function( elem ) { - var parent = this.parentNode; - - if ( jQuery.inArray( this, ignored ) < 0 ) { - jQuery.cleanData( getAll( this ) ); - if ( parent ) { - parent.replaceChild( elem, this ); - } - } - - // Force callback invocation - }, ignored ); - } -} ); - -jQuery.each( { - appendTo: "append", - prependTo: "prepend", - insertBefore: "before", - insertAfter: "after", - replaceAll: "replaceWith" -}, function( name, original ) { - jQuery.fn[ name ] = function( selector ) { - var elems, - ret = [], - insert = jQuery( selector ), - last = insert.length - 1, - i = 0; - - for ( ; i <= last; i++ ) { - elems = i === last ? this : this.clone( true ); - jQuery( insert[ i ] )[ original ]( elems ); - - // Support: Android <=4.0 only, PhantomJS 1 only - // .get() because push.apply(_, arraylike) throws on ancient WebKit - push.apply( ret, elems.get() ); - } - - return this.pushStack( ret ); - }; -} ); -var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); - -var getStyles = function( elem ) { - - // Support: IE <=11 only, Firefox <=30 (#15098, #14150) - // IE throws on elements created in popups - // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" - var view = elem.ownerDocument.defaultView; - - if ( !view || !view.opener ) { - view = window; - } - - return view.getComputedStyle( elem ); - }; - -var swap = function( elem, options, callback ) { - var ret, name, - old = {}; - - // Remember the old values, and insert the new ones - for ( name in options ) { - old[ name ] = elem.style[ name ]; - elem.style[ name ] = options[ name ]; - } - - ret = callback.call( elem ); - - // Revert the old values - for ( name in options ) { - elem.style[ name ] = old[ name ]; - } - - return ret; -}; - - -var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); - - - -( function() { - - // Executing both pixelPosition & boxSizingReliable tests require only one layout - // so they're executed at the same time to save the second computation. - function computeStyleTests() { - - // This is a singleton, we need to execute it only once - if ( !div ) { - return; - } - - container.style.cssText = "position:absolute;left:-11111px;width:60px;" + - "margin-top:1px;padding:0;border:0"; - div.style.cssText = - "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + - "margin:auto;border:1px;padding:1px;" + - "width:60%;top:1%"; - documentElement.appendChild( container ).appendChild( div ); - - var divStyle = window.getComputedStyle( div ); - pixelPositionVal = divStyle.top !== "1%"; - - // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 - reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; - - // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 - // Some styles come back with percentage values, even though they shouldn't - div.style.right = "60%"; - pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; - - // Support: IE 9 - 11 only - // Detect misreporting of content dimensions for box-sizing:border-box elements - boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; - - // Support: IE 9 only - // Detect overflow:scroll screwiness (gh-3699) - // Support: Chrome <=64 - // Don't get tricked when zoom affects offsetWidth (gh-4029) - div.style.position = "absolute"; - scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; - - documentElement.removeChild( container ); - - // Nullify the div so it wouldn't be stored in the memory and - // it will also be a sign that checks already performed - div = null; - } - - function roundPixelMeasures( measure ) { - return Math.round( parseFloat( measure ) ); - } - - var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, - reliableTrDimensionsVal, reliableMarginLeftVal, - container = document.createElement( "div" ), - div = document.createElement( "div" ); - - // Finish early in limited (non-browser) environments - if ( !div.style ) { - return; - } - - // Support: IE <=9 - 11 only - // Style of cloned element affects source element cloned (#8908) - div.style.backgroundClip = "content-box"; - div.cloneNode( true ).style.backgroundClip = ""; - support.clearCloneStyle = div.style.backgroundClip === "content-box"; - - jQuery.extend( support, { - boxSizingReliable: function() { - computeStyleTests(); - return boxSizingReliableVal; - }, - pixelBoxStyles: function() { - computeStyleTests(); - return pixelBoxStylesVal; - }, - pixelPosition: function() { - computeStyleTests(); - return pixelPositionVal; - }, - reliableMarginLeft: function() { - computeStyleTests(); - return reliableMarginLeftVal; - }, - scrollboxSize: function() { - computeStyleTests(); - return scrollboxSizeVal; - }, - - // Support: IE 9 - 11+, Edge 15 - 18+ - // IE/Edge misreport `getComputedStyle` of table rows with width/height - // set in CSS while `offset*` properties report correct values. - // Behavior in IE 9 is more subtle than in newer versions & it passes - // some versions of this test; make sure not to make it pass there! - reliableTrDimensions: function() { - var table, tr, trChild, trStyle; - if ( reliableTrDimensionsVal == null ) { - table = document.createElement( "table" ); - tr = document.createElement( "tr" ); - trChild = document.createElement( "div" ); - - table.style.cssText = "position:absolute;left:-11111px"; - tr.style.height = "1px"; - trChild.style.height = "9px"; - - documentElement - .appendChild( table ) - .appendChild( tr ) - .appendChild( trChild ); - - trStyle = window.getComputedStyle( tr ); - reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; - - documentElement.removeChild( table ); - } - return reliableTrDimensionsVal; - } - } ); -} )(); - - -function curCSS( elem, name, computed ) { - var width, minWidth, maxWidth, ret, - - // Support: Firefox 51+ - // Retrieving style before computed somehow - // fixes an issue with getting wrong values - // on detached elements - style = elem.style; - - computed = computed || getStyles( elem ); - - // getPropertyValue is needed for: - // .css('filter') (IE 9 only, #12537) - // .css('--customProperty) (#3144) - if ( computed ) { - ret = computed.getPropertyValue( name ) || computed[ name ]; - - if ( ret === "" && !isAttached( elem ) ) { - ret = jQuery.style( elem, name ); - } - - // A tribute to the "awesome hack by Dean Edwards" - // Android Browser returns percentage for some values, - // but width seems to be reliably pixels. - // This is against the CSSOM draft spec: - // https://drafts.csswg.org/cssom/#resolved-values - if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { - - // Remember the original values - width = style.width; - minWidth = style.minWidth; - maxWidth = style.maxWidth; - - // Put in the new values to get a computed value out - style.minWidth = style.maxWidth = style.width = ret; - ret = computed.width; - - // Revert the changed values - style.width = width; - style.minWidth = minWidth; - style.maxWidth = maxWidth; - } - } - - return ret !== undefined ? - - // Support: IE <=9 - 11 only - // IE returns zIndex value as an integer. - ret + "" : - ret; -} - - -function addGetHookIf( conditionFn, hookFn ) { - - // Define the hook, we'll check on the first run if it's really needed. - return { - get: function() { - if ( conditionFn() ) { - - // Hook not needed (or it's not possible to use it due - // to missing dependency), remove it. - delete this.get; - return; - } - - // Hook needed; redefine it so that the support test is not executed again. - return ( this.get = hookFn ).apply( this, arguments ); - } - }; -} - - -var cssPrefixes = [ "Webkit", "Moz", "ms" ], - emptyStyle = document.createElement( "div" ).style, - vendorProps = {}; - -// Return a vendor-prefixed property or undefined -function vendorPropName( name ) { - - // Check for vendor prefixed names - var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), - i = cssPrefixes.length; - - while ( i-- ) { - name = cssPrefixes[ i ] + capName; - if ( name in emptyStyle ) { - return name; - } - } -} - -// Return a potentially-mapped jQuery.cssProps or vendor prefixed property -function finalPropName( name ) { - var final = jQuery.cssProps[ name ] || vendorProps[ name ]; - - if ( final ) { - return final; - } - if ( name in emptyStyle ) { - return name; - } - return vendorProps[ name ] = vendorPropName( name ) || name; -} - - -var - - // Swappable if display is none or starts with table - // except "table", "table-cell", or "table-caption" - // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display - rdisplayswap = /^(none|table(?!-c[ea]).+)/, - rcustomProp = /^--/, - cssShow = { position: "absolute", visibility: "hidden", display: "block" }, - cssNormalTransform = { - letterSpacing: "0", - fontWeight: "400" - }; - -function setPositiveNumber( _elem, value, subtract ) { - - // Any relative (+/-) values have already been - // normalized at this point - var matches = rcssNum.exec( value ); - return matches ? - - // Guard against undefined "subtract", e.g., when used as in cssHooks - Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : - value; -} - -function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { - var i = dimension === "width" ? 1 : 0, - extra = 0, - delta = 0; - - // Adjustment may not be necessary - if ( box === ( isBorderBox ? "border" : "content" ) ) { - return 0; - } - - for ( ; i < 4; i += 2 ) { - - // Both box models exclude margin - if ( box === "margin" ) { - delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); - } - - // If we get here with a content-box, we're seeking "padding" or "border" or "margin" - if ( !isBorderBox ) { - - // Add padding - delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); - - // For "border" or "margin", add border - if ( box !== "padding" ) { - delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); - - // But still keep track of it otherwise - } else { - extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); - } - - // If we get here with a border-box (content + padding + border), we're seeking "content" or - // "padding" or "margin" - } else { - - // For "content", subtract padding - if ( box === "content" ) { - delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); - } - - // For "content" or "padding", subtract border - if ( box !== "margin" ) { - delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); - } - } - } - - // Account for positive content-box scroll gutter when requested by providing computedVal - if ( !isBorderBox && computedVal >= 0 ) { - - // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border - // Assuming integer scroll gutter, subtract the rest and round down - delta += Math.max( 0, Math.ceil( - elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - - computedVal - - delta - - extra - - 0.5 - - // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter - // Use an explicit zero to avoid NaN (gh-3964) - ) ) || 0; - } - - return delta; -} - -function getWidthOrHeight( elem, dimension, extra ) { - - // Start with computed style - var styles = getStyles( elem ), - - // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). - // Fake content-box until we know it's needed to know the true value. - boxSizingNeeded = !support.boxSizingReliable() || extra, - isBorderBox = boxSizingNeeded && - jQuery.css( elem, "boxSizing", false, styles ) === "border-box", - valueIsBorderBox = isBorderBox, - - val = curCSS( elem, dimension, styles ), - offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); - - // Support: Firefox <=54 - // Return a confounding non-pixel value or feign ignorance, as appropriate. - if ( rnumnonpx.test( val ) ) { - if ( !extra ) { - return val; - } - val = "auto"; - } - - - // Support: IE 9 - 11 only - // Use offsetWidth/offsetHeight for when box sizing is unreliable. - // In those cases, the computed value can be trusted to be border-box. - if ( ( !support.boxSizingReliable() && isBorderBox || - - // Support: IE 10 - 11+, Edge 15 - 18+ - // IE/Edge misreport `getComputedStyle` of table rows with width/height - // set in CSS while `offset*` properties report correct values. - // Interestingly, in some cases IE 9 doesn't suffer from this issue. - !support.reliableTrDimensions() && nodeName( elem, "tr" ) || - - // Fall back to offsetWidth/offsetHeight when value is "auto" - // This happens for inline elements with no explicit setting (gh-3571) - val === "auto" || - - // Support: Android <=4.1 - 4.3 only - // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) - !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && - - // Make sure the element is visible & connected - elem.getClientRects().length ) { - - isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; - - // Where available, offsetWidth/offsetHeight approximate border box dimensions. - // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the - // retrieved value as a content box dimension. - valueIsBorderBox = offsetProp in elem; - if ( valueIsBorderBox ) { - val = elem[ offsetProp ]; - } - } - - // Normalize "" and auto - val = parseFloat( val ) || 0; - - // Adjust for the element's box model - return ( val + - boxModelAdjustment( - elem, - dimension, - extra || ( isBorderBox ? "border" : "content" ), - valueIsBorderBox, - styles, - - // Provide the current computed size to request scroll gutter calculation (gh-3589) - val - ) - ) + "px"; -} - -jQuery.extend( { - - // Add in style property hooks for overriding the default - // behavior of getting and setting a style property - cssHooks: { - opacity: { - get: function( elem, computed ) { - if ( computed ) { - - // We should always get a number back from opacity - var ret = curCSS( elem, "opacity" ); - return ret === "" ? "1" : ret; - } - } - } - }, - - // Don't automatically add "px" to these possibly-unitless properties - cssNumber: { - "animationIterationCount": true, - "columnCount": true, - "fillOpacity": true, - "flexGrow": true, - "flexShrink": true, - "fontWeight": true, - "gridArea": true, - "gridColumn": true, - "gridColumnEnd": true, - "gridColumnStart": true, - "gridRow": true, - "gridRowEnd": true, - "gridRowStart": true, - "lineHeight": true, - "opacity": true, - "order": true, - "orphans": true, - "widows": true, - "zIndex": true, - "zoom": true - }, - - // Add in properties whose names you wish to fix before - // setting or getting the value - cssProps: {}, - - // Get and set the style property on a DOM Node - style: function( elem, name, value, extra ) { - - // Don't set styles on text and comment nodes - if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { - return; - } - - // Make sure that we're working with the right name - var ret, type, hooks, - origName = camelCase( name ), - isCustomProp = rcustomProp.test( name ), - style = elem.style; - - // Make sure that we're working with the right name. We don't - // want to query the value if it is a CSS custom property - // since they are user-defined. - if ( !isCustomProp ) { - name = finalPropName( origName ); - } - - // Gets hook for the prefixed version, then unprefixed version - hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; - - // Check if we're setting a value - if ( value !== undefined ) { - type = typeof value; - - // Convert "+=" or "-=" to relative numbers (#7345) - if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { - value = adjustCSS( elem, name, ret ); - - // Fixes bug #9237 - type = "number"; - } - - // Make sure that null and NaN values aren't set (#7116) - if ( value == null || value !== value ) { - return; - } - - // If a number was passed in, add the unit (except for certain CSS properties) - // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append - // "px" to a few hardcoded values. - if ( type === "number" && !isCustomProp ) { - value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); - } - - // background-* props affect original clone's values - if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { - style[ name ] = "inherit"; - } - - // If a hook was provided, use that value, otherwise just set the specified value - if ( !hooks || !( "set" in hooks ) || - ( value = hooks.set( elem, value, extra ) ) !== undefined ) { - - if ( isCustomProp ) { - style.setProperty( name, value ); - } else { - style[ name ] = value; - } - } - - } else { - - // If a hook was provided get the non-computed value from there - if ( hooks && "get" in hooks && - ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { - - return ret; - } - - // Otherwise just get the value from the style object - return style[ name ]; - } - }, - - css: function( elem, name, extra, styles ) { - var val, num, hooks, - origName = camelCase( name ), - isCustomProp = rcustomProp.test( name ); - - // Make sure that we're working with the right name. We don't - // want to modify the value if it is a CSS custom property - // since they are user-defined. - if ( !isCustomProp ) { - name = finalPropName( origName ); - } - - // Try prefixed name followed by the unprefixed name - hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; - - // If a hook was provided get the computed value from there - if ( hooks && "get" in hooks ) { - val = hooks.get( elem, true, extra ); - } - - // Otherwise, if a way to get the computed value exists, use that - if ( val === undefined ) { - val = curCSS( elem, name, styles ); - } - - // Convert "normal" to computed value - if ( val === "normal" && name in cssNormalTransform ) { - val = cssNormalTransform[ name ]; - } - - // Make numeric if forced or a qualifier was provided and val looks numeric - if ( extra === "" || extra ) { - num = parseFloat( val ); - return extra === true || isFinite( num ) ? num || 0 : val; - } - - return val; - } -} ); - -jQuery.each( [ "height", "width" ], function( _i, dimension ) { - jQuery.cssHooks[ dimension ] = { - get: function( elem, computed, extra ) { - if ( computed ) { - - // Certain elements can have dimension info if we invisibly show them - // but it must have a current display style that would benefit - return rdisplayswap.test( jQuery.css( elem, "display" ) ) && - - // Support: Safari 8+ - // Table columns in Safari have non-zero offsetWidth & zero - // getBoundingClientRect().width unless display is changed. - // Support: IE <=11 only - // Running getBoundingClientRect on a disconnected node - // in IE throws an error. - ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? - swap( elem, cssShow, function() { - return getWidthOrHeight( elem, dimension, extra ); - } ) : - getWidthOrHeight( elem, dimension, extra ); - } - }, - - set: function( elem, value, extra ) { - var matches, - styles = getStyles( elem ), - - // Only read styles.position if the test has a chance to fail - // to avoid forcing a reflow. - scrollboxSizeBuggy = !support.scrollboxSize() && - styles.position === "absolute", - - // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) - boxSizingNeeded = scrollboxSizeBuggy || extra, - isBorderBox = boxSizingNeeded && - jQuery.css( elem, "boxSizing", false, styles ) === "border-box", - subtract = extra ? - boxModelAdjustment( - elem, - dimension, - extra, - isBorderBox, - styles - ) : - 0; - - // Account for unreliable border-box dimensions by comparing offset* to computed and - // faking a content-box to get border and padding (gh-3699) - if ( isBorderBox && scrollboxSizeBuggy ) { - subtract -= Math.ceil( - elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - - parseFloat( styles[ dimension ] ) - - boxModelAdjustment( elem, dimension, "border", false, styles ) - - 0.5 - ); - } - - // Convert to pixels if value adjustment is needed - if ( subtract && ( matches = rcssNum.exec( value ) ) && - ( matches[ 3 ] || "px" ) !== "px" ) { - - elem.style[ dimension ] = value; - value = jQuery.css( elem, dimension ); - } - - return setPositiveNumber( elem, value, subtract ); - } - }; -} ); - -jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, - function( elem, computed ) { - if ( computed ) { - return ( parseFloat( curCSS( elem, "marginLeft" ) ) || - elem.getBoundingClientRect().left - - swap( elem, { marginLeft: 0 }, function() { - return elem.getBoundingClientRect().left; - } ) - ) + "px"; - } - } -); - -// These hooks are used by animate to expand properties -jQuery.each( { - margin: "", - padding: "", - border: "Width" -}, function( prefix, suffix ) { - jQuery.cssHooks[ prefix + suffix ] = { - expand: function( value ) { - var i = 0, - expanded = {}, - - // Assumes a single number if not a string - parts = typeof value === "string" ? value.split( " " ) : [ value ]; - - for ( ; i < 4; i++ ) { - expanded[ prefix + cssExpand[ i ] + suffix ] = - parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; - } - - return expanded; - } - }; - - if ( prefix !== "margin" ) { - jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; - } -} ); - -jQuery.fn.extend( { - css: function( name, value ) { - return access( this, function( elem, name, value ) { - var styles, len, - map = {}, - i = 0; - - if ( Array.isArray( name ) ) { - styles = getStyles( elem ); - len = name.length; - - for ( ; i < len; i++ ) { - map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); - } - - return map; - } - - return value !== undefined ? - jQuery.style( elem, name, value ) : - jQuery.css( elem, name ); - }, name, value, arguments.length > 1 ); - } -} ); - - -function Tween( elem, options, prop, end, easing ) { - return new Tween.prototype.init( elem, options, prop, end, easing ); -} -jQuery.Tween = Tween; - -Tween.prototype = { - constructor: Tween, - init: function( elem, options, prop, end, easing, unit ) { - this.elem = elem; - this.prop = prop; - this.easing = easing || jQuery.easing._default; - this.options = options; - this.start = this.now = this.cur(); - this.end = end; - this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); - }, - cur: function() { - var hooks = Tween.propHooks[ this.prop ]; - - return hooks && hooks.get ? - hooks.get( this ) : - Tween.propHooks._default.get( this ); - }, - run: function( percent ) { - var eased, - hooks = Tween.propHooks[ this.prop ]; - - if ( this.options.duration ) { - this.pos = eased = jQuery.easing[ this.easing ]( - percent, this.options.duration * percent, 0, 1, this.options.duration - ); - } else { - this.pos = eased = percent; - } - this.now = ( this.end - this.start ) * eased + this.start; - - if ( this.options.step ) { - this.options.step.call( this.elem, this.now, this ); - } - - if ( hooks && hooks.set ) { - hooks.set( this ); - } else { - Tween.propHooks._default.set( this ); - } - return this; - } -}; - -Tween.prototype.init.prototype = Tween.prototype; - -Tween.propHooks = { - _default: { - get: function( tween ) { - var result; - - // Use a property on the element directly when it is not a DOM element, - // or when there is no matching style property that exists. - if ( tween.elem.nodeType !== 1 || - tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { - return tween.elem[ tween.prop ]; - } - - // Passing an empty string as a 3rd parameter to .css will automatically - // attempt a parseFloat and fallback to a string if the parse fails. - // Simple values such as "10px" are parsed to Float; - // complex values such as "rotate(1rad)" are returned as-is. - result = jQuery.css( tween.elem, tween.prop, "" ); - - // Empty strings, null, undefined and "auto" are converted to 0. - return !result || result === "auto" ? 0 : result; - }, - set: function( tween ) { - - // Use step hook for back compat. - // Use cssHook if its there. - // Use .style if available and use plain properties where available. - if ( jQuery.fx.step[ tween.prop ] ) { - jQuery.fx.step[ tween.prop ]( tween ); - } else if ( tween.elem.nodeType === 1 && ( - jQuery.cssHooks[ tween.prop ] || - tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { - jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); - } else { - tween.elem[ tween.prop ] = tween.now; - } - } - } -}; - -// Support: IE <=9 only -// Panic based approach to setting things on disconnected nodes -Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { - set: function( tween ) { - if ( tween.elem.nodeType && tween.elem.parentNode ) { - tween.elem[ tween.prop ] = tween.now; - } - } -}; - -jQuery.easing = { - linear: function( p ) { - return p; - }, - swing: function( p ) { - return 0.5 - Math.cos( p * Math.PI ) / 2; - }, - _default: "swing" -}; - -jQuery.fx = Tween.prototype.init; - -// Back compat <1.8 extension point -jQuery.fx.step = {}; - - - - -var - fxNow, inProgress, - rfxtypes = /^(?:toggle|show|hide)$/, - rrun = /queueHooks$/; - -function schedule() { - if ( inProgress ) { - if ( document.hidden === false && window.requestAnimationFrame ) { - window.requestAnimationFrame( schedule ); - } else { - window.setTimeout( schedule, jQuery.fx.interval ); - } - - jQuery.fx.tick(); - } -} - -// Animations created synchronously will run synchronously -function createFxNow() { - window.setTimeout( function() { - fxNow = undefined; - } ); - return ( fxNow = Date.now() ); -} - -// Generate parameters to create a standard animation -function genFx( type, includeWidth ) { - var which, - i = 0, - attrs = { height: type }; - - // If we include width, step value is 1 to do all cssExpand values, - // otherwise step value is 2 to skip over Left and Right - includeWidth = includeWidth ? 1 : 0; - for ( ; i < 4; i += 2 - includeWidth ) { - which = cssExpand[ i ]; - attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; - } - - if ( includeWidth ) { - attrs.opacity = attrs.width = type; - } - - return attrs; -} - -function createTween( value, prop, animation ) { - var tween, - collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), - index = 0, - length = collection.length; - for ( ; index < length; index++ ) { - if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { - - // We're done with this property - return tween; - } - } -} - -function defaultPrefilter( elem, props, opts ) { - var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, - isBox = "width" in props || "height" in props, - anim = this, - orig = {}, - style = elem.style, - hidden = elem.nodeType && isHiddenWithinTree( elem ), - dataShow = dataPriv.get( elem, "fxshow" ); - - // Queue-skipping animations hijack the fx hooks - if ( !opts.queue ) { - hooks = jQuery._queueHooks( elem, "fx" ); - if ( hooks.unqueued == null ) { - hooks.unqueued = 0; - oldfire = hooks.empty.fire; - hooks.empty.fire = function() { - if ( !hooks.unqueued ) { - oldfire(); - } - }; - } - hooks.unqueued++; - - anim.always( function() { - - // Ensure the complete handler is called before this completes - anim.always( function() { - hooks.unqueued--; - if ( !jQuery.queue( elem, "fx" ).length ) { - hooks.empty.fire(); - } - } ); - } ); - } - - // Detect show/hide animations - for ( prop in props ) { - value = props[ prop ]; - if ( rfxtypes.test( value ) ) { - delete props[ prop ]; - toggle = toggle || value === "toggle"; - if ( value === ( hidden ? "hide" : "show" ) ) { - - // Pretend to be hidden if this is a "show" and - // there is still data from a stopped show/hide - if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { - hidden = true; - - // Ignore all other no-op show/hide data - } else { - continue; - } - } - orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); - } - } - - // Bail out if this is a no-op like .hide().hide() - propTween = !jQuery.isEmptyObject( props ); - if ( !propTween && jQuery.isEmptyObject( orig ) ) { - return; - } - - // Restrict "overflow" and "display" styles during box animations - if ( isBox && elem.nodeType === 1 ) { - - // Support: IE <=9 - 11, Edge 12 - 15 - // Record all 3 overflow attributes because IE does not infer the shorthand - // from identically-valued overflowX and overflowY and Edge just mirrors - // the overflowX value there. - opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; - - // Identify a display type, preferring old show/hide data over the CSS cascade - restoreDisplay = dataShow && dataShow.display; - if ( restoreDisplay == null ) { - restoreDisplay = dataPriv.get( elem, "display" ); - } - display = jQuery.css( elem, "display" ); - if ( display === "none" ) { - if ( restoreDisplay ) { - display = restoreDisplay; - } else { - - // Get nonempty value(s) by temporarily forcing visibility - showHide( [ elem ], true ); - restoreDisplay = elem.style.display || restoreDisplay; - display = jQuery.css( elem, "display" ); - showHide( [ elem ] ); - } - } - - // Animate inline elements as inline-block - if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { - if ( jQuery.css( elem, "float" ) === "none" ) { - - // Restore the original display value at the end of pure show/hide animations - if ( !propTween ) { - anim.done( function() { - style.display = restoreDisplay; - } ); - if ( restoreDisplay == null ) { - display = style.display; - restoreDisplay = display === "none" ? "" : display; - } - } - style.display = "inline-block"; - } - } - } - - if ( opts.overflow ) { - style.overflow = "hidden"; - anim.always( function() { - style.overflow = opts.overflow[ 0 ]; - style.overflowX = opts.overflow[ 1 ]; - style.overflowY = opts.overflow[ 2 ]; - } ); - } - - // Implement show/hide animations - propTween = false; - for ( prop in orig ) { - - // General show/hide setup for this element animation - if ( !propTween ) { - if ( dataShow ) { - if ( "hidden" in dataShow ) { - hidden = dataShow.hidden; - } - } else { - dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); - } - - // Store hidden/visible for toggle so `.stop().toggle()` "reverses" - if ( toggle ) { - dataShow.hidden = !hidden; - } - - // Show elements before animating them - if ( hidden ) { - showHide( [ elem ], true ); - } - - /* eslint-disable no-loop-func */ - - anim.done( function() { - - /* eslint-enable no-loop-func */ - - // The final step of a "hide" animation is actually hiding the element - if ( !hidden ) { - showHide( [ elem ] ); - } - dataPriv.remove( elem, "fxshow" ); - for ( prop in orig ) { - jQuery.style( elem, prop, orig[ prop ] ); - } - } ); - } - - // Per-property setup - propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); - if ( !( prop in dataShow ) ) { - dataShow[ prop ] = propTween.start; - if ( hidden ) { - propTween.end = propTween.start; - propTween.start = 0; - } - } - } -} - -function propFilter( props, specialEasing ) { - var index, name, easing, value, hooks; - - // camelCase, specialEasing and expand cssHook pass - for ( index in props ) { - name = camelCase( index ); - easing = specialEasing[ name ]; - value = props[ index ]; - if ( Array.isArray( value ) ) { - easing = value[ 1 ]; - value = props[ index ] = value[ 0 ]; - } - - if ( index !== name ) { - props[ name ] = value; - delete props[ index ]; - } - - hooks = jQuery.cssHooks[ name ]; - if ( hooks && "expand" in hooks ) { - value = hooks.expand( value ); - delete props[ name ]; - - // Not quite $.extend, this won't overwrite existing keys. - // Reusing 'index' because we have the correct "name" - for ( index in value ) { - if ( !( index in props ) ) { - props[ index ] = value[ index ]; - specialEasing[ index ] = easing; - } - } - } else { - specialEasing[ name ] = easing; - } - } -} - -function Animation( elem, properties, options ) { - var result, - stopped, - index = 0, - length = Animation.prefilters.length, - deferred = jQuery.Deferred().always( function() { - - // Don't match elem in the :animated selector - delete tick.elem; - } ), - tick = function() { - if ( stopped ) { - return false; - } - var currentTime = fxNow || createFxNow(), - remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), - - // Support: Android 2.3 only - // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) - temp = remaining / animation.duration || 0, - percent = 1 - temp, - index = 0, - length = animation.tweens.length; - - for ( ; index < length; index++ ) { - animation.tweens[ index ].run( percent ); - } - - deferred.notifyWith( elem, [ animation, percent, remaining ] ); - - // If there's more to do, yield - if ( percent < 1 && length ) { - return remaining; - } - - // If this was an empty animation, synthesize a final progress notification - if ( !length ) { - deferred.notifyWith( elem, [ animation, 1, 0 ] ); - } - - // Resolve the animation and report its conclusion - deferred.resolveWith( elem, [ animation ] ); - return false; - }, - animation = deferred.promise( { - elem: elem, - props: jQuery.extend( {}, properties ), - opts: jQuery.extend( true, { - specialEasing: {}, - easing: jQuery.easing._default - }, options ), - originalProperties: properties, - originalOptions: options, - startTime: fxNow || createFxNow(), - duration: options.duration, - tweens: [], - createTween: function( prop, end ) { - var tween = jQuery.Tween( elem, animation.opts, prop, end, - animation.opts.specialEasing[ prop ] || animation.opts.easing ); - animation.tweens.push( tween ); - return tween; - }, - stop: function( gotoEnd ) { - var index = 0, - - // If we are going to the end, we want to run all the tweens - // otherwise we skip this part - length = gotoEnd ? animation.tweens.length : 0; - if ( stopped ) { - return this; - } - stopped = true; - for ( ; index < length; index++ ) { - animation.tweens[ index ].run( 1 ); - } - - // Resolve when we played the last frame; otherwise, reject - if ( gotoEnd ) { - deferred.notifyWith( elem, [ animation, 1, 0 ] ); - deferred.resolveWith( elem, [ animation, gotoEnd ] ); - } else { - deferred.rejectWith( elem, [ animation, gotoEnd ] ); - } - return this; - } - } ), - props = animation.props; - - propFilter( props, animation.opts.specialEasing ); - - for ( ; index < length; index++ ) { - result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); - if ( result ) { - if ( isFunction( result.stop ) ) { - jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = - result.stop.bind( result ); - } - return result; - } - } - - jQuery.map( props, createTween, animation ); - - if ( isFunction( animation.opts.start ) ) { - animation.opts.start.call( elem, animation ); - } - - // Attach callbacks from options - animation - .progress( animation.opts.progress ) - .done( animation.opts.done, animation.opts.complete ) - .fail( animation.opts.fail ) - .always( animation.opts.always ); - - jQuery.fx.timer( - jQuery.extend( tick, { - elem: elem, - anim: animation, - queue: animation.opts.queue - } ) - ); - - return animation; -} - -jQuery.Animation = jQuery.extend( Animation, { - - tweeners: { - "*": [ function( prop, value ) { - var tween = this.createTween( prop, value ); - adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); - return tween; - } ] - }, - - tweener: function( props, callback ) { - if ( isFunction( props ) ) { - callback = props; - props = [ "*" ]; - } else { - props = props.match( rnothtmlwhite ); - } - - var prop, - index = 0, - length = props.length; - - for ( ; index < length; index++ ) { - prop = props[ index ]; - Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; - Animation.tweeners[ prop ].unshift( callback ); - } - }, - - prefilters: [ defaultPrefilter ], - - prefilter: function( callback, prepend ) { - if ( prepend ) { - Animation.prefilters.unshift( callback ); - } else { - Animation.prefilters.push( callback ); - } - } -} ); - -jQuery.speed = function( speed, easing, fn ) { - var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { - complete: fn || !fn && easing || - isFunction( speed ) && speed, - duration: speed, - easing: fn && easing || easing && !isFunction( easing ) && easing - }; - - // Go to the end state if fx are off - if ( jQuery.fx.off ) { - opt.duration = 0; - - } else { - if ( typeof opt.duration !== "number" ) { - if ( opt.duration in jQuery.fx.speeds ) { - opt.duration = jQuery.fx.speeds[ opt.duration ]; - - } else { - opt.duration = jQuery.fx.speeds._default; - } - } - } - - // Normalize opt.queue - true/undefined/null -> "fx" - if ( opt.queue == null || opt.queue === true ) { - opt.queue = "fx"; - } - - // Queueing - opt.old = opt.complete; - - opt.complete = function() { - if ( isFunction( opt.old ) ) { - opt.old.call( this ); - } - - if ( opt.queue ) { - jQuery.dequeue( this, opt.queue ); - } - }; - - return opt; -}; - -jQuery.fn.extend( { - fadeTo: function( speed, to, easing, callback ) { - - // Show any hidden elements after setting opacity to 0 - return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() - - // Animate to the value specified - .end().animate( { opacity: to }, speed, easing, callback ); - }, - animate: function( prop, speed, easing, callback ) { - var empty = jQuery.isEmptyObject( prop ), - optall = jQuery.speed( speed, easing, callback ), - doAnimation = function() { - - // Operate on a copy of prop so per-property easing won't be lost - var anim = Animation( this, jQuery.extend( {}, prop ), optall ); - - // Empty animations, or finishing resolves immediately - if ( empty || dataPriv.get( this, "finish" ) ) { - anim.stop( true ); - } - }; - doAnimation.finish = doAnimation; - - return empty || optall.queue === false ? - this.each( doAnimation ) : - this.queue( optall.queue, doAnimation ); - }, - stop: function( type, clearQueue, gotoEnd ) { - var stopQueue = function( hooks ) { - var stop = hooks.stop; - delete hooks.stop; - stop( gotoEnd ); - }; - - if ( typeof type !== "string" ) { - gotoEnd = clearQueue; - clearQueue = type; - type = undefined; - } - if ( clearQueue ) { - this.queue( type || "fx", [] ); - } - - return this.each( function() { - var dequeue = true, - index = type != null && type + "queueHooks", - timers = jQuery.timers, - data = dataPriv.get( this ); - - if ( index ) { - if ( data[ index ] && data[ index ].stop ) { - stopQueue( data[ index ] ); - } - } else { - for ( index in data ) { - if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { - stopQueue( data[ index ] ); - } - } - } - - for ( index = timers.length; index--; ) { - if ( timers[ index ].elem === this && - ( type == null || timers[ index ].queue === type ) ) { - - timers[ index ].anim.stop( gotoEnd ); - dequeue = false; - timers.splice( index, 1 ); - } - } - - // Start the next in the queue if the last step wasn't forced. - // Timers currently will call their complete callbacks, which - // will dequeue but only if they were gotoEnd. - if ( dequeue || !gotoEnd ) { - jQuery.dequeue( this, type ); - } - } ); - }, - finish: function( type ) { - if ( type !== false ) { - type = type || "fx"; - } - return this.each( function() { - var index, - data = dataPriv.get( this ), - queue = data[ type + "queue" ], - hooks = data[ type + "queueHooks" ], - timers = jQuery.timers, - length = queue ? queue.length : 0; - - // Enable finishing flag on private data - data.finish = true; - - // Empty the queue first - jQuery.queue( this, type, [] ); - - if ( hooks && hooks.stop ) { - hooks.stop.call( this, true ); - } - - // Look for any active animations, and finish them - for ( index = timers.length; index--; ) { - if ( timers[ index ].elem === this && timers[ index ].queue === type ) { - timers[ index ].anim.stop( true ); - timers.splice( index, 1 ); - } - } - - // Look for any animations in the old queue and finish them - for ( index = 0; index < length; index++ ) { - if ( queue[ index ] && queue[ index ].finish ) { - queue[ index ].finish.call( this ); - } - } - - // Turn off finishing flag - delete data.finish; - } ); - } -} ); - -jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { - var cssFn = jQuery.fn[ name ]; - jQuery.fn[ name ] = function( speed, easing, callback ) { - return speed == null || typeof speed === "boolean" ? - cssFn.apply( this, arguments ) : - this.animate( genFx( name, true ), speed, easing, callback ); - }; -} ); - -// Generate shortcuts for custom animations -jQuery.each( { - slideDown: genFx( "show" ), - slideUp: genFx( "hide" ), - slideToggle: genFx( "toggle" ), - fadeIn: { opacity: "show" }, - fadeOut: { opacity: "hide" }, - fadeToggle: { opacity: "toggle" } -}, function( name, props ) { - jQuery.fn[ name ] = function( speed, easing, callback ) { - return this.animate( props, speed, easing, callback ); - }; -} ); - -jQuery.timers = []; -jQuery.fx.tick = function() { - var timer, - i = 0, - timers = jQuery.timers; - - fxNow = Date.now(); - - for ( ; i < timers.length; i++ ) { - timer = timers[ i ]; - - // Run the timer and safely remove it when done (allowing for external removal) - if ( !timer() && timers[ i ] === timer ) { - timers.splice( i--, 1 ); - } - } - - if ( !timers.length ) { - jQuery.fx.stop(); - } - fxNow = undefined; -}; - -jQuery.fx.timer = function( timer ) { - jQuery.timers.push( timer ); - jQuery.fx.start(); -}; - -jQuery.fx.interval = 13; -jQuery.fx.start = function() { - if ( inProgress ) { - return; - } - - inProgress = true; - schedule(); -}; - -jQuery.fx.stop = function() { - inProgress = null; -}; - -jQuery.fx.speeds = { - slow: 600, - fast: 200, - - // Default speed - _default: 400 -}; - - -// Based off of the plugin by Clint Helfers, with permission. -// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ -jQuery.fn.delay = function( time, type ) { - time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; - type = type || "fx"; - - return this.queue( type, function( next, hooks ) { - var timeout = window.setTimeout( next, time ); - hooks.stop = function() { - window.clearTimeout( timeout ); - }; - } ); -}; - - -( function() { - var input = document.createElement( "input" ), - select = document.createElement( "select" ), - opt = select.appendChild( document.createElement( "option" ) ); - - input.type = "checkbox"; - - // Support: Android <=4.3 only - // Default value for a checkbox should be "on" - support.checkOn = input.value !== ""; - - // Support: IE <=11 only - // Must access selectedIndex to make default options select - support.optSelected = opt.selected; - - // Support: IE <=11 only - // An input loses its value after becoming a radio - input = document.createElement( "input" ); - input.value = "t"; - input.type = "radio"; - support.radioValue = input.value === "t"; -} )(); - - -var boolHook, - attrHandle = jQuery.expr.attrHandle; - -jQuery.fn.extend( { - attr: function( name, value ) { - return access( this, jQuery.attr, name, value, arguments.length > 1 ); - }, - - removeAttr: function( name ) { - return this.each( function() { - jQuery.removeAttr( this, name ); - } ); - } -} ); - -jQuery.extend( { - attr: function( elem, name, value ) { - var ret, hooks, - nType = elem.nodeType; - - // Don't get/set attributes on text, comment and attribute nodes - if ( nType === 3 || nType === 8 || nType === 2 ) { - return; - } - - // Fallback to prop when attributes are not supported - if ( typeof elem.getAttribute === "undefined" ) { - return jQuery.prop( elem, name, value ); - } - - // Attribute hooks are determined by the lowercase version - // Grab necessary hook if one is defined - if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { - hooks = jQuery.attrHooks[ name.toLowerCase() ] || - ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); - } - - if ( value !== undefined ) { - if ( value === null ) { - jQuery.removeAttr( elem, name ); - return; - } - - if ( hooks && "set" in hooks && - ( ret = hooks.set( elem, value, name ) ) !== undefined ) { - return ret; - } - - elem.setAttribute( name, value + "" ); - return value; - } - - if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { - return ret; - } - - ret = jQuery.find.attr( elem, name ); - - // Non-existent attributes return null, we normalize to undefined - return ret == null ? undefined : ret; - }, - - attrHooks: { - type: { - set: function( elem, value ) { - if ( !support.radioValue && value === "radio" && - nodeName( elem, "input" ) ) { - var val = elem.value; - elem.setAttribute( "type", value ); - if ( val ) { - elem.value = val; - } - return value; - } - } - } - }, - - removeAttr: function( elem, value ) { - var name, - i = 0, - - // Attribute names can contain non-HTML whitespace characters - // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 - attrNames = value && value.match( rnothtmlwhite ); - - if ( attrNames && elem.nodeType === 1 ) { - while ( ( name = attrNames[ i++ ] ) ) { - elem.removeAttribute( name ); - } - } - } -} ); - -// Hooks for boolean attributes -boolHook = { - set: function( elem, value, name ) { - if ( value === false ) { - - // Remove boolean attributes when set to false - jQuery.removeAttr( elem, name ); - } else { - elem.setAttribute( name, name ); - } - return name; - } -}; - -jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { - var getter = attrHandle[ name ] || jQuery.find.attr; - - attrHandle[ name ] = function( elem, name, isXML ) { - var ret, handle, - lowercaseName = name.toLowerCase(); - - if ( !isXML ) { - - // Avoid an infinite loop by temporarily removing this function from the getter - handle = attrHandle[ lowercaseName ]; - attrHandle[ lowercaseName ] = ret; - ret = getter( elem, name, isXML ) != null ? - lowercaseName : - null; - attrHandle[ lowercaseName ] = handle; - } - return ret; - }; -} ); - - - - -var rfocusable = /^(?:input|select|textarea|button)$/i, - rclickable = /^(?:a|area)$/i; - -jQuery.fn.extend( { - prop: function( name, value ) { - return access( this, jQuery.prop, name, value, arguments.length > 1 ); - }, - - removeProp: function( name ) { - return this.each( function() { - delete this[ jQuery.propFix[ name ] || name ]; - } ); - } -} ); - -jQuery.extend( { - prop: function( elem, name, value ) { - var ret, hooks, - nType = elem.nodeType; - - // Don't get/set properties on text, comment and attribute nodes - if ( nType === 3 || nType === 8 || nType === 2 ) { - return; - } - - if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { - - // Fix name and attach hooks - name = jQuery.propFix[ name ] || name; - hooks = jQuery.propHooks[ name ]; - } - - if ( value !== undefined ) { - if ( hooks && "set" in hooks && - ( ret = hooks.set( elem, value, name ) ) !== undefined ) { - return ret; - } - - return ( elem[ name ] = value ); - } - - if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { - return ret; - } - - return elem[ name ]; - }, - - propHooks: { - tabIndex: { - get: function( elem ) { - - // Support: IE <=9 - 11 only - // elem.tabIndex doesn't always return the - // correct value when it hasn't been explicitly set - // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ - // Use proper attribute retrieval(#12072) - var tabindex = jQuery.find.attr( elem, "tabindex" ); - - if ( tabindex ) { - return parseInt( tabindex, 10 ); - } - - if ( - rfocusable.test( elem.nodeName ) || - rclickable.test( elem.nodeName ) && - elem.href - ) { - return 0; - } - - return -1; - } - } - }, - - propFix: { - "for": "htmlFor", - "class": "className" - } -} ); - -// Support: IE <=11 only -// Accessing the selectedIndex property -// forces the browser to respect setting selected -// on the option -// The getter ensures a default option is selected -// when in an optgroup -// eslint rule "no-unused-expressions" is disabled for this code -// since it considers such accessions noop -if ( !support.optSelected ) { - jQuery.propHooks.selected = { - get: function( elem ) { - - /* eslint no-unused-expressions: "off" */ - - var parent = elem.parentNode; - if ( parent && parent.parentNode ) { - parent.parentNode.selectedIndex; - } - return null; - }, - set: function( elem ) { - - /* eslint no-unused-expressions: "off" */ - - var parent = elem.parentNode; - if ( parent ) { - parent.selectedIndex; - - if ( parent.parentNode ) { - parent.parentNode.selectedIndex; - } - } - } - }; -} - -jQuery.each( [ - "tabIndex", - "readOnly", - "maxLength", - "cellSpacing", - "cellPadding", - "rowSpan", - "colSpan", - "useMap", - "frameBorder", - "contentEditable" -], function() { - jQuery.propFix[ this.toLowerCase() ] = this; -} ); - - - - - // Strip and collapse whitespace according to HTML spec - // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace - function stripAndCollapse( value ) { - var tokens = value.match( rnothtmlwhite ) || []; - return tokens.join( " " ); - } - - -function getClass( elem ) { - return elem.getAttribute && elem.getAttribute( "class" ) || ""; -} - -function classesToArray( value ) { - if ( Array.isArray( value ) ) { - return value; - } - if ( typeof value === "string" ) { - return value.match( rnothtmlwhite ) || []; - } - return []; -} - -jQuery.fn.extend( { - addClass: function( value ) { - var classes, elem, cur, curValue, clazz, j, finalValue, - i = 0; - - if ( isFunction( value ) ) { - return this.each( function( j ) { - jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); - } ); - } - - classes = classesToArray( value ); - - if ( classes.length ) { - while ( ( elem = this[ i++ ] ) ) { - curValue = getClass( elem ); - cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); - - if ( cur ) { - j = 0; - while ( ( clazz = classes[ j++ ] ) ) { - if ( cur.indexOf( " " + clazz + " " ) < 0 ) { - cur += clazz + " "; - } - } - - // Only assign if different to avoid unneeded rendering. - finalValue = stripAndCollapse( cur ); - if ( curValue !== finalValue ) { - elem.setAttribute( "class", finalValue ); - } - } - } - } - - return this; - }, - - removeClass: function( value ) { - var classes, elem, cur, curValue, clazz, j, finalValue, - i = 0; - - if ( isFunction( value ) ) { - return this.each( function( j ) { - jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); - } ); - } - - if ( !arguments.length ) { - return this.attr( "class", "" ); - } - - classes = classesToArray( value ); - - if ( classes.length ) { - while ( ( elem = this[ i++ ] ) ) { - curValue = getClass( elem ); - - // This expression is here for better compressibility (see addClass) - cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); - - if ( cur ) { - j = 0; - while ( ( clazz = classes[ j++ ] ) ) { - - // Remove *all* instances - while ( cur.indexOf( " " + clazz + " " ) > -1 ) { - cur = cur.replace( " " + clazz + " ", " " ); - } - } - - // Only assign if different to avoid unneeded rendering. - finalValue = stripAndCollapse( cur ); - if ( curValue !== finalValue ) { - elem.setAttribute( "class", finalValue ); - } - } - } - } - - return this; - }, - - toggleClass: function( value, stateVal ) { - var type = typeof value, - isValidValue = type === "string" || Array.isArray( value ); - - if ( typeof stateVal === "boolean" && isValidValue ) { - return stateVal ? this.addClass( value ) : this.removeClass( value ); - } - - if ( isFunction( value ) ) { - return this.each( function( i ) { - jQuery( this ).toggleClass( - value.call( this, i, getClass( this ), stateVal ), - stateVal - ); - } ); - } - - return this.each( function() { - var className, i, self, classNames; - - if ( isValidValue ) { - - // Toggle individual class names - i = 0; - self = jQuery( this ); - classNames = classesToArray( value ); - - while ( ( className = classNames[ i++ ] ) ) { - - // Check each className given, space separated list - if ( self.hasClass( className ) ) { - self.removeClass( className ); - } else { - self.addClass( className ); - } - } - - // Toggle whole class name - } else if ( value === undefined || type === "boolean" ) { - className = getClass( this ); - if ( className ) { - - // Store className if set - dataPriv.set( this, "__className__", className ); - } - - // If the element has a class name or if we're passed `false`, - // then remove the whole classname (if there was one, the above saved it). - // Otherwise bring back whatever was previously saved (if anything), - // falling back to the empty string if nothing was stored. - if ( this.setAttribute ) { - this.setAttribute( "class", - className || value === false ? - "" : - dataPriv.get( this, "__className__" ) || "" - ); - } - } - } ); - }, - - hasClass: function( selector ) { - var className, elem, - i = 0; - - className = " " + selector + " "; - while ( ( elem = this[ i++ ] ) ) { - if ( elem.nodeType === 1 && - ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { - return true; - } - } - - return false; - } -} ); - - - - -var rreturn = /\r/g; - -jQuery.fn.extend( { - val: function( value ) { - var hooks, ret, valueIsFunction, - elem = this[ 0 ]; - - if ( !arguments.length ) { - if ( elem ) { - hooks = jQuery.valHooks[ elem.type ] || - jQuery.valHooks[ elem.nodeName.toLowerCase() ]; - - if ( hooks && - "get" in hooks && - ( ret = hooks.get( elem, "value" ) ) !== undefined - ) { - return ret; - } - - ret = elem.value; - - // Handle most common string cases - if ( typeof ret === "string" ) { - return ret.replace( rreturn, "" ); - } - - // Handle cases where value is null/undef or number - return ret == null ? "" : ret; - } - - return; - } - - valueIsFunction = isFunction( value ); - - return this.each( function( i ) { - var val; - - if ( this.nodeType !== 1 ) { - return; - } - - if ( valueIsFunction ) { - val = value.call( this, i, jQuery( this ).val() ); - } else { - val = value; - } - - // Treat null/undefined as ""; convert numbers to string - if ( val == null ) { - val = ""; - - } else if ( typeof val === "number" ) { - val += ""; - - } else if ( Array.isArray( val ) ) { - val = jQuery.map( val, function( value ) { - return value == null ? "" : value + ""; - } ); - } - - hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; - - // If set returns undefined, fall back to normal setting - if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { - this.value = val; - } - } ); - } -} ); - -jQuery.extend( { - valHooks: { - option: { - get: function( elem ) { - - var val = jQuery.find.attr( elem, "value" ); - return val != null ? - val : - - // Support: IE <=10 - 11 only - // option.text throws exceptions (#14686, #14858) - // Strip and collapse whitespace - // https://html.spec.whatwg.org/#strip-and-collapse-whitespace - stripAndCollapse( jQuery.text( elem ) ); - } - }, - select: { - get: function( elem ) { - var value, option, i, - options = elem.options, - index = elem.selectedIndex, - one = elem.type === "select-one", - values = one ? null : [], - max = one ? index + 1 : options.length; - - if ( index < 0 ) { - i = max; - - } else { - i = one ? index : 0; - } - - // Loop through all the selected options - for ( ; i < max; i++ ) { - option = options[ i ]; - - // Support: IE <=9 only - // IE8-9 doesn't update selected after form reset (#2551) - if ( ( option.selected || i === index ) && - - // Don't return options that are disabled or in a disabled optgroup - !option.disabled && - ( !option.parentNode.disabled || - !nodeName( option.parentNode, "optgroup" ) ) ) { - - // Get the specific value for the option - value = jQuery( option ).val(); - - // We don't need an array for one selects - if ( one ) { - return value; - } - - // Multi-Selects return an array - values.push( value ); - } - } - - return values; - }, - - set: function( elem, value ) { - var optionSet, option, - options = elem.options, - values = jQuery.makeArray( value ), - i = options.length; - - while ( i-- ) { - option = options[ i ]; - - /* eslint-disable no-cond-assign */ - - if ( option.selected = - jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 - ) { - optionSet = true; - } - - /* eslint-enable no-cond-assign */ - } - - // Force browsers to behave consistently when non-matching value is set - if ( !optionSet ) { - elem.selectedIndex = -1; - } - return values; - } - } - } -} ); - -// Radios and checkboxes getter/setter -jQuery.each( [ "radio", "checkbox" ], function() { - jQuery.valHooks[ this ] = { - set: function( elem, value ) { - if ( Array.isArray( value ) ) { - return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); - } - } - }; - if ( !support.checkOn ) { - jQuery.valHooks[ this ].get = function( elem ) { - return elem.getAttribute( "value" ) === null ? "on" : elem.value; - }; - } -} ); - - - - -// Return jQuery for attributes-only inclusion - - -support.focusin = "onfocusin" in window; - - -var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, - stopPropagationCallback = function( e ) { - e.stopPropagation(); - }; - -jQuery.extend( jQuery.event, { - - trigger: function( event, data, elem, onlyHandlers ) { - - var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, - eventPath = [ elem || document ], - type = hasOwn.call( event, "type" ) ? event.type : event, - namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; - - cur = lastElement = tmp = elem = elem || document; - - // Don't do events on text and comment nodes - if ( elem.nodeType === 3 || elem.nodeType === 8 ) { - return; - } - - // focus/blur morphs to focusin/out; ensure we're not firing them right now - if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { - return; - } - - if ( type.indexOf( "." ) > -1 ) { - - // Namespaced trigger; create a regexp to match event type in handle() - namespaces = type.split( "." ); - type = namespaces.shift(); - namespaces.sort(); - } - ontype = type.indexOf( ":" ) < 0 && "on" + type; - - // Caller can pass in a jQuery.Event object, Object, or just an event type string - event = event[ jQuery.expando ] ? - event : - new jQuery.Event( type, typeof event === "object" && event ); - - // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) - event.isTrigger = onlyHandlers ? 2 : 3; - event.namespace = namespaces.join( "." ); - event.rnamespace = event.namespace ? - new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : - null; - - // Clean up the event in case it is being reused - event.result = undefined; - if ( !event.target ) { - event.target = elem; - } - - // Clone any incoming data and prepend the event, creating the handler arg list - data = data == null ? - [ event ] : - jQuery.makeArray( data, [ event ] ); - - // Allow special events to draw outside the lines - special = jQuery.event.special[ type ] || {}; - if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { - return; - } - - // Determine event propagation path in advance, per W3C events spec (#9951) - // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) - if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { - - bubbleType = special.delegateType || type; - if ( !rfocusMorph.test( bubbleType + type ) ) { - cur = cur.parentNode; - } - for ( ; cur; cur = cur.parentNode ) { - eventPath.push( cur ); - tmp = cur; - } - - // Only add window if we got to document (e.g., not plain obj or detached DOM) - if ( tmp === ( elem.ownerDocument || document ) ) { - eventPath.push( tmp.defaultView || tmp.parentWindow || window ); - } - } - - // Fire handlers on the event path - i = 0; - while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { - lastElement = cur; - event.type = i > 1 ? - bubbleType : - special.bindType || type; - - // jQuery handler - handle = ( - dataPriv.get( cur, "events" ) || Object.create( null ) - )[ event.type ] && - dataPriv.get( cur, "handle" ); - if ( handle ) { - handle.apply( cur, data ); - } - - // Native handler - handle = ontype && cur[ ontype ]; - if ( handle && handle.apply && acceptData( cur ) ) { - event.result = handle.apply( cur, data ); - if ( event.result === false ) { - event.preventDefault(); - } - } - } - event.type = type; - - // If nobody prevented the default action, do it now - if ( !onlyHandlers && !event.isDefaultPrevented() ) { - - if ( ( !special._default || - special._default.apply( eventPath.pop(), data ) === false ) && - acceptData( elem ) ) { - - // Call a native DOM method on the target with the same name as the event. - // Don't do default actions on window, that's where global variables be (#6170) - if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { - - // Don't re-trigger an onFOO event when we call its FOO() method - tmp = elem[ ontype ]; - - if ( tmp ) { - elem[ ontype ] = null; - } - - // Prevent re-triggering of the same event, since we already bubbled it above - jQuery.event.triggered = type; - - if ( event.isPropagationStopped() ) { - lastElement.addEventListener( type, stopPropagationCallback ); - } - - elem[ type ](); - - if ( event.isPropagationStopped() ) { - lastElement.removeEventListener( type, stopPropagationCallback ); - } - - jQuery.event.triggered = undefined; - - if ( tmp ) { - elem[ ontype ] = tmp; - } - } - } - } - - return event.result; - }, - - // Piggyback on a donor event to simulate a different one - // Used only for `focus(in | out)` events - simulate: function( type, elem, event ) { - var e = jQuery.extend( - new jQuery.Event(), - event, - { - type: type, - isSimulated: true - } - ); - - jQuery.event.trigger( e, null, elem ); - } - -} ); - -jQuery.fn.extend( { - - trigger: function( type, data ) { - return this.each( function() { - jQuery.event.trigger( type, data, this ); - } ); - }, - triggerHandler: function( type, data ) { - var elem = this[ 0 ]; - if ( elem ) { - return jQuery.event.trigger( type, data, elem, true ); - } - } -} ); - - -// Support: Firefox <=44 -// Firefox doesn't have focus(in | out) events -// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 -// -// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 -// focus(in | out) events fire after focus & blur events, -// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order -// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 -if ( !support.focusin ) { - jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { - - // Attach a single capturing handler on the document while someone wants focusin/focusout - var handler = function( event ) { - jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); - }; - - jQuery.event.special[ fix ] = { - setup: function() { - - // Handle: regular nodes (via `this.ownerDocument`), window - // (via `this.document`) & document (via `this`). - var doc = this.ownerDocument || this.document || this, - attaches = dataPriv.access( doc, fix ); - - if ( !attaches ) { - doc.addEventListener( orig, handler, true ); - } - dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); - }, - teardown: function() { - var doc = this.ownerDocument || this.document || this, - attaches = dataPriv.access( doc, fix ) - 1; - - if ( !attaches ) { - doc.removeEventListener( orig, handler, true ); - dataPriv.remove( doc, fix ); - - } else { - dataPriv.access( doc, fix, attaches ); - } - } - }; - } ); -} -var location = window.location; - -var nonce = { guid: Date.now() }; - -var rquery = ( /\?/ ); - - - -// Cross-browser xml parsing -jQuery.parseXML = function( data ) { - var xml; - if ( !data || typeof data !== "string" ) { - return null; - } - - // Support: IE 9 - 11 only - // IE throws on parseFromString with invalid input. - try { - xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); - } catch ( e ) { - xml = undefined; - } - - if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { - jQuery.error( "Invalid XML: " + data ); - } - return xml; -}; - - -var - rbracket = /\[\]$/, - rCRLF = /\r?\n/g, - rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, - rsubmittable = /^(?:input|select|textarea|keygen)/i; - -function buildParams( prefix, obj, traditional, add ) { - var name; - - if ( Array.isArray( obj ) ) { - - // Serialize array item. - jQuery.each( obj, function( i, v ) { - if ( traditional || rbracket.test( prefix ) ) { - - // Treat each array item as a scalar. - add( prefix, v ); - - } else { - - // Item is non-scalar (array or object), encode its numeric index. - buildParams( - prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", - v, - traditional, - add - ); - } - } ); - - } else if ( !traditional && toType( obj ) === "object" ) { - - // Serialize object item. - for ( name in obj ) { - buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); - } - - } else { - - // Serialize scalar item. - add( prefix, obj ); - } -} - -// Serialize an array of form elements or a set of -// key/values into a query string -jQuery.param = function( a, traditional ) { - var prefix, - s = [], - add = function( key, valueOrFunction ) { - - // If value is a function, invoke it and use its return value - var value = isFunction( valueOrFunction ) ? - valueOrFunction() : - valueOrFunction; - - s[ s.length ] = encodeURIComponent( key ) + "=" + - encodeURIComponent( value == null ? "" : value ); - }; - - if ( a == null ) { - return ""; - } - - // If an array was passed in, assume that it is an array of form elements. - if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { - - // Serialize the form elements - jQuery.each( a, function() { - add( this.name, this.value ); - } ); - - } else { - - // If traditional, encode the "old" way (the way 1.3.2 or older - // did it), otherwise encode params recursively. - for ( prefix in a ) { - buildParams( prefix, a[ prefix ], traditional, add ); - } - } - - // Return the resulting serialization - return s.join( "&" ); -}; - -jQuery.fn.extend( { - serialize: function() { - return jQuery.param( this.serializeArray() ); - }, - serializeArray: function() { - return this.map( function() { - - // Can add propHook for "elements" to filter or add form elements - var elements = jQuery.prop( this, "elements" ); - return elements ? jQuery.makeArray( elements ) : this; - } ) - .filter( function() { - var type = this.type; - - // Use .is( ":disabled" ) so that fieldset[disabled] works - return this.name && !jQuery( this ).is( ":disabled" ) && - rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && - ( this.checked || !rcheckableType.test( type ) ); - } ) - .map( function( _i, elem ) { - var val = jQuery( this ).val(); - - if ( val == null ) { - return null; - } - - if ( Array.isArray( val ) ) { - return jQuery.map( val, function( val ) { - return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; - } ); - } - - return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; - } ).get(); - } -} ); - - -var - r20 = /%20/g, - rhash = /#.*$/, - rantiCache = /([?&])_=[^&]*/, - rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, - - // #7653, #8125, #8152: local protocol detection - rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, - rnoContent = /^(?:GET|HEAD)$/, - rprotocol = /^\/\//, - - /* Prefilters - * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) - * 2) These are called: - * - BEFORE asking for a transport - * - AFTER param serialization (s.data is a string if s.processData is true) - * 3) key is the dataType - * 4) the catchall symbol "*" can be used - * 5) execution will start with transport dataType and THEN continue down to "*" if needed - */ - prefilters = {}, - - /* Transports bindings - * 1) key is the dataType - * 2) the catchall symbol "*" can be used - * 3) selection will start with transport dataType and THEN go to "*" if needed - */ - transports = {}, - - // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression - allTypes = "*/".concat( "*" ), - - // Anchor tag for parsing the document origin - originAnchor = document.createElement( "a" ); - originAnchor.href = location.href; - -// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport -function addToPrefiltersOrTransports( structure ) { - - // dataTypeExpression is optional and defaults to "*" - return function( dataTypeExpression, func ) { - - if ( typeof dataTypeExpression !== "string" ) { - func = dataTypeExpression; - dataTypeExpression = "*"; - } - - var dataType, - i = 0, - dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; - - if ( isFunction( func ) ) { - - // For each dataType in the dataTypeExpression - while ( ( dataType = dataTypes[ i++ ] ) ) { - - // Prepend if requested - if ( dataType[ 0 ] === "+" ) { - dataType = dataType.slice( 1 ) || "*"; - ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); - - // Otherwise append - } else { - ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); - } - } - } - }; -} - -// Base inspection function for prefilters and transports -function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { - - var inspected = {}, - seekingTransport = ( structure === transports ); - - function inspect( dataType ) { - var selected; - inspected[ dataType ] = true; - jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { - var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); - if ( typeof dataTypeOrTransport === "string" && - !seekingTransport && !inspected[ dataTypeOrTransport ] ) { - - options.dataTypes.unshift( dataTypeOrTransport ); - inspect( dataTypeOrTransport ); - return false; - } else if ( seekingTransport ) { - return !( selected = dataTypeOrTransport ); - } - } ); - return selected; - } - - return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); -} - -// A special extend for ajax options -// that takes "flat" options (not to be deep extended) -// Fixes #9887 -function ajaxExtend( target, src ) { - var key, deep, - flatOptions = jQuery.ajaxSettings.flatOptions || {}; - - for ( key in src ) { - if ( src[ key ] !== undefined ) { - ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; - } - } - if ( deep ) { - jQuery.extend( true, target, deep ); - } - - return target; -} - -/* Handles responses to an ajax request: - * - finds the right dataType (mediates between content-type and expected dataType) - * - returns the corresponding response - */ -function ajaxHandleResponses( s, jqXHR, responses ) { - - var ct, type, finalDataType, firstDataType, - contents = s.contents, - dataTypes = s.dataTypes; - - // Remove auto dataType and get content-type in the process - while ( dataTypes[ 0 ] === "*" ) { - dataTypes.shift(); - if ( ct === undefined ) { - ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); - } - } - - // Check if we're dealing with a known content-type - if ( ct ) { - for ( type in contents ) { - if ( contents[ type ] && contents[ type ].test( ct ) ) { - dataTypes.unshift( type ); - break; - } - } - } - - // Check to see if we have a response for the expected dataType - if ( dataTypes[ 0 ] in responses ) { - finalDataType = dataTypes[ 0 ]; - } else { - - // Try convertible dataTypes - for ( type in responses ) { - if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { - finalDataType = type; - break; - } - if ( !firstDataType ) { - firstDataType = type; - } - } - - // Or just use first one - finalDataType = finalDataType || firstDataType; - } - - // If we found a dataType - // We add the dataType to the list if needed - // and return the corresponding response - if ( finalDataType ) { - if ( finalDataType !== dataTypes[ 0 ] ) { - dataTypes.unshift( finalDataType ); - } - return responses[ finalDataType ]; - } -} - -/* Chain conversions given the request and the original response - * Also sets the responseXXX fields on the jqXHR instance - */ -function ajaxConvert( s, response, jqXHR, isSuccess ) { - var conv2, current, conv, tmp, prev, - converters = {}, - - // Work with a copy of dataTypes in case we need to modify it for conversion - dataTypes = s.dataTypes.slice(); - - // Create converters map with lowercased keys - if ( dataTypes[ 1 ] ) { - for ( conv in s.converters ) { - converters[ conv.toLowerCase() ] = s.converters[ conv ]; - } - } - - current = dataTypes.shift(); - - // Convert to each sequential dataType - while ( current ) { - - if ( s.responseFields[ current ] ) { - jqXHR[ s.responseFields[ current ] ] = response; - } - - // Apply the dataFilter if provided - if ( !prev && isSuccess && s.dataFilter ) { - response = s.dataFilter( response, s.dataType ); - } - - prev = current; - current = dataTypes.shift(); - - if ( current ) { - - // There's only work to do if current dataType is non-auto - if ( current === "*" ) { - - current = prev; - - // Convert response if prev dataType is non-auto and differs from current - } else if ( prev !== "*" && prev !== current ) { - - // Seek a direct converter - conv = converters[ prev + " " + current ] || converters[ "* " + current ]; - - // If none found, seek a pair - if ( !conv ) { - for ( conv2 in converters ) { - - // If conv2 outputs current - tmp = conv2.split( " " ); - if ( tmp[ 1 ] === current ) { - - // If prev can be converted to accepted input - conv = converters[ prev + " " + tmp[ 0 ] ] || - converters[ "* " + tmp[ 0 ] ]; - if ( conv ) { - - // Condense equivalence converters - if ( conv === true ) { - conv = converters[ conv2 ]; - - // Otherwise, insert the intermediate dataType - } else if ( converters[ conv2 ] !== true ) { - current = tmp[ 0 ]; - dataTypes.unshift( tmp[ 1 ] ); - } - break; - } - } - } - } - - // Apply converter (if not an equivalence) - if ( conv !== true ) { - - // Unless errors are allowed to bubble, catch and return them - if ( conv && s.throws ) { - response = conv( response ); - } else { - try { - response = conv( response ); - } catch ( e ) { - return { - state: "parsererror", - error: conv ? e : "No conversion from " + prev + " to " + current - }; - } - } - } - } - } - } - - return { state: "success", data: response }; -} - -jQuery.extend( { - - // Counter for holding the number of active queries - active: 0, - - // Last-Modified header cache for next request - lastModified: {}, - etag: {}, - - ajaxSettings: { - url: location.href, - type: "GET", - isLocal: rlocalProtocol.test( location.protocol ), - global: true, - processData: true, - async: true, - contentType: "application/x-www-form-urlencoded; charset=UTF-8", - - /* - timeout: 0, - data: null, - dataType: null, - username: null, - password: null, - cache: null, - throws: false, - traditional: false, - headers: {}, - */ - - accepts: { - "*": allTypes, - text: "text/plain", - html: "text/html", - xml: "application/xml, text/xml", - json: "application/json, text/javascript" - }, - - contents: { - xml: /\bxml\b/, - html: /\bhtml/, - json: /\bjson\b/ - }, - - responseFields: { - xml: "responseXML", - text: "responseText", - json: "responseJSON" - }, - - // Data converters - // Keys separate source (or catchall "*") and destination types with a single space - converters: { - - // Convert anything to text - "* text": String, - - // Text to html (true = no transformation) - "text html": true, - - // Evaluate text as a json expression - "text json": JSON.parse, - - // Parse text as xml - "text xml": jQuery.parseXML - }, - - // For options that shouldn't be deep extended: - // you can add your own custom options here if - // and when you create one that shouldn't be - // deep extended (see ajaxExtend) - flatOptions: { - url: true, - context: true - } - }, - - // Creates a full fledged settings object into target - // with both ajaxSettings and settings fields. - // If target is omitted, writes into ajaxSettings. - ajaxSetup: function( target, settings ) { - return settings ? - - // Building a settings object - ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : - - // Extending ajaxSettings - ajaxExtend( jQuery.ajaxSettings, target ); - }, - - ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), - ajaxTransport: addToPrefiltersOrTransports( transports ), - - // Main method - ajax: function( url, options ) { - - // If url is an object, simulate pre-1.5 signature - if ( typeof url === "object" ) { - options = url; - url = undefined; - } - - // Force options to be an object - options = options || {}; - - var transport, - - // URL without anti-cache param - cacheURL, - - // Response headers - responseHeadersString, - responseHeaders, - - // timeout handle - timeoutTimer, - - // Url cleanup var - urlAnchor, - - // Request state (becomes false upon send and true upon completion) - completed, - - // To know if global events are to be dispatched - fireGlobals, - - // Loop variable - i, - - // uncached part of the url - uncached, - - // Create the final options object - s = jQuery.ajaxSetup( {}, options ), - - // Callbacks context - callbackContext = s.context || s, - - // Context for global events is callbackContext if it is a DOM node or jQuery collection - globalEventContext = s.context && - ( callbackContext.nodeType || callbackContext.jquery ) ? - jQuery( callbackContext ) : - jQuery.event, - - // Deferreds - deferred = jQuery.Deferred(), - completeDeferred = jQuery.Callbacks( "once memory" ), - - // Status-dependent callbacks - statusCode = s.statusCode || {}, - - // Headers (they are sent all at once) - requestHeaders = {}, - requestHeadersNames = {}, - - // Default abort message - strAbort = "canceled", - - // Fake xhr - jqXHR = { - readyState: 0, - - // Builds headers hashtable if needed - getResponseHeader: function( key ) { - var match; - if ( completed ) { - if ( !responseHeaders ) { - responseHeaders = {}; - while ( ( match = rheaders.exec( responseHeadersString ) ) ) { - responseHeaders[ match[ 1 ].toLowerCase() + " " ] = - ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) - .concat( match[ 2 ] ); - } - } - match = responseHeaders[ key.toLowerCase() + " " ]; - } - return match == null ? null : match.join( ", " ); - }, - - // Raw string - getAllResponseHeaders: function() { - return completed ? responseHeadersString : null; - }, - - // Caches the header - setRequestHeader: function( name, value ) { - if ( completed == null ) { - name = requestHeadersNames[ name.toLowerCase() ] = - requestHeadersNames[ name.toLowerCase() ] || name; - requestHeaders[ name ] = value; - } - return this; - }, - - // Overrides response content-type header - overrideMimeType: function( type ) { - if ( completed == null ) { - s.mimeType = type; - } - return this; - }, - - // Status-dependent callbacks - statusCode: function( map ) { - var code; - if ( map ) { - if ( completed ) { - - // Execute the appropriate callbacks - jqXHR.always( map[ jqXHR.status ] ); - } else { - - // Lazy-add the new callbacks in a way that preserves old ones - for ( code in map ) { - statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; - } - } - } - return this; - }, - - // Cancel the request - abort: function( statusText ) { - var finalText = statusText || strAbort; - if ( transport ) { - transport.abort( finalText ); - } - done( 0, finalText ); - return this; - } - }; - - // Attach deferreds - deferred.promise( jqXHR ); - - // Add protocol if not provided (prefilters might expect it) - // Handle falsy url in the settings object (#10093: consistency with old signature) - // We also use the url parameter if available - s.url = ( ( url || s.url || location.href ) + "" ) - .replace( rprotocol, location.protocol + "//" ); - - // Alias method option to type as per ticket #12004 - s.type = options.method || options.type || s.method || s.type; - - // Extract dataTypes list - s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; - - // A cross-domain request is in order when the origin doesn't match the current origin. - if ( s.crossDomain == null ) { - urlAnchor = document.createElement( "a" ); - - // Support: IE <=8 - 11, Edge 12 - 15 - // IE throws exception on accessing the href property if url is malformed, - // e.g. http://example.com:80x/ - try { - urlAnchor.href = s.url; - - // Support: IE <=8 - 11 only - // Anchor's host property isn't correctly set when s.url is relative - urlAnchor.href = urlAnchor.href; - s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== - urlAnchor.protocol + "//" + urlAnchor.host; - } catch ( e ) { - - // If there is an error parsing the URL, assume it is crossDomain, - // it can be rejected by the transport if it is invalid - s.crossDomain = true; - } - } - - // Convert data if not already a string - if ( s.data && s.processData && typeof s.data !== "string" ) { - s.data = jQuery.param( s.data, s.traditional ); - } - - // Apply prefilters - inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); - - // If request was aborted inside a prefilter, stop there - if ( completed ) { - return jqXHR; - } - - // We can fire global events as of now if asked to - // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) - fireGlobals = jQuery.event && s.global; - - // Watch for a new set of requests - if ( fireGlobals && jQuery.active++ === 0 ) { - jQuery.event.trigger( "ajaxStart" ); - } - - // Uppercase the type - s.type = s.type.toUpperCase(); - - // Determine if request has content - s.hasContent = !rnoContent.test( s.type ); - - // Save the URL in case we're toying with the If-Modified-Since - // and/or If-None-Match header later on - // Remove hash to simplify url manipulation - cacheURL = s.url.replace( rhash, "" ); - - // More options handling for requests with no content - if ( !s.hasContent ) { - - // Remember the hash so we can put it back - uncached = s.url.slice( cacheURL.length ); - - // If data is available and should be processed, append data to url - if ( s.data && ( s.processData || typeof s.data === "string" ) ) { - cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; - - // #9682: remove data so that it's not used in an eventual retry - delete s.data; - } - - // Add or update anti-cache param if needed - if ( s.cache === false ) { - cacheURL = cacheURL.replace( rantiCache, "$1" ); - uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + - uncached; - } - - // Put hash and anti-cache on the URL that will be requested (gh-1732) - s.url = cacheURL + uncached; - - // Change '%20' to '+' if this is encoded form body content (gh-2658) - } else if ( s.data && s.processData && - ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { - s.data = s.data.replace( r20, "+" ); - } - - // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. - if ( s.ifModified ) { - if ( jQuery.lastModified[ cacheURL ] ) { - jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); - } - if ( jQuery.etag[ cacheURL ] ) { - jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); - } - } - - // Set the correct header, if data is being sent - if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { - jqXHR.setRequestHeader( "Content-Type", s.contentType ); - } - - // Set the Accepts header for the server, depending on the dataType - jqXHR.setRequestHeader( - "Accept", - s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? - s.accepts[ s.dataTypes[ 0 ] ] + - ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : - s.accepts[ "*" ] - ); - - // Check for headers option - for ( i in s.headers ) { - jqXHR.setRequestHeader( i, s.headers[ i ] ); - } - - // Allow custom headers/mimetypes and early abort - if ( s.beforeSend && - ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { - - // Abort if not done already and return - return jqXHR.abort(); - } - - // Aborting is no longer a cancellation - strAbort = "abort"; - - // Install callbacks on deferreds - completeDeferred.add( s.complete ); - jqXHR.done( s.success ); - jqXHR.fail( s.error ); - - // Get transport - transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); - - // If no transport, we auto-abort - if ( !transport ) { - done( -1, "No Transport" ); - } else { - jqXHR.readyState = 1; - - // Send global event - if ( fireGlobals ) { - globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); - } - - // If request was aborted inside ajaxSend, stop there - if ( completed ) { - return jqXHR; - } - - // Timeout - if ( s.async && s.timeout > 0 ) { - timeoutTimer = window.setTimeout( function() { - jqXHR.abort( "timeout" ); - }, s.timeout ); - } - - try { - completed = false; - transport.send( requestHeaders, done ); - } catch ( e ) { - - // Rethrow post-completion exceptions - if ( completed ) { - throw e; - } - - // Propagate others as results - done( -1, e ); - } - } - - // Callback for when everything is done - function done( status, nativeStatusText, responses, headers ) { - var isSuccess, success, error, response, modified, - statusText = nativeStatusText; - - // Ignore repeat invocations - if ( completed ) { - return; - } - - completed = true; - - // Clear timeout if it exists - if ( timeoutTimer ) { - window.clearTimeout( timeoutTimer ); - } - - // Dereference transport for early garbage collection - // (no matter how long the jqXHR object will be used) - transport = undefined; - - // Cache response headers - responseHeadersString = headers || ""; - - // Set readyState - jqXHR.readyState = status > 0 ? 4 : 0; - - // Determine if successful - isSuccess = status >= 200 && status < 300 || status === 304; - - // Get response data - if ( responses ) { - response = ajaxHandleResponses( s, jqXHR, responses ); - } - - // Use a noop converter for missing script - if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { - s.converters[ "text script" ] = function() {}; - } - - // Convert no matter what (that way responseXXX fields are always set) - response = ajaxConvert( s, response, jqXHR, isSuccess ); - - // If successful, handle type chaining - if ( isSuccess ) { - - // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. - if ( s.ifModified ) { - modified = jqXHR.getResponseHeader( "Last-Modified" ); - if ( modified ) { - jQuery.lastModified[ cacheURL ] = modified; - } - modified = jqXHR.getResponseHeader( "etag" ); - if ( modified ) { - jQuery.etag[ cacheURL ] = modified; - } - } - - // if no content - if ( status === 204 || s.type === "HEAD" ) { - statusText = "nocontent"; - - // if not modified - } else if ( status === 304 ) { - statusText = "notmodified"; - - // If we have data, let's convert it - } else { - statusText = response.state; - success = response.data; - error = response.error; - isSuccess = !error; - } - } else { - - // Extract error from statusText and normalize for non-aborts - error = statusText; - if ( status || !statusText ) { - statusText = "error"; - if ( status < 0 ) { - status = 0; - } - } - } - - // Set data for the fake xhr object - jqXHR.status = status; - jqXHR.statusText = ( nativeStatusText || statusText ) + ""; - - // Success/Error - if ( isSuccess ) { - deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); - } else { - deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); - } - - // Status-dependent callbacks - jqXHR.statusCode( statusCode ); - statusCode = undefined; - - if ( fireGlobals ) { - globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", - [ jqXHR, s, isSuccess ? success : error ] ); - } - - // Complete - completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); - - if ( fireGlobals ) { - globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); - - // Handle the global AJAX counter - if ( !( --jQuery.active ) ) { - jQuery.event.trigger( "ajaxStop" ); - } - } - } - - return jqXHR; - }, - - getJSON: function( url, data, callback ) { - return jQuery.get( url, data, callback, "json" ); - }, - - getScript: function( url, callback ) { - return jQuery.get( url, undefined, callback, "script" ); - } -} ); - -jQuery.each( [ "get", "post" ], function( _i, method ) { - jQuery[ method ] = function( url, data, callback, type ) { - - // Shift arguments if data argument was omitted - if ( isFunction( data ) ) { - type = type || callback; - callback = data; - data = undefined; - } - - // The url can be an options object (which then must have .url) - return jQuery.ajax( jQuery.extend( { - url: url, - type: method, - dataType: type, - data: data, - success: callback - }, jQuery.isPlainObject( url ) && url ) ); - }; -} ); - -jQuery.ajaxPrefilter( function( s ) { - var i; - for ( i in s.headers ) { - if ( i.toLowerCase() === "content-type" ) { - s.contentType = s.headers[ i ] || ""; - } - } -} ); - - -jQuery._evalUrl = function( url, options, doc ) { - return jQuery.ajax( { - url: url, - - // Make this explicit, since user can override this through ajaxSetup (#11264) - type: "GET", - dataType: "script", - cache: true, - async: false, - global: false, - - // Only evaluate the response if it is successful (gh-4126) - // dataFilter is not invoked for failure responses, so using it instead - // of the default converter is kludgy but it works. - converters: { - "text script": function() {} - }, - dataFilter: function( response ) { - jQuery.globalEval( response, options, doc ); - } - } ); -}; - - -jQuery.fn.extend( { - wrapAll: function( html ) { - var wrap; - - if ( this[ 0 ] ) { - if ( isFunction( html ) ) { - html = html.call( this[ 0 ] ); - } - - // The elements to wrap the target around - wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); - - if ( this[ 0 ].parentNode ) { - wrap.insertBefore( this[ 0 ] ); - } - - wrap.map( function() { - var elem = this; - - while ( elem.firstElementChild ) { - elem = elem.firstElementChild; - } - - return elem; - } ).append( this ); - } - - return this; - }, - - wrapInner: function( html ) { - if ( isFunction( html ) ) { - return this.each( function( i ) { - jQuery( this ).wrapInner( html.call( this, i ) ); - } ); - } - - return this.each( function() { - var self = jQuery( this ), - contents = self.contents(); - - if ( contents.length ) { - contents.wrapAll( html ); - - } else { - self.append( html ); - } - } ); - }, - - wrap: function( html ) { - var htmlIsFunction = isFunction( html ); - - return this.each( function( i ) { - jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); - } ); - }, - - unwrap: function( selector ) { - this.parent( selector ).not( "body" ).each( function() { - jQuery( this ).replaceWith( this.childNodes ); - } ); - return this; - } -} ); - - -jQuery.expr.pseudos.hidden = function( elem ) { - return !jQuery.expr.pseudos.visible( elem ); -}; -jQuery.expr.pseudos.visible = function( elem ) { - return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); -}; - - - - -jQuery.ajaxSettings.xhr = function() { - try { - return new window.XMLHttpRequest(); - } catch ( e ) {} -}; - -var xhrSuccessStatus = { - - // File protocol always yields status code 0, assume 200 - 0: 200, - - // Support: IE <=9 only - // #1450: sometimes IE returns 1223 when it should be 204 - 1223: 204 - }, - xhrSupported = jQuery.ajaxSettings.xhr(); - -support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); -support.ajax = xhrSupported = !!xhrSupported; - -jQuery.ajaxTransport( function( options ) { - var callback, errorCallback; - - // Cross domain only allowed if supported through XMLHttpRequest - if ( support.cors || xhrSupported && !options.crossDomain ) { - return { - send: function( headers, complete ) { - var i, - xhr = options.xhr(); - - xhr.open( - options.type, - options.url, - options.async, - options.username, - options.password - ); - - // Apply custom fields if provided - if ( options.xhrFields ) { - for ( i in options.xhrFields ) { - xhr[ i ] = options.xhrFields[ i ]; - } - } - - // Override mime type if needed - if ( options.mimeType && xhr.overrideMimeType ) { - xhr.overrideMimeType( options.mimeType ); - } - - // X-Requested-With header - // For cross-domain requests, seeing as conditions for a preflight are - // akin to a jigsaw puzzle, we simply never set it to be sure. - // (it can always be set on a per-request basis or even using ajaxSetup) - // For same-domain requests, won't change header if already provided. - if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { - headers[ "X-Requested-With" ] = "XMLHttpRequest"; - } - - // Set headers - for ( i in headers ) { - xhr.setRequestHeader( i, headers[ i ] ); - } - - // Callback - callback = function( type ) { - return function() { - if ( callback ) { - callback = errorCallback = xhr.onload = - xhr.onerror = xhr.onabort = xhr.ontimeout = - xhr.onreadystatechange = null; - - if ( type === "abort" ) { - xhr.abort(); - } else if ( type === "error" ) { - - // Support: IE <=9 only - // On a manual native abort, IE9 throws - // errors on any property access that is not readyState - if ( typeof xhr.status !== "number" ) { - complete( 0, "error" ); - } else { - complete( - - // File: protocol always yields status 0; see #8605, #14207 - xhr.status, - xhr.statusText - ); - } - } else { - complete( - xhrSuccessStatus[ xhr.status ] || xhr.status, - xhr.statusText, - - // Support: IE <=9 only - // IE9 has no XHR2 but throws on binary (trac-11426) - // For XHR2 non-text, let the caller handle it (gh-2498) - ( xhr.responseType || "text" ) !== "text" || - typeof xhr.responseText !== "string" ? - { binary: xhr.response } : - { text: xhr.responseText }, - xhr.getAllResponseHeaders() - ); - } - } - }; - }; - - // Listen to events - xhr.onload = callback(); - errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); - - // Support: IE 9 only - // Use onreadystatechange to replace onabort - // to handle uncaught aborts - if ( xhr.onabort !== undefined ) { - xhr.onabort = errorCallback; - } else { - xhr.onreadystatechange = function() { - - // Check readyState before timeout as it changes - if ( xhr.readyState === 4 ) { - - // Allow onerror to be called first, - // but that will not handle a native abort - // Also, save errorCallback to a variable - // as xhr.onerror cannot be accessed - window.setTimeout( function() { - if ( callback ) { - errorCallback(); - } - } ); - } - }; - } - - // Create the abort callback - callback = callback( "abort" ); - - try { - - // Do send the request (this may raise an exception) - xhr.send( options.hasContent && options.data || null ); - } catch ( e ) { - - // #14683: Only rethrow if this hasn't been notified as an error yet - if ( callback ) { - throw e; - } - } - }, - - abort: function() { - if ( callback ) { - callback(); - } - } - }; - } -} ); - - - - -// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) -jQuery.ajaxPrefilter( function( s ) { - if ( s.crossDomain ) { - s.contents.script = false; - } -} ); - -// Install script dataType -jQuery.ajaxSetup( { - accepts: { - script: "text/javascript, application/javascript, " + - "application/ecmascript, application/x-ecmascript" - }, - contents: { - script: /\b(?:java|ecma)script\b/ - }, - converters: { - "text script": function( text ) { - jQuery.globalEval( text ); - return text; - } - } -} ); - -// Handle cache's special case and crossDomain -jQuery.ajaxPrefilter( "script", function( s ) { - if ( s.cache === undefined ) { - s.cache = false; - } - if ( s.crossDomain ) { - s.type = "GET"; - } -} ); - -// Bind script tag hack transport -jQuery.ajaxTransport( "script", function( s ) { - - // This transport only deals with cross domain or forced-by-attrs requests - if ( s.crossDomain || s.scriptAttrs ) { - var script, callback; - return { - send: function( _, complete ) { - script = jQuery( " - +
From 4bfc78283cce744850b5652041f3014ef5d3f5f0 Mon Sep 17 00:00:00 2001 From: Tim Donohue Date: Thu, 21 May 2020 16:35:39 -0500 Subject: [PATCH 060/125] Correct code alignment in client.js --- .../src/main/webapp/js/hal/http/client.js | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/dspace-server-webapp/src/main/webapp/js/hal/http/client.js b/dspace-server-webapp/src/main/webapp/js/hal/http/client.js index f48ba390fe..da65f706e5 100644 --- a/dspace-server-webapp/src/main/webapp/js/hal/http/client.js +++ b/dspace-server-webapp/src/main/webapp/js/hal/http/client.js @@ -77,14 +77,13 @@ HAL.Http.Client.prototype.get = function(url) { }, error: function() { self.vent.trigger('fail-response', { jqxhr: jqxhr }); - var contentTypeResponseHeader = jqxhr.getResponseHeader("content-type"); - if (contentTypeResponseHeader != undefined - && !contentTypeResponseHeader.startsWith("application/hal") - && !contentTypeResponseHeader.startsWith("application/json")) { - downloadFile(url); - } + var contentTypeResponseHeader = jqxhr.getResponseHeader("content-type"); + if (contentTypeResponseHeader != undefined + && !contentTypeResponseHeader.startsWith("application/hal") + && !contentTypeResponseHeader.startsWith("application/json")) { + downloadFile(url); } - }); + }}); }; HAL.Http.Client.prototype.request = function(opts) { From 66992cfe19ff04237ded54ade65f7cb405aa258b Mon Sep 17 00:00:00 2001 From: Mykhaylo Date: Fri, 22 May 2020 22:29:54 +0200 Subject: [PATCH 061/125] added solr plugin to index collection submitters --- ...erviceIndexCollectionSubmittersPlugin.java | 76 +++++++++++++++++++ dspace/config/spring/api/discovery.xml | 1 + dspace/solr/search/conf/schema.xml | 2 + 3 files changed, 79 insertions(+) create mode 100644 dspace-api/src/main/java/org/dspace/discovery/SolrServiceIndexCollectionSubmittersPlugin.java diff --git a/dspace-api/src/main/java/org/dspace/discovery/SolrServiceIndexCollectionSubmittersPlugin.java b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceIndexCollectionSubmittersPlugin.java new file mode 100644 index 0000000000..ebcaab78af --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceIndexCollectionSubmittersPlugin.java @@ -0,0 +1,76 @@ +/** + * 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.discovery; + +import java.sql.SQLException; +import java.util.List; + +import org.apache.logging.log4j.Logger; +import org.apache.solr.common.SolrInputDocument; +import org.dspace.authorize.ResourcePolicy; +import org.dspace.authorize.service.AuthorizeService; +import org.dspace.content.Collection; +import org.dspace.content.Community; +import org.dspace.content.factory.ContentServiceFactory; +import org.dspace.core.Constants; +import org.dspace.core.Context; +import org.dspace.core.LogManager; +import org.dspace.discovery.indexobject.IndexableCollection; +import org.springframework.beans.factory.annotation.Autowired; + +/** + * The purpose of this plugin is to index all ADD type resource policies related to collections. + * + * @author Mykhaylo Boychuk (at 4science.it) + */ +public class SolrServiceIndexCollectionSubmittersPlugin implements SolrServiceIndexPlugin { + + private static final Logger log = org.apache.logging.log4j.LogManager + .getLogger(SolrServiceIndexCollectionSubmittersPlugin.class); + + @Autowired(required = true) + protected AuthorizeService authorizeService; + + @Override + public void additionalIndex(Context context, IndexableObject idxObj, SolrInputDocument document) { + if (idxObj instanceof IndexableCollection) { + Collection col = ((IndexableCollection) idxObj).getIndexedObject(); + if (col != null) { + try { + String fieldValue = null; + Community parent = (Community) ContentServiceFactory.getInstance().getDSpaceObjectService(col) + .getParentObject(context, col); + while (parent != null) { + if (parent.getAdministrators() != null) { + fieldValue = "g" + parent.getAdministrators().getID(); + document.addField("submit", fieldValue); + } + parent = (Community) ContentServiceFactory.getInstance().getDSpaceObjectService(parent) + .getParentObject(context, parent); + } + List policies = authorizeService.getPoliciesActionFilter(context, col, + Constants.ADD); + for (ResourcePolicy resourcePolicy : policies) { + if (resourcePolicy.getGroup() != null) { + fieldValue = "g" + resourcePolicy.getGroup().getID(); + } else { + fieldValue = "e" + resourcePolicy.getEPerson().getID(); + + } + document.addField("submit", fieldValue); + context.uncacheEntity(resourcePolicy); + } + } catch (SQLException e) { + log.error(LogManager.getHeader(context, "Error while indexing resource policies", + "Collection: (id " + col.getID() + " type " + col.getName() + ")" )); + } + } + } + } + +} \ No newline at end of file diff --git a/dspace/config/spring/api/discovery.xml b/dspace/config/spring/api/discovery.xml index 2ebeb80cc4..803d1cad81 100644 --- a/dspace/config/spring/api/discovery.xml +++ b/dspace/config/spring/api/discovery.xml @@ -30,6 +30,7 @@ + diff --git a/dspace/solr/search/conf/schema.xml b/dspace/solr/search/conf/schema.xml index cf7dbc43dc..60920eb5ee 100644 --- a/dspace/solr/search/conf/schema.xml +++ b/dspace/solr/search/conf/schema.xml @@ -259,6 +259,8 @@ + + From 5139bb881d466cb989f6bebd163d3ef5df202f4e Mon Sep 17 00:00:00 2001 From: Mykhaylo Date: Fri, 22 May 2020 22:41:56 +0200 Subject: [PATCH 062/125] updated findAuthorizedByCommunity and findAuthorized with Solr query --- .../repository/CollectionRestRepository.java | 73 +++++++++++++++++-- 1 file changed, 66 insertions(+), 7 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java index 934a4fc698..85ca45d224 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java @@ -11,6 +11,7 @@ import java.io.IOException; import java.sql.SQLException; import java.util.LinkedList; import java.util.List; +import java.util.Set; import java.util.SortedMap; import java.util.UUID; import javax.servlet.ServletInputStream; @@ -20,6 +21,7 @@ import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; import org.apache.commons.lang3.StringUtils; import org.apache.logging.log4j.Logger; +import org.apache.solr.client.solrj.util.ClientUtils; import org.dspace.app.rest.Parameter; import org.dspace.app.rest.SearchRestMethod; import org.dspace.app.rest.exception.DSpaceBadRequestException; @@ -54,6 +56,7 @@ import org.dspace.discovery.IndexableObject; import org.dspace.discovery.SearchService; import org.dspace.discovery.SearchServiceException; import org.dspace.discovery.indexobject.IndexableCollection; +import org.dspace.eperson.EPerson; import org.dspace.eperson.Group; import org.dspace.eperson.service.GroupService; import org.dspace.workflow.WorkflowException; @@ -165,7 +168,8 @@ public class CollectionRestRepository extends DSpaceObjectRestRepository findAuthorizedByCommunity( - @Parameter(value = "uuid", required = true) UUID communityUuid, Pageable pageable) { + @Parameter(value = "uuid", required = true) UUID communityUuid, Pageable pageable, + @Parameter(value = "query") String q) { try { Context context = obtainContext(); Community com = communityService.find(context, communityUuid); @@ -174,19 +178,74 @@ public class CollectionRestRepository extends DSpaceObjectRestRepository collections = cs.findAuthorized(context, com, Constants.ADD); - return converter.toRestPage(utils.getPage(collections, pageable), utils.obtainProjection()); - } catch (SQLException e) { + List collections = new LinkedList(); + DiscoverResult resp = discoverAuthorizedCollections(pageable, q, context, com); + long tot = resp.getTotalSearchResults(); + for (IndexableObject solrCollections : resp.getIndexableObjects()) { + Collection c = ((IndexableCollection) solrCollections).getIndexedObject(); + collections.add(c); + } + return converter.toRestPage(collections, pageable, tot , utils.obtainProjection()); + } catch (SQLException | SearchServiceException e) { throw new RuntimeException(e.getMessage(), e); } } + private DiscoverResult discoverAuthorizedCollections(Pageable pageable, String q, Context context, Community com) + throws SQLException, SearchServiceException { + StringBuilder query = new StringBuilder(); + DiscoverQuery discoverQuery = new DiscoverQuery(); + discoverQuery.setDSpaceObjectFilter(IndexableCollection.TYPE); + discoverQuery.setStart(Math.toIntExact(pageable.getOffset())); + discoverQuery.setMaxResults(pageable.getPageSize()); + if (!authorizeService.isAdmin(context)) { + if (q == null) { + Group anonymousGroup = groupService.findByName(context, Group.ANONYMOUS); + String anonGroupId = ""; + if (anonymousGroup != null) { + anonGroupId = anonymousGroup.getID().toString(); + } + query.append("submit:(g").append(anonGroupId); + EPerson currentUser = context.getCurrentUser(); + if (currentUser != null) { + query.append(" OR e").append(currentUser.getID()); + } + Set groups = groupService.allMemberGroupsSet(context, currentUser); + for (Group group : groups) { + query.append(" OR g").append(group.getID()); + } + query.append(")"); + } else { + query.append(q); + } + discoverQuery.addFilterQueries(query.toString()); + } + if (com != null) { + discoverQuery.addFilterQueries("location.comm:" + com.getID().toString()); + } + if (StringUtils.isNotBlank(q)) { + StringBuilder buildQuery = new StringBuilder(); + String cleanQuery = ClientUtils.escapeQueryChars(q); + buildQuery.append(cleanQuery).append(" OR ").append(cleanQuery).append("*"); + discoverQuery.setQuery(buildQuery.toString()); + } + DiscoverResult resp = searchService.search(context, discoverQuery); + return resp; + } + @SearchRestMethod(name = "findAuthorized") - public Page findAuthorized(Pageable pageable) { + public Page findAuthorized(@Parameter(value = "query") String q, + Pageable pageable) throws SearchServiceException { try { Context context = obtainContext(); - List collections = cs.findAuthorizedOptimized(context, Constants.ADD); - return converter.toRestPage(utils.getPage(collections, pageable), utils.obtainProjection()); + List collections = new LinkedList(); + DiscoverResult resp = discoverAuthorizedCollections(pageable, q, context, null); + long tot = resp.getTotalSearchResults(); + for (IndexableObject solrCollections : resp.getIndexableObjects()) { + Collection c = ((IndexableCollection) solrCollections).getIndexedObject(); + collections.add(c); + } + return converter.toRestPage(collections, pageable, tot , utils.obtainProjection()); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); } From 22a34ff3683460704dfc1512247fd37f2afe975a Mon Sep 17 00:00:00 2001 From: Mykhaylo Date: Mon, 25 May 2020 14:36:04 +0200 Subject: [PATCH 063/125] added ITs for methods findAuthorizedByCommunity and findAuthorized --- .../repository/CollectionRestRepository.java | 36 ++- .../app/rest/CollectionRestRepositoryIT.java | 264 ++++++++++++++++++ 2 files changed, 280 insertions(+), 20 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java index 85ca45d224..c08bc69ca7 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java @@ -198,26 +198,22 @@ public class CollectionRestRepository extends DSpaceObjectRestRepository groups = groupService.allMemberGroupsSet(context, currentUser); - for (Group group : groups) { - query.append(" OR g").append(group.getID()); - } - query.append(")"); - } else { - query.append(q); + Group anonymousGroup = groupService.findByName(context, Group.ANONYMOUS); + String anonGroupId = ""; + if (anonymousGroup != null) { + anonGroupId = anonymousGroup.getID().toString(); } + query.append("submit:(g").append(anonGroupId); + if (currentUser != null) { + query.append(" OR e").append(currentUser.getID()); + } + Set groups = groupService.allMemberGroupsSet(context, currentUser); + for (Group group : groups) { + query.append(" OR g").append(group.getID()); + } + query.append(")"); discoverQuery.addFilterQueries(query.toString()); } if (com != null) { @@ -225,8 +221,8 @@ public class CollectionRestRepository extends DSpaceObjectRestRepository Date: Wed, 27 May 2020 10:41:28 +0200 Subject: [PATCH 064/125] [Task 71143] initial implementation of the preauthorize annotations in the converterservice --- .../app/rest/converter/ConverterService.java | 76 +++++++++++++++++-- .../ExternalSourceHalLinkFactory.java | 1 - .../rest/repository/ItemRestRepository.java | 1 - 3 files changed, 71 insertions(+), 7 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java index 59ee666cfe..26eae66e65 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java @@ -7,8 +7,10 @@ */ package org.dspace.app.rest.converter; +import java.lang.annotation.Annotation; import java.lang.reflect.Constructor; import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; import java.util.HashMap; import java.util.LinkedList; import java.util.List; @@ -17,6 +19,7 @@ import java.util.Set; import javax.annotation.Nullable; import javax.annotation.PostConstruct; +import org.apache.commons.lang3.StringUtils; import org.apache.log4j.Logger; import org.dspace.app.rest.link.HalLinkFactory; import org.dspace.app.rest.link.HalLinkService; @@ -26,17 +29,20 @@ import org.dspace.app.rest.model.RestModel; import org.dspace.app.rest.model.hateoas.HALResource; import org.dspace.app.rest.projection.DefaultProjection; import org.dspace.app.rest.projection.Projection; +import org.dspace.app.rest.repository.DSpaceRestRepository; import org.dspace.app.rest.security.DSpacePermissionEvaluator; import org.dspace.app.rest.utils.Utils; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.config.BeanDefinition; import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider; +import org.springframework.core.annotation.AnnotationUtils; import org.springframework.core.type.filter.AssignableTypeFilter; import org.springframework.data.domain.Page; import org.springframework.data.domain.PageImpl; import org.springframework.data.domain.Pageable; import org.springframework.hateoas.EntityModel; import org.springframework.hateoas.Link; +import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.security.core.context.SecurityContextHolder; import org.springframework.stereotype.Component; import org.springframework.stereotype.Service; @@ -94,11 +100,19 @@ public class ConverterService { DSpaceConverter converter = requireConverter(modelObject.getClass()); R restObject = converter.convert(transformedModel, projection); if (restObject instanceof BaseObjectRest) { - if (!dSpacePermissionEvaluator.hasPermission(SecurityContextHolder.getContext().getAuthentication(), - restObject, "READ")) { - log.debug("Access denied on " + restObject.getClass() + " with id: " + - ((BaseObjectRest) restObject).getId()); - return null; + String permission = getPermissionForRestObject((BaseObjectRest) restObject); + if (!StringUtils.equalsIgnoreCase(permission, "permitAll")) { + if (StringUtils.equalsIgnoreCase(permission, "admin")) { + //TODO + } else if (StringUtils.equalsIgnoreCase(permission, "authenticated")) { + //TODO + } else { + if (!dSpacePermissionEvaluator.hasPermission(SecurityContextHolder.getContext().getAuthentication(), + restObject, permission)) { + log.info("Access denied on " + restObject.getClass()); + return null; + } + } } } if (restObject instanceof RestModel) { @@ -107,6 +121,58 @@ public class ConverterService { return restObject; } + private String getPermissionForRestObject(BaseObjectRest restObject) { + Annotation preAuthorize = getAnnotationForRestObject(restObject); + if (preAuthorize == null) { + preAuthorize = getDefaultFindOnePreAuthorize(); + + } + String permission = "READ"; + permission = parseAnnotation(preAuthorize); + return permission; + } + + private String parseAnnotation(Annotation preAuthorize) { + String permission = ""; + if (preAuthorize != null) { + String annotationValue = (String) AnnotationUtils.getValue(preAuthorize); + if (StringUtils.contains(annotationValue, "permitAll")) { + permission = "permitAll"; + } else if (StringUtils.contains(annotationValue, "hasAuthority")) { + permission = StringUtils.substringBetween(annotationValue, "hasAuthority('", "')"); + } else if (StringUtils.contains(annotationValue,"hasPermission")) { + permission = StringUtils.split(annotationValue, ",")[2]; + permission = StringUtils.substringBetween(permission, "'"); + } + } + return permission; + } + + private Annotation getAnnotationForRestObject(BaseObjectRest restObject) { + BaseObjectRest baseObjectRest = restObject; + DSpaceRestRepository repositoryToUse = utils + .getResourceRepositoryByCategoryAndModel(baseObjectRest.getCategory(), baseObjectRest.getType()); + Annotation preAuthorize = null; + for (Method m : repositoryToUse.getClass().getMethods()) { + if (StringUtils.equalsIgnoreCase(m.getName(), "findOne")) { + preAuthorize = AnnotationUtils.findAnnotation(m, PreAuthorize.class); + } + } + return preAuthorize; + } + + private Annotation getDefaultFindOnePreAuthorize() { + for (Method m : DSpaceRestRepository.class.getMethods()) { + if (StringUtils.equalsIgnoreCase(m.getName(), "findOne")) { + Annotation annotation = AnnotationUtils.findAnnotation(m, PreAuthorize.class); + if (annotation != null) { + return annotation; + } + } + } + return null; + } + /** * Converts a list of model objects to a page of rest objects using the given {@link Projection}. * diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/externalsources/ExternalSourceHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/externalsources/ExternalSourceHalLinkFactory.java index e192c95404..7931593a31 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/externalsources/ExternalSourceHalLinkFactory.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/externalsources/ExternalSourceHalLinkFactory.java @@ -26,7 +26,6 @@ public class ExternalSourceHalLinkFactory extends @Override protected void addLinks(ExternalSourceResource halResource, Pageable pageable, LinkedList list) throws Exception { - list.add(buildLink("entries", getMethodOn() .getExternalSourceEntries(halResource.getContent().getName(), "", null, null, null))); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemRestRepository.java index c6643496ae..a3128e0afe 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemRestRepository.java @@ -99,7 +99,6 @@ public class ItemRestRepository extends DSpaceObjectRestRepository Date: Wed, 27 May 2020 10:43:31 +0200 Subject: [PATCH 065/125] undo unnecessary changes --- .../rest/link/externalsources/ExternalSourceHalLinkFactory.java | 1 + .../java/org/dspace/app/rest/repository/ItemRestRepository.java | 1 + 2 files changed, 2 insertions(+) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/externalsources/ExternalSourceHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/externalsources/ExternalSourceHalLinkFactory.java index 7931593a31..e192c95404 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/externalsources/ExternalSourceHalLinkFactory.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/externalsources/ExternalSourceHalLinkFactory.java @@ -26,6 +26,7 @@ public class ExternalSourceHalLinkFactory extends @Override protected void addLinks(ExternalSourceResource halResource, Pageable pageable, LinkedList list) throws Exception { + list.add(buildLink("entries", getMethodOn() .getExternalSourceEntries(halResource.getContent().getName(), "", null, null, null))); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemRestRepository.java index a3128e0afe..49b468e298 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemRestRepository.java @@ -99,6 +99,7 @@ public class ItemRestRepository extends DSpaceObjectRestRepository Date: Wed, 27 May 2020 11:21:08 +0200 Subject: [PATCH 066/125] added implementations for support for Collection/Community role-based groups for Community/Collection Admins --- .../org/dspace/app/util/AuthorizeUtil.java | 34 +++++++++++++++++++ .../authorize/AuthorizeServiceImpl.java | 6 ++++ .../authorize/service/AuthorizeService.java | 20 +++++++++++ .../repository/EPersonRestRepository.java | 2 +- .../rest/repository/GroupRestRepository.java | 2 +- .../EPersonRestAuthenticationProvider.java | 10 ++++++ .../EPersonRestPermissionEvaluatorPlugin.java | 11 ++++-- .../GroupRestPermissionEvaluatorPlugin.java | 16 ++++++++- 8 files changed, 95 insertions(+), 6 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/app/util/AuthorizeUtil.java b/dspace-api/src/main/java/org/dspace/app/util/AuthorizeUtil.java index 39fb713970..6b5d7f9003 100644 --- a/dspace-api/src/main/java/org/dspace/app/util/AuthorizeUtil.java +++ b/dspace-api/src/main/java/org/dspace/app/util/AuthorizeUtil.java @@ -601,4 +601,38 @@ public class AuthorizeUtil { throw new AuthorizeException("not authorized to manage this group"); } + + /** + * This method checks if the community Admin can manage accounts + * + * @return true if is able + */ + public static boolean canCommunityAdminManageAccounts() { + boolean isAble = false; + if (AuthorizeConfiguration.canCommunityAdminManagePolicies() + || AuthorizeConfiguration.canCommunityAdminManageAdminGroup() + || AuthorizeConfiguration.canCommunityAdminManageCollectionPolicies() + || AuthorizeConfiguration.canCommunityAdminManageCollectionSubmitters() + || AuthorizeConfiguration.canCommunityAdminManageCollectionWorkflows() + || AuthorizeConfiguration.canCommunityAdminManageCollectionAdminGroup()) { + isAble = true; + } + return isAble; + } + + /** + * This method checks if the Collection Admin can manage accounts + * + * @return true if is able + */ + public static boolean canCollectionAdminManageAccounts() { + boolean isAble = false; + if (AuthorizeConfiguration.canCollectionAdminManagePolicies() + || AuthorizeConfiguration.canCollectionAdminManageSubmitters() + || AuthorizeConfiguration.canCollectionAdminManageWorkflows() + || AuthorizeConfiguration.canCollectionAdminManageAdminGroup()) { + isAble = true; + } + return isAble; + } } diff --git a/dspace-api/src/main/java/org/dspace/authorize/AuthorizeServiceImpl.java b/dspace-api/src/main/java/org/dspace/authorize/AuthorizeServiceImpl.java index 2384a260da..2ebecf2005 100644 --- a/dspace-api/src/main/java/org/dspace/authorize/AuthorizeServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/authorize/AuthorizeServiceImpl.java @@ -430,7 +430,10 @@ public class AuthorizeServiceImpl implements AuthorizeService { public boolean isCommunityAdmin(Context c) throws SQLException { EPerson e = c.getCurrentUser(); + return isCommunityAdmin(c, e); + } + public boolean isCommunityAdmin(Context c, EPerson e) throws SQLException { if (e != null) { List policies = resourcePolicyService.find(c, e, groupService.allMemberGroups(c, e), @@ -446,7 +449,10 @@ public class AuthorizeServiceImpl implements AuthorizeService { public boolean isCollectionAdmin(Context c) throws SQLException { EPerson e = c.getCurrentUser(); + return isCollectionAdmin(c, e); + } + public boolean isCollectionAdmin(Context c, EPerson e) throws SQLException { if (e != null) { List policies = resourcePolicyService.find(c, e, groupService.allMemberGroups(c, e), diff --git a/dspace-api/src/main/java/org/dspace/authorize/service/AuthorizeService.java b/dspace-api/src/main/java/org/dspace/authorize/service/AuthorizeService.java index 9e739e2585..f3ede72ac1 100644 --- a/dspace-api/src/main/java/org/dspace/authorize/service/AuthorizeService.java +++ b/dspace-api/src/main/java/org/dspace/authorize/service/AuthorizeService.java @@ -213,6 +213,26 @@ public interface AuthorizeService { public boolean isCollectionAdmin(Context c) throws SQLException; + /** + * Check to see if a specific user is Community admin + * + * @param c current context + * @param e the user to check + * @return true if user is an admin of some community + * @throws SQLException + */ + public boolean isCommunityAdmin(Context c, EPerson e) throws SQLException; + + /** + * Check to see if a specific user is Collection admin + * + * @param c current context + * @param e the user to check + * @return true if user is an admin of some collection + * @throws SQLException if database error + */ + public boolean isCollectionAdmin(Context c, EPerson e) throws SQLException; + /////////////////////////////////////////////// // policy manipulation methods /////////////////////////////////////////////// diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonRestRepository.java index 073d1b25bd..aed31fd6ce 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonRestRepository.java @@ -147,7 +147,7 @@ public class EPersonRestRepository extends DSpaceObjectRestRepository findByMetadata(@Parameter(value = "query", required = true) String query, Pageable pageable) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupRestRepository.java index 8310533597..f150ec0f3c 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupRestRepository.java @@ -131,7 +131,7 @@ public class GroupRestRepository extends DSpaceObjectRestRepository findByMetadata(@Parameter(value = "query", required = true) String query, Pageable pageable) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EPersonRestAuthenticationProvider.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EPersonRestAuthenticationProvider.java index 7cfd451045..576c7e7e7d 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EPersonRestAuthenticationProvider.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EPersonRestAuthenticationProvider.java @@ -18,6 +18,7 @@ import javax.servlet.http.HttpServletRequest; import org.apache.commons.lang3.StringUtils; import org.dspace.app.rest.utils.ContextUtil; +import org.dspace.app.util.AuthorizeUtil; import org.dspace.authenticate.AuthenticationMethod; import org.dspace.authenticate.service.AuthenticationService; import org.dspace.authorize.service.AuthorizeService; @@ -47,6 +48,8 @@ public class EPersonRestAuthenticationProvider implements AuthenticationProvider private static final Logger log = LoggerFactory.getLogger(EPersonRestAuthenticationProvider.class); + public static final String ACCOUNT_ADMIN_GRANT = "ACCOUNT_ADMIN"; + @Autowired private AuthenticationService authenticationService; @@ -140,14 +143,21 @@ public class EPersonRestAuthenticationProvider implements AuthenticationProvider if (eperson != null) { boolean isAdmin = false; + boolean isCommunityAdmin = false; + boolean isColectionAdmin = false; try { isAdmin = authorizeService.isAdmin(context, eperson); + isCommunityAdmin = authorizeService.isCommunityAdmin(context, eperson); + isColectionAdmin = authorizeService.isCollectionAdmin(context, eperson); } catch (SQLException e) { log.error("SQL error while checking for admin rights", e); } if (isAdmin) { authorities.add(new SimpleGrantedAuthority(ADMIN_GRANT)); + } else if ((isCommunityAdmin && AuthorizeUtil.canCommunityAdminManageAccounts()) + || (isColectionAdmin && AuthorizeUtil.canCollectionAdminManageAccounts())) { + authorities.add(new SimpleGrantedAuthority(ACCOUNT_ADMIN_GRANT)); } authorities.add(new SimpleGrantedAuthority(AUTHENTICATED_GRANT)); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EPersonRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EPersonRestPermissionEvaluatorPlugin.java index ca13277b04..00c2c60cb2 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EPersonRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EPersonRestPermissionEvaluatorPlugin.java @@ -17,6 +17,7 @@ import org.dspace.app.rest.model.patch.Patch; import org.dspace.app.rest.repository.patch.operation.DSpaceObjectMetadataPatchUtils; import org.dspace.app.rest.repository.patch.operation.EPersonPasswordReplaceOperation; import org.dspace.app.rest.utils.ContextUtil; +import org.dspace.app.util.AuthorizeUtil; import org.dspace.authorize.service.AuthorizeService; import org.dspace.core.Constants; import org.dspace.core.Context; @@ -74,9 +75,13 @@ public class EPersonRestPermissionEvaluatorPlugin extends RestObjectPermissionEv // anonymous user if (ePerson == null) { return false; - } - - if (dsoId.equals(ePerson.getID())) { + } else if (dsoId.equals(ePerson.getID())) { + return true; + } else if (authorizeService.isCommunityAdmin(context, ePerson) + && AuthorizeUtil.canCommunityAdminManageAccounts()) { + return true; + } else if (authorizeService.isCollectionAdmin(context, ePerson) + && AuthorizeUtil.canCollectionAdminManageAccounts()) { return true; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/GroupRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/GroupRestPermissionEvaluatorPlugin.java index 91cc302aa1..7f793c3b8d 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/GroupRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/GroupRestPermissionEvaluatorPlugin.java @@ -12,6 +12,8 @@ import java.sql.SQLException; import java.util.UUID; import org.dspace.app.rest.utils.ContextUtil; +import org.dspace.app.util.AuthorizeUtil; +import org.dspace.authorize.service.AuthorizeService; import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.eperson.EPerson; @@ -44,6 +46,9 @@ public class GroupRestPermissionEvaluatorPlugin extends RestObjectPermissionEval @Autowired private EPersonService ePersonService; + @Autowired + AuthorizeService authorizeService; + @Override public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, DSpaceRestPermission permission) { @@ -64,7 +69,16 @@ public class GroupRestPermissionEvaluatorPlugin extends RestObjectPermissionEval Group group = groupService.find(context, dsoId); - if (groupService.isMember(context, ePerson, group)) { + // anonymous user + if (ePerson == null) { + return false; + } else if (groupService.isMember(context, ePerson, group)) { + return true; + } else if (authorizeService.isCommunityAdmin(context, ePerson) + && AuthorizeUtil.canCommunityAdminManageAccounts()) { + return true; + } else if (authorizeService.isCollectionAdmin(context, ePerson) + && AuthorizeUtil.canCollectionAdminManageAccounts()) { return true; } From 141284e7fab5d74fad0f200f61759b6f61031d9b Mon Sep 17 00:00:00 2001 From: Mykhaylo Date: Wed, 27 May 2020 11:25:01 +0200 Subject: [PATCH 067/125] added ITs for search method byMetadata by community admin and by collection admin --- .../app/rest/EPersonRestRepositoryIT.java | 167 ++++++++++++++++ .../app/rest/GroupRestRepositoryIT.java | 182 ++++++++++++++++++ 2 files changed, 349 insertions(+) diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/EPersonRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/EPersonRestRepositoryIT.java index 75bffd3828..9de5eabe94 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/EPersonRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/EPersonRestRepositoryIT.java @@ -25,6 +25,7 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers. import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; import java.util.ArrayList; +import java.util.LinkedList; import java.util.List; import java.util.UUID; import java.util.concurrent.atomic.AtomicReference; @@ -48,15 +49,20 @@ import org.dspace.app.rest.model.patch.ReplaceOperation; import org.dspace.app.rest.test.AbstractControllerIntegrationTest; import org.dspace.app.rest.test.MetadataPatchSuite; import org.dspace.content.Collection; +import org.dspace.content.Community; import org.dspace.content.Item; import org.dspace.eperson.EPerson; import org.dspace.eperson.Group; +import org.dspace.services.ConfigurationService; import org.hamcrest.Matchers; import org.junit.Test; +import org.springframework.beans.factory.annotation.Autowired; public class EPersonRestRepositoryIT extends AbstractControllerIntegrationTest { + @Autowired + private ConfigurationService configurationService; @Test public void createTest() throws Exception { @@ -1786,4 +1792,165 @@ public class EPersonRestRepositoryIT extends AbstractControllerIntegrationTest { ); } + + @Test + public void findByMetadataByCommAdminAndByColAdminTest() throws Exception { + context.turnOffAuthorisationSystem(); + + EPerson adminChild1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Oliver", "Rossi") + .withEmail("adminChild1@example.com") + .withPassword(password) + .build(); + EPerson adminCol1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("James", "Rossi") + .withEmail("adminCol1@example.com") + .withPassword(password) + .build(); + EPerson colSubmitter = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Carl", "Rossi") + .withEmail("colSubmitter@example.com") + .withPassword(password) + .build(); + + parentCommunity = CommunityBuilder.createCommunity(context) + .withName("Parent Community") + .withAdminGroup(eperson) + .build(); + Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) + .withName("Sub Community") + .withAdminGroup(adminChild1) + .build(); + + Collection col1 = CollectionBuilder.createCollection(context, child1) + .withName("Collection 1") + .withAdminGroup(adminCol1) + .withSubmitterGroup(colSubmitter) + .build(); + + context.restoreAuthSystemState(); + + String tokenAdminComm = getAuthToken(adminChild1.getEmail(), password); + String tokenAdminCol = getAuthToken(adminCol1.getEmail(), password); + String tokencolSubmitter = getAuthToken(colSubmitter.getEmail(), password); + + getClient(tokenAdminComm).perform(get("/api/eperson/epersons/search/byMetadata") + .param("query", "Rossi")) + .andExpect(status().isOk()) + .andExpect(content().contentType(contentType)) + .andExpect(jsonPath("$._embedded.epersons", Matchers.containsInAnyOrder( + EPersonMatcher.matchEPersonEntry(adminChild1), + EPersonMatcher.matchEPersonEntry(adminCol1), + EPersonMatcher.matchEPersonEntry(colSubmitter) + ))) + .andExpect(jsonPath("$.page.totalElements", is(3))); + + getClient(tokenAdminCol).perform(get("/api/eperson/epersons/search/byMetadata") + .param("query", "Rossi")) + .andExpect(status().isOk()) + .andExpect(content().contentType(contentType)) + .andExpect(jsonPath("$._embedded.epersons", Matchers.containsInAnyOrder( + EPersonMatcher.matchEPersonEntry(adminChild1), + EPersonMatcher.matchEPersonEntry(adminCol1), + EPersonMatcher.matchEPersonEntry(colSubmitter) + ))) + .andExpect(jsonPath("$.page.totalElements", is(3))); + + getClient(tokencolSubmitter).perform(get("/api/eperson/epersons/search/byMetadata") + .param("query", "Rossi")) + .andExpect(status().isForbidden()); + } + + @Test + public void findByMetadataByCommAdminAndByColAdminWithoutAuthorizationsTest() throws Exception { + context.turnOffAuthorisationSystem(); + + List confPropsCollectionAdmins = new LinkedList<>(); + confPropsCollectionAdmins.add("core.authorization.collection-admin.policies"); + confPropsCollectionAdmins.add("core.authorization.collection-admin.workflows"); + confPropsCollectionAdmins.add("core.authorization.collection-admin.submitters"); + confPropsCollectionAdmins.add("core.authorization.collection-admin.admin-group"); + + List confPropsCommunityAdmins = new LinkedList<>(); + confPropsCommunityAdmins.add("core.authorization.community-admin.policies"); + confPropsCommunityAdmins.add("core.authorization.community-admin.admin-group"); + confPropsCommunityAdmins.add("core.authorization.community-admin.collection.policies"); + confPropsCommunityAdmins.add("core.authorization.community-admin.collection.workflows"); + confPropsCommunityAdmins.add("core.authorization.community-admin.collection.submitters"); + confPropsCommunityAdmins.add("core.authorization.community-admin.collection.admin-group"); + + EPerson adminChild1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Oliver", "Rossi") + .withEmail("adminChild1@example.com") + .withPassword(password) + .build(); + EPerson adminCol = EPersonBuilder.createEPerson(context) + .withNameInMetadata("James", "Rossi") + .withEmail("adminCol1@example.com") + .withPassword(password) + .build(); + EPerson col1Submitter = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Carl", "Rossi") + .withEmail("col1Submitter@example.com") + .withPassword(password) + .build(); + + parentCommunity = CommunityBuilder.createCommunity(context) + .withName("Parent Community") + .withAdminGroup(eperson) + .build(); + Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) + .withName("Sub Community") + .withAdminGroup(adminChild1) + .build(); + + Collection col1 = CollectionBuilder.createCollection(context, child1) + .withName("Collection 1") + .withAdminGroup(adminCol) + .withSubmitterGroup(col1Submitter) + .build(); + + context.restoreAuthSystemState(); + + String tokenAdminCol = getAuthToken(adminCol.getEmail(), password); + String tokenAdminComm = getAuthToken(adminChild1.getEmail(), password); + + getClient(tokenAdminCol).perform(get("/api/eperson/epersons/search/byMetadata") + .param("query", "Rossi")) + .andExpect(status().isOk()) + .andExpect(content().contentType(contentType)) + .andExpect(jsonPath("$._embedded.epersons", Matchers.containsInAnyOrder( + EPersonMatcher.matchEPersonEntry(adminChild1), + EPersonMatcher.matchEPersonEntry(adminCol), + EPersonMatcher.matchEPersonEntry(col1Submitter) + ))) + .andExpect(jsonPath("$.page.totalElements", is(3))); + + for (String prop : confPropsCollectionAdmins) { + configurationService.setProperty(prop, false); + } + + getClient(tokenAdminCol).perform(get("/api/eperson/epersons/search/byMetadata") + .param("query", "Rossi")) + .andExpect(status().isForbidden()); + + getClient(tokenAdminComm).perform(get("/api/eperson/epersons/search/byMetadata") + .param("query", "Rossi")) + .andExpect(status().isOk()) + .andExpect(content().contentType(contentType)) + .andExpect(jsonPath("$._embedded.epersons", Matchers.containsInAnyOrder( + EPersonMatcher.matchEPersonEntry(adminChild1), + EPersonMatcher.matchEPersonEntry(adminCol), + EPersonMatcher.matchEPersonEntry(col1Submitter) + ))) + .andExpect(jsonPath("$.page.totalElements", is(3))); + + for (String prop : confPropsCommunityAdmins) { + configurationService.setProperty(prop, false); + } + + getClient(tokenAdminComm).perform(get("/api/eperson/epersons/search/byMetadata") + .param("query", "Rossi")) + .andExpect(status().isForbidden()); + } } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java index a1b2f9cf14..b142266d86 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java @@ -24,6 +24,7 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers. import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; import java.util.ArrayList; +import java.util.LinkedList; import java.util.List; import java.util.UUID; import java.util.concurrent.atomic.AtomicReference; @@ -54,6 +55,7 @@ import org.dspace.eperson.Group; import org.dspace.eperson.factory.EPersonServiceFactory; import org.dspace.eperson.service.EPersonService; import org.dspace.eperson.service.GroupService; +import org.dspace.services.ConfigurationService; import org.hamcrest.Matchers; import org.junit.Test; import org.springframework.beans.factory.annotation.Autowired; @@ -66,6 +68,8 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { @Autowired ResourcePolicyService resourcePolicyService; + @Autowired + private ConfigurationService configurationService; @Test public void createTest() @@ -1914,5 +1918,183 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { .andExpect(status().isOk()); } + @Test + public void findByMetadataByCommAdminAndByColAdminTest() throws Exception { + context.turnOffAuthorisationSystem(); + EPerson adminChild1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Oliver", "Rossi") + .withEmail("adminChild1@example.com") + .withPassword(password) + .build(); + EPerson adminCol1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("James", "Rossi") + .withEmail("adminCol1@example.com") + .withPassword(password) + .build(); + EPerson colSubmitter = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Carl", "Rossi") + .withEmail("colSubmitter@example.com") + .withPassword(password) + .build(); + + parentCommunity = CommunityBuilder.createCommunity(context) + .withName("Parent Community") + .build(); + Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) + .withName("Sub Community") + .withAdminGroup(adminChild1) + .build(); + + Collection col1 = CollectionBuilder.createCollection(context, child1) + .withName("Collection 1") + .withAdminGroup(adminCol1) + .withSubmitterGroup(colSubmitter) + .build(); + + Group group1 = GroupBuilder.createGroup(context) + .withName("Test group") + .build(); + + Group group2 = GroupBuilder.createGroup(context) + .withName("Test group 2") + .build(); + + Group group3 = GroupBuilder.createGroup(context) + .withName("Test group 3") + .build(); + + Group group4 = GroupBuilder.createGroup(context) + .withName("Test other group") + .build(); + + context.restoreAuthSystemState(); + + String tokenAdminComm = getAuthToken(adminChild1.getEmail(), password); + String tokenAdminCol = getAuthToken(adminCol1.getEmail(), password); + String tokenSubmitterCol = getAuthToken(colSubmitter.getEmail(), password); + + getClient(tokenAdminComm).perform(get("/api/eperson/groups/search/byMetadata") + .param("query", group1.getName())) + .andExpect(status().isOk()) + .andExpect(content().contentType(contentType)) + .andExpect(jsonPath("$._embedded.groups",Matchers.containsInAnyOrder( + GroupMatcher.matchGroupEntry(group1.getID(), group1.getName()), + GroupMatcher.matchGroupEntry(group2.getID(), group2.getName()), + GroupMatcher.matchGroupEntry(group3.getID(), group3.getName())))) + .andExpect(jsonPath("$.page.totalElements", is(3))); + + getClient(tokenAdminCol).perform(get("/api/eperson/groups/search/byMetadata") + .param("query", group1.getName())) + .andExpect(status().isOk()).andExpect(content().contentType(contentType)) + .andExpect(jsonPath("$._embedded.groups", Matchers.containsInAnyOrder( + GroupMatcher.matchGroupEntry(group1.getID(), group1.getName()), + GroupMatcher.matchGroupEntry(group2.getID(), group2.getName()), + GroupMatcher.matchGroupEntry(group3.getID(), group3.getName())))) + .andExpect(jsonPath("$.page.totalElements", is(3))); + + getClient(tokenSubmitterCol).perform(get("/api/eperson/groups/search/byMetadata") + .param("query", group1.getName())) + .andExpect(status().isForbidden()); + } + + @Test + public void findByMetadataByCommAdminAndByColAdminWithoutAuthorizationsTest() throws Exception { + context.turnOffAuthorisationSystem(); + + List confPropsCollectionAdmins = new LinkedList<>(); + confPropsCollectionAdmins.add("core.authorization.collection-admin.policies"); + confPropsCollectionAdmins.add("core.authorization.collection-admin.submitters"); + confPropsCollectionAdmins.add("core.authorization.collection-admin.workflows"); + confPropsCollectionAdmins.add("core.authorization.collection-admin.admin-group"); + + List confPropsCommunityAdmins = new LinkedList<>(); + confPropsCommunityAdmins.add("core.authorization.community-admin.policies"); + confPropsCommunityAdmins.add("core.authorization.community-admin.admin-group"); + confPropsCommunityAdmins.add("core.authorization.community-admin.collection.policies"); + confPropsCommunityAdmins.add("core.authorization.community-admin.collection.workflows"); + confPropsCommunityAdmins.add("core.authorization.community-admin.collection.submitters"); + confPropsCommunityAdmins.add("core.authorization.community-admin.collection.admin-group"); + + EPerson adminChild1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Oliver", "Rossi") + .withEmail("adminChild1@example.com") + .withPassword(password) + .build(); + EPerson adminCol1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("James", "Rossi") + .withEmail("adminCol1@example.com") + .withPassword(password) + .build(); + + parentCommunity = CommunityBuilder.createCommunity(context) + .withName("Parent Community") + .build(); + Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) + .withName("Sub Community") + .withAdminGroup(adminChild1) + .build(); + + Collection col1 = CollectionBuilder.createCollection(context, child1) + .withName("Collection 1") + .withAdminGroup(adminCol1) + .build(); + + Group group1 = GroupBuilder.createGroup(context) + .withName("Test group") + .build(); + + Group group2 = GroupBuilder.createGroup(context) + .withName("Test group 2") + .build(); + + Group group3 = GroupBuilder.createGroup(context) + .withName("Test group 3") + .build(); + + Group group4 = GroupBuilder.createGroup(context) + .withName("Test other group") + .build(); + + context.restoreAuthSystemState(); + + String tokenAdminCol = getAuthToken(adminCol1.getEmail(), password); + String tokenAdminComm = getAuthToken(adminChild1.getEmail(), password); + + getClient(tokenAdminCol).perform(get("/api/eperson/groups/search/byMetadata") + .param("query", group1.getName())) + .andExpect(status().isOk()) + .andExpect(content().contentType(contentType)) + .andExpect(jsonPath("$._embedded.groups",Matchers.containsInAnyOrder( + GroupMatcher.matchGroupEntry(group1.getID(), group1.getName()), + GroupMatcher.matchGroupEntry(group2.getID(), group2.getName()), + GroupMatcher.matchGroupEntry(group3.getID(), group3.getName())))) + .andExpect(jsonPath("$.page.totalElements", is(3))); + + for (String prop : confPropsCollectionAdmins) { + configurationService.setProperty(prop, false); + } + + getClient(tokenAdminCol).perform(get("/api/eperson/groups/search/byMetadata") + .param("query", group1.getName())) + .andExpect(status().isForbidden()); + + getClient(tokenAdminComm).perform(get("/api/eperson/groups/search/byMetadata") + .param("query", group1.getName())) + .andExpect(status().isOk()) + .andExpect(content().contentType(contentType)) + .andExpect(jsonPath("$._embedded.groups",Matchers.containsInAnyOrder( + GroupMatcher.matchGroupEntry(group1.getID(), group1.getName()), + GroupMatcher.matchGroupEntry(group2.getID(), group2.getName()), + GroupMatcher.matchGroupEntry(group3.getID(), group3.getName())))) + .andExpect(jsonPath("$.page.totalElements", is(3))); + + for (String prop : confPropsCommunityAdmins) { + configurationService.setProperty(prop, false); + } + + getClient(tokenAdminCol).perform(get("/api/eperson/groups/search/byMetadata") + .param("query", group1.getName())) + .andExpect(status().isForbidden()); + } } From ffce2e4299595055ba4d0d5e8b0d9e7719c02de8 Mon Sep 17 00:00:00 2001 From: Yana De Pauw Date: Wed, 27 May 2020 13:25:56 +0200 Subject: [PATCH 068/125] 70815: Angular feedback - add self link --- .../SubmissionCCLicenseSearchController.java | 17 +++-- .../SubmissionCCLicenseUrlConverter.java | 41 ++++++++++++ ...ionCCLicenseUrlResourceHalLinkFactory.java | 64 +++++++++++++++++++ .../rest/model/SubmissionCCLicenseRest.java | 2 +- .../model/SubmissionCCLicenseUrlRest.java | 52 +++++++++++++++ .../SubmissionCCLicenseUrlResource.java | 23 +++++++ ...SubmissionCCLicenseSearchControllerIT.java | 15 +++-- 7 files changed, 204 insertions(+), 10 deletions(-) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseUrlConverter.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/SubmissionCCLicenseUrlResourceHalLinkFactory.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseUrlRest.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/SubmissionCCLicenseUrlResource.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java index 26e52c8933..f47376757c 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java @@ -12,9 +12,11 @@ import java.util.Map; import javax.servlet.ServletRequest; import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.exception.DSpaceBadRequestException; -import org.dspace.app.rest.model.PlainTextValueRest; import org.dspace.app.rest.model.SubmissionCCLicenseRest; +import org.dspace.app.rest.model.SubmissionCCLicenseUrlRest; +import org.dspace.app.rest.model.hateoas.SubmissionCCLicenseUrlResource; import org.dspace.app.rest.utils.Utils; import org.dspace.license.service.CreativeCommonsService; import org.dspace.services.RequestService; @@ -39,16 +41,19 @@ public class SubmissionCCLicenseSearchController { @Autowired protected CreativeCommonsService creativeCommonsService; + @Autowired + protected ConverterService converter; + protected RequestService requestService = new DSpace().getRequestService(); /** * Retrieves the CC License URI based on the license ID and answers in the field questions, provided as parameters * to this request * - * @return the CC License URI as a string + * @return the CC License URI as a SubmissionCCLicenseUrlResource */ @RequestMapping(method = RequestMethod.GET) - public PlainTextValueRest findByRightsByQuestions() { + public SubmissionCCLicenseUrlResource findByRightsByQuestions() { ServletRequest servletRequest = requestService.getCurrentRequest() .getServletRequest(); Map requestParameterMap = servletRequest @@ -85,7 +90,9 @@ public class SubmissionCCLicenseSearchController { if (StringUtils.isBlank(licenseUri)) { throw new ResourceNotFoundException("No CC License URI could be found for ID: " + licenseId); } - PlainTextValueRest plainTextValueRest = new PlainTextValueRest(licenseUri); - return plainTextValueRest; + + SubmissionCCLicenseUrlRest submissionCCLicenseUrlRest = converter.toRest(licenseUri, utils.obtainProjection()); + return converter.toResource(submissionCCLicenseUrlRest); + } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseUrlConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseUrlConverter.java new file mode 100644 index 0000000000..5411ac306c --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseUrlConverter.java @@ -0,0 +1,41 @@ +/** + * 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.rest.converter; + +import org.dspace.app.rest.model.SubmissionCCLicenseUrlRest; +import org.dspace.app.rest.projection.Projection; +import org.springframework.stereotype.Component; + + +/** + * This converter is responsible for transforming a Submission CC License Url String to the REST + * representation SubmissionCCLicenseUrlRest and vice versa + */ +@Component +public class SubmissionCCLicenseUrlConverter implements DSpaceConverter { + + /** + * Convert a Submission CC License Url String to its REST representation + * @param modelObject - the CC License Url String to convert + * @param projection - the projection + * @return the corresponding SubmissionCCLicenseUrlRest object + */ + @Override + public SubmissionCCLicenseUrlRest convert(final String modelObject, final Projection projection) { + SubmissionCCLicenseUrlRest submissionCCLicenseUrlRest = new SubmissionCCLicenseUrlRest(); + submissionCCLicenseUrlRest.setUrl(modelObject); + + return submissionCCLicenseUrlRest; + } + + @Override + public Class getModelClass() { + return String.class; + } + +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/SubmissionCCLicenseUrlResourceHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/SubmissionCCLicenseUrlResourceHalLinkFactory.java new file mode 100644 index 0000000000..39911faad0 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/SubmissionCCLicenseUrlResourceHalLinkFactory.java @@ -0,0 +1,64 @@ +/** + * 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.rest.link.process; + +import java.util.LinkedList; +import java.util.Map; + +import org.dspace.app.rest.SubmissionCCLicenseSearchController; +import org.dspace.app.rest.link.HalLinkFactory; +import org.dspace.app.rest.model.hateoas.SubmissionCCLicenseUrlResource; +import org.dspace.services.RequestService; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.data.domain.Pageable; +import org.springframework.hateoas.Link; +import org.springframework.stereotype.Component; +import org.springframework.web.util.UriComponentsBuilder; + +/** + * This class will provide the SubmissionCCLicenseUrlResource with links + */ +@Component +public class SubmissionCCLicenseUrlResourceHalLinkFactory + extends HalLinkFactory { + + @Autowired + RequestService requestService; + + /** + * Add a self link based on the search parameters + * @param halResource - The halResource + * @param pageable - The page information + * @param list - The list of present links + * @throws Exception + */ + protected void addLinks(SubmissionCCLicenseUrlResource halResource, final Pageable pageable, + LinkedList list) + throws Exception { + + halResource.removeLinks(); + Map parameterMap = requestService.getCurrentRequest().getHttpServletRequest() + .getParameterMap(); + + UriComponentsBuilder uriComponentsBuilder = uriBuilder(getMethodOn().findByRightsByQuestions()); + for (String key : parameterMap.keySet()) { + uriComponentsBuilder.queryParam(key, parameterMap.get(key)); + } + + list.add(buildLink("self", uriComponentsBuilder.build().toUriString())); + } + + + protected Class getControllerClass() { + return SubmissionCCLicenseSearchController.class; + } + + protected Class getResourceClass() { + return SubmissionCCLicenseUrlResource.class; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseRest.java index 611d532039..23589d5a46 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseRest.java @@ -15,7 +15,7 @@ import org.dspace.app.rest.RestResourceController; /** * This class is the REST representation of the CCLicense model object and acts as a data object - * * for the SubmissionCCLicenseResource class. + * for the SubmissionCCLicenseResource class. * Refer to {@link org.dspace.license.CCLicense} for explanation of the properties */ public class SubmissionCCLicenseRest extends BaseObjectRest { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseUrlRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseUrlRest.java new file mode 100644 index 0000000000..14d430b228 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseUrlRest.java @@ -0,0 +1,52 @@ +/** + * 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.rest.model; + +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonProperty; +import org.dspace.app.rest.SubmissionCCLicenseSearchController; + +/** + * This class is the REST representation of the CCLicense URL String object and acts as a data object + * for the SubmissionCCLicenseUrlRest class. + */ +public class SubmissionCCLicenseUrlRest extends BaseObjectRest { + public static final String NAME = "submissioncclicenseUrl"; + + private String url; + + @JsonIgnore + @Override + public String getId() { + return id; + } + + public String getUrl() { + return url; + } + + public void setUrl(final String url) { + this.url = url; + } + + @Override + @JsonProperty(access = JsonProperty.Access.READ_ONLY) + public String getType() { + return NAME; + } + + public String getCategory() { + return SubmissionCCLicenseRest.CATEGORY; + } + + @Override + @JsonIgnore + public Class getController() { + return SubmissionCCLicenseSearchController.class; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/SubmissionCCLicenseUrlResource.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/SubmissionCCLicenseUrlResource.java new file mode 100644 index 0000000000..29ce7cf669 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/SubmissionCCLicenseUrlResource.java @@ -0,0 +1,23 @@ +/** + * 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.rest.model.hateoas; + +import org.dspace.app.rest.model.SubmissionCCLicenseUrlRest; +import org.dspace.app.rest.model.hateoas.annotations.RelNameDSpaceResource; +import org.dspace.app.rest.utils.Utils; + +/** + * SubmissionCCLicenseUrl HAL Resource. This resource adds the data from the REST object together with embedded objects + * and a set of links if applicable + */ +@RelNameDSpaceResource(SubmissionCCLicenseUrlRest.NAME) +public class SubmissionCCLicenseUrlResource extends DSpaceResource { + public SubmissionCCLicenseUrlResource(SubmissionCCLicenseUrlRest submissionCCLicenseUrlRest, Utils utils) { + super(submissionCCLicenseUrlRest, utils); + } +} diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java index 5c35bb5acf..30734c8cac 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java @@ -33,16 +33,23 @@ public class SubmissionCCLicenseSearchControllerIT extends AbstractControllerInt "/api/config/submissioncclicenses/search/rightsByQuestions?license=license2&answer_license2-field0" + "=license2-field0-enum1")) .andExpect(status().isOk()) - .andExpect(jsonPath("$.value", is("mock-license-uri"))) - .andExpect(jsonPath("$.type", is("plaintextvalue"))); + .andExpect(jsonPath("$.url", is("mock-license-uri"))) + .andExpect(jsonPath("$.type", is("submissioncclicenseUrl"))) + .andExpect(jsonPath("$._links.self.href", + is("http://localhost/api/config/submissioncclicenses/search/rightsByQuestions" + + "?license=license2" + + "&answer_license2-field0=license2-field0-enum1"))); } @Test public void searchRightsByQuestionsTestLicenseWithoutFields() throws Exception { getClient().perform(get("/api/config/submissioncclicenses/search/rightsByQuestions?license=license3")) .andExpect(status().isOk()) - .andExpect(jsonPath("$.value", is("mock-license-uri"))) - .andExpect(jsonPath("$.type", is("plaintextvalue"))); + .andExpect(jsonPath("$.url", is("mock-license-uri"))) + .andExpect(jsonPath("$.type", is("submissioncclicenseUrl"))) + .andExpect(jsonPath("$._links.self.href", + is("http://localhost/api/config/submissioncclicenses/search/rightsByQuestions" + + "?license=license3"))); } @Test From df01297539dd6dd0d8e81dacb96eb25b75c58a74 Mon Sep 17 00:00:00 2001 From: Kevin Van de Velde Date: Wed, 27 May 2020 17:11:52 +0200 Subject: [PATCH 069/125] Submission CC license: Adding overrides & removing unused class --- ...ionCCLicenseUrlResourceHalLinkFactory.java | 3 ++ .../app/rest/model/PlainTextValueRest.java | 36 ------------------- .../model/SubmissionCCLicenseUrlRest.java | 1 + 3 files changed, 4 insertions(+), 36 deletions(-) delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PlainTextValueRest.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/SubmissionCCLicenseUrlResourceHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/SubmissionCCLicenseUrlResourceHalLinkFactory.java index 39911faad0..cb44d68e73 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/SubmissionCCLicenseUrlResourceHalLinkFactory.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/SubmissionCCLicenseUrlResourceHalLinkFactory.java @@ -37,6 +37,7 @@ public class SubmissionCCLicenseUrlResourceHalLinkFactory * @param list - The list of present links * @throws Exception */ + @Override protected void addLinks(SubmissionCCLicenseUrlResource halResource, final Pageable pageable, LinkedList list) throws Exception { @@ -54,10 +55,12 @@ public class SubmissionCCLicenseUrlResourceHalLinkFactory } + @Override protected Class getControllerClass() { return SubmissionCCLicenseSearchController.class; } + @Override protected Class getResourceClass() { return SubmissionCCLicenseUrlResource.class; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PlainTextValueRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PlainTextValueRest.java deleted file mode 100644 index 6f02aa9286..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PlainTextValueRest.java +++ /dev/null @@ -1,36 +0,0 @@ -/** - * 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.rest.model; - -/** - * Rest object used to represent a plain text value - */ -public class PlainTextValueRest { - public static final String TYPE = "plaintextvalue"; - - private String value; - - public PlainTextValueRest() { - } - - public PlainTextValueRest(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - public void setValue(final String value) { - this.value = value; - } - - public String getType() { - return TYPE; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseUrlRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseUrlRest.java index 14d430b228..5a54a8078f 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseUrlRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseUrlRest.java @@ -40,6 +40,7 @@ public class SubmissionCCLicenseUrlRest extends BaseObjectRest { return NAME; } + @Override public String getCategory() { return SubmissionCCLicenseRest.CATEGORY; } From 6df58917b4d3011d9e458015e2b30bbfb6c929cb Mon Sep 17 00:00:00 2001 From: Mykhaylo Date: Wed, 27 May 2020 18:56:51 +0200 Subject: [PATCH 070/125] added ITs to prove that admins of community/collection can manage submitters --- .../app/rest/GroupRestRepositoryIT.java | 293 ++++++++++++++++++ 1 file changed, 293 insertions(+) diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java index b142266d86..7a415e2af0 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java @@ -2097,4 +2097,297 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { .param("query", group1.getName())) .andExpect(status().isForbidden()); } + + @Test + public void colAdminManageSubmitterGroupAndAdminGroupTest() throws Exception { + + GroupService groupService = EPersonServiceFactory.getInstance().getGroupService(); + + context.turnOffAuthorisationSystem(); + + EPerson adminChild1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Oliver", "Rossi") + .withEmail("adminChild1@example.com") + .withPassword(password) + .build(); + EPerson adminCol1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("James", "Rossi") + .withEmail("adminCol1@example.com") + .withPassword(password) + .build(); + EPerson submitter1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Carl", "Rossi") + .withEmail("submitter1@example.com") + .withPassword(password) + .build(); + EPerson submitter2 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Robert", "Clarks") + .withEmail("submitter2@example.com") + .withPassword(password) + .build(); + EPerson submitter3 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Jack", "Brown") + .withEmail("submitter3@example.com") + .withPassword(password) + .build(); + + parentCommunity = CommunityBuilder.createCommunity(context) + .withName("Parent Community") + .withAdminGroup(eperson) + .build(); + Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) + .withName("Sub Community") + .withAdminGroup(adminChild1) + .build(); + + Collection col1 = CollectionBuilder.createCollection(context, child1) + .withName("Collection 1") + .withAdminGroup(adminCol1) + .withSubmitterGroup(eperson) + .build(); + + Group groupSubmitters = col1.getSubmitters(); + Group groupAdmins = col1.getAdministrators(); + + context.restoreAuthSystemState(); + + String tokenAdminCol = getAuthToken(adminCol1.getEmail(), password); + + assertFalse(groupService.isMember(context, submitter1, groupSubmitters)); + + getClient(tokenAdminCol).perform(post("/api/eperson/groups/" + groupSubmitters.getID() + "/epersons") + .contentType(parseMediaType(TEXT_URI_LIST_VALUE)) + .content(REST_SERVER_URL + "eperson/groups/" + submitter1.getID() + "/\n" + + REST_SERVER_URL + "eperson/groups/" + submitter2.getID() + )) + .andExpect(status().isNoContent()); + + assertTrue(groupService.isMember(context, submitter1, groupSubmitters)); + assertTrue(groupService.isMember(context, submitter2, groupSubmitters)); + + assertFalse(groupService.isMember(context, submitter3, groupAdmins)); + + getClient(tokenAdminCol).perform( + post("/api/eperson/groups/" + groupAdmins.getID() + "/epersons") + .contentType(parseMediaType(TEXT_URI_LIST_VALUE)) + .content(REST_SERVER_URL + "eperson/groups/" + submitter3.getID() + )) + .andExpect(status().isNoContent()); + + assertTrue(groupService.isMember(context, submitter3, groupAdmins)); + } + + @Test + public void colAdminWithoutRightsTest() throws Exception { + + GroupService groupService = EPersonServiceFactory.getInstance().getGroupService(); + + context.turnOffAuthorisationSystem(); + + List confPropsCollectionAdmins = new LinkedList<>(); + confPropsCollectionAdmins.add("core.authorization.collection-admin.policies"); + confPropsCollectionAdmins.add("core.authorization.collection-admin.submitters"); + confPropsCollectionAdmins.add("core.authorization.collection-admin.workflows"); + confPropsCollectionAdmins.add("core.authorization.collection-admin.admin-group"); + + EPerson adminChild1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Oliver", "Rossi") + .withEmail("adminChild1@example.com") + .withPassword(password) + .build(); + EPerson adminCol1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("James", "Rossi") + .withEmail("adminCol1@example.com") + .withPassword(password) + .build(); + EPerson submitter1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Carl", "Rossi") + .withEmail("submitter1@example.com") + .withPassword(password) + .build(); + EPerson submitter2 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Robert", "Clarks") + .withEmail("submitter2@example.com") + .withPassword(password) + .build(); + EPerson submitter3 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Jack", "Brown") + .withEmail("submitter3@example.com") + .withPassword(password) + .build(); + + parentCommunity = CommunityBuilder.createCommunity(context) + .withName("Parent Community") + .withAdminGroup(eperson) + .build(); + Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) + .withName("Sub Community") + .withAdminGroup(adminChild1) + .build(); + + Collection col1 = CollectionBuilder.createCollection(context, child1) + .withName("Collection 1") + .withAdminGroup(adminCol1) + .withSubmitterGroup(submitter2) + .build(); + + Group groupSubmitters = col1.getSubmitters(); + + context.restoreAuthSystemState(); + + String tokenAdminCol = getAuthToken(adminCol1.getEmail(), password); + + assertFalse(groupService.isMember(context, submitter1, groupSubmitters)); + + getClient(tokenAdminCol).perform( + post("/api/eperson/groups/" + groupSubmitters.getID() + "/epersons") + .contentType(parseMediaType(TEXT_URI_LIST_VALUE)) + .content(REST_SERVER_URL + "eperson/groups/" + submitter1.getID() + )) + .andExpect(status().isNoContent()); + + assertTrue(groupService.isMember(context, submitter1, groupSubmitters)); + + for (String prop : confPropsCollectionAdmins) { + configurationService.setProperty(prop, false); + } + + assertFalse(groupService.isMember(context, submitter3, groupSubmitters)); + + getClient(tokenAdminCol).perform(post("/api/eperson/groups/" + groupSubmitters.getID() + "/epersons") + .contentType(parseMediaType(TEXT_URI_LIST_VALUE)) + .content(REST_SERVER_URL + "eperson/groups/" + submitter3.getID() + )) + .andExpect(status().isForbidden()); + + assertFalse(groupService.isMember(context, submitter3, groupSubmitters)); + } + + @Test + public void commAdminManageSubmitterGroupAndAdminGroupTest() throws Exception { + + GroupService groupService = EPersonServiceFactory.getInstance().getGroupService(); + + context.turnOffAuthorisationSystem(); + + EPerson adminChild1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Oliver", "Rossi") + .withEmail("adminChild1@example.com") + .withPassword(password) + .build(); + EPerson adminCol1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("James", "Rossi") + .withEmail("adminCol1@example.com") + .withPassword(password) + .build(); + EPerson submitter1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Carl", "Rossi") + .withEmail("submitter1@example.com") + .withPassword(password) + .build(); + EPerson submitter2 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Robert", "Clarks") + .withEmail("submitter2@example.com") + .withPassword(password) + .build(); + + parentCommunity = CommunityBuilder.createCommunity(context) + .withName("Parent Community") + .withAdminGroup(eperson) + .build(); + Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) + .withName("Sub Community") + .withAdminGroup(adminChild1) + .build(); + + Collection col1 = CollectionBuilder.createCollection(context, child1) + .withName("Collection 1") + .withAdminGroup(adminCol1) + .withSubmitterGroup(eperson) + .build(); + + Group groupSubmitters = col1.getSubmitters(); + + context.restoreAuthSystemState(); + + String tokenAdminComm = getAuthToken(adminChild1.getEmail(), password); + + assertFalse(groupService.isMember(context, submitter1, groupSubmitters)); + + getClient(tokenAdminComm).perform(post("/api/eperson/groups/" + groupSubmitters.getID() + "/epersons") + .contentType(parseMediaType(TEXT_URI_LIST_VALUE)) + .content(REST_SERVER_URL + "eperson/groups/" + submitter1.getID() + "/\n" + + REST_SERVER_URL + "eperson/groups/" + submitter2.getID() + )) + .andExpect(status().isNoContent()); + + assertTrue(groupService.isMember(context, submitter1, groupSubmitters)); + assertTrue(groupService.isMember(context, submitter2, groupSubmitters)); + + } + + @Test + public void commAdminDeleteColAdminFromAdminGroupTest() throws Exception { + + GroupService groupService = EPersonServiceFactory.getInstance().getGroupService(); + + context.turnOffAuthorisationSystem(); + + EPerson adminChild1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Oliver", "Rossi") + .withEmail("adminChild1@example.com") + .withPassword(password) + .build(); + EPerson adminCol1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("James", "Rossi") + .withEmail("adminCol1@example.com") + .withPassword(password) + .build(); + EPerson submitter1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Carl", "Rossi") + .withEmail("submitter1@example.com") + .withPassword(password) + .build(); + + parentCommunity = CommunityBuilder.createCommunity(context) + .withName("Parent Community") + .withAdminGroup(eperson) + .build(); + Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) + .withName("Sub Community") + .withAdminGroup(adminChild1) + .build(); + + Collection col1 = CollectionBuilder.createCollection(context, child1) + .withName("Collection 1") + .withAdminGroup(adminCol1) + .withSubmitterGroup(eperson) + .build(); + + Group groupAdministrators = col1.getAdministrators(); + Group groupSubmitters = col1.getSubmitters(); + + context.restoreAuthSystemState(); + + String tokenAdminComm = getAuthToken(adminChild1.getEmail(), password); + String tokenAdminCol = getAuthToken(adminCol1.getEmail(), password); + + assertTrue(groupService.isMember(context, adminCol1, groupAdministrators)); + + getClient(tokenAdminComm).perform(delete("/api/eperson/groups/" + + groupAdministrators.getID() + "/epersons/" + adminCol1.getID())) + .andExpect(status().isNoContent()); + + assertFalse(groupService.isMember(context, adminCol1, groupAdministrators)); + assertFalse(groupService.isMember(context, submitter1, groupSubmitters)); + + getClient(tokenAdminCol).perform(post("/api/eperson/groups/" + groupSubmitters.getID() + "/epersons") + .contentType(parseMediaType(TEXT_URI_LIST_VALUE)) + .content(REST_SERVER_URL + "eperson/groups/" + submitter1.getID() + )) + .andExpect(status().isForbidden()); + + assertFalse(groupService.isMember(context, submitter1, groupSubmitters)); + + } } From a7c8c2dbd6bf2006c3852385f046ec615956d52d Mon Sep 17 00:00:00 2001 From: Tim Donohue Date: Wed, 27 May 2020 16:32:39 -0500 Subject: [PATCH 071/125] Correct default port of dspace.ui.url to be 4000 --- .../java/org/dspace/app/rest/utils/ApplicationConfig.java | 4 ++-- .../org/dspace/app/rest/RootRestResourceControllerIT.java | 4 ++-- .../java/org/dspace/app/rest/ShibbolethRestControllerIT.java | 2 +- dspace/config/dspace.cfg | 2 +- dspace/config/local.cfg.EXAMPLE | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/ApplicationConfig.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/ApplicationConfig.java index 3fcdbe8133..305b282fce 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/ApplicationConfig.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/ApplicationConfig.java @@ -36,8 +36,8 @@ public class ApplicationConfig { @Value("${rest.cors.allow-credentials:true}") private boolean corsAllowCredentials; - // Configured User Interface URL (default: http://localhost:3000) - @Value("${dspace.ui.url:http://localhost:3000}") + // Configured User Interface URL (default: http://localhost:4000) + @Value("${dspace.ui.url:http://localhost:4000}") private String uiURL; /** diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/RootRestResourceControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/RootRestResourceControllerIT.java index 89ed50ec24..ad69790cbf 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/RootRestResourceControllerIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/RootRestResourceControllerIT.java @@ -33,7 +33,7 @@ public class RootRestResourceControllerIT extends AbstractControllerIntegrationT .andExpect(status().isOk()) //We expect the content type to be "application/hal+json;charset=UTF-8" .andExpect(content().contentType(contentType)) - .andExpect(jsonPath("$.dspaceURL", Matchers.is("http://localhost:3000"))) + .andExpect(jsonPath("$.dspaceURL", Matchers.is("http://localhost:4000"))) .andExpect(jsonPath("$.dspaceName", Matchers.is("DSpace at My University"))) .andExpect(jsonPath("$.dspaceRest", Matchers.is(BASE_REST_SERVER_URL))) .andExpect(jsonPath("$.type", Matchers.is("root"))); @@ -71,4 +71,4 @@ public class RootRestResourceControllerIT extends AbstractControllerIntegrationT ; } -} \ No newline at end of file +} diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ShibbolethRestControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ShibbolethRestControllerIT.java index a690e539ab..e13d091168 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ShibbolethRestControllerIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ShibbolethRestControllerIT.java @@ -27,7 +27,7 @@ public class ShibbolethRestControllerIT extends AbstractControllerIntegrationTes getClient(token).perform(get("/api/authn/shibboleth")) .andExpect(status().is3xxRedirection()) - .andExpect(redirectedUrl("http://localhost:3000")); + .andExpect(redirectedUrl("http://localhost:4000")); } @Test diff --git a/dspace/config/dspace.cfg b/dspace/config/dspace.cfg index 5090f5ea34..4311887f96 100644 --- a/dspace/config/dspace.cfg +++ b/dspace/config/dspace.cfg @@ -28,7 +28,7 @@ dspace.server.url = http://localhost:8080/server # URL of DSpace frontend (Angular UI). Include port number etc # This is used by the backend to provide links in emails, RSS feeds, Sitemaps, etc. -dspace.ui.url = http://localhost:3000 +dspace.ui.url = http://localhost:4000 # Name of the site dspace.name = DSpace at My University diff --git a/dspace/config/local.cfg.EXAMPLE b/dspace/config/local.cfg.EXAMPLE index 9754da9566..221d54daf4 100644 --- a/dspace/config/local.cfg.EXAMPLE +++ b/dspace/config/local.cfg.EXAMPLE @@ -38,7 +38,7 @@ dspace.server.url = http://localhost:8080/server # URL of DSpace frontend (Angular UI). Include port number etc # This is used by the backend to provide links in emails, RSS feeds, Sitemaps, etc. -dspace.ui.url = http://localhost:3000 +dspace.ui.url = http://localhost:4000 # Name of the site dspace.name = DSpace at My University From 43f0d30bd2be0936f79dfc5cb342e6c89cd2c413 Mon Sep 17 00:00:00 2001 From: Tim Donohue Date: Wed, 27 May 2020 16:36:48 -0500 Subject: [PATCH 072/125] Updates to Docker configuration for Angular CLI and port 4000 --- dspace/src/main/docker-compose/README.md | 2 +- dspace/src/main/docker-compose/docker-compose-angular.yml | 8 ++++---- .../{environment.dev.js => environment.dev.ts} | 4 +++- dspace/src/main/docker-compose/local.cfg | 1 + dspace/src/main/docker/local.cfg | 1 + 5 files changed, 10 insertions(+), 6 deletions(-) rename dspace/src/main/docker-compose/{environment.dev.js => environment.dev.ts} (76%) diff --git a/dspace/src/main/docker-compose/README.md b/dspace/src/main/docker-compose/README.md index 7f26cb7eab..9c92f627b6 100644 --- a/dspace/src/main/docker-compose/README.md +++ b/dspace/src/main/docker-compose/README.md @@ -18,7 +18,7 @@ - Sets the environment used across containers run with docker-compose - docker-compose-angular.yml - Docker compose file that will start a published DSpace angular container that interacts with the branch. -- environment.dev.js +- environment.dev.ts - Default angular environment when testing DSpace-angular from this repo ## To refresh / pull DSpace images from Dockerhub diff --git a/dspace/src/main/docker-compose/docker-compose-angular.yml b/dspace/src/main/docker-compose/docker-compose-angular.yml index d371ef4cc2..7eb78c5c07 100644 --- a/dspace/src/main/docker-compose/docker-compose-angular.yml +++ b/dspace/src/main/docker-compose/docker-compose-angular.yml @@ -17,17 +17,17 @@ services: environment: DSPACE_HOST: dspace-angular DSPACE_NAMESPACE: / - DSPACE_PORT: '3000' + DSPACE_PORT: '4000' DSPACE_SSL: "false" image: dspace/dspace-angular:latest networks: dspacenet: {} ports: - - published: 3000 - target: 3000 + - published: 4000 + target: 4000 - published: 9876 target: 9876 stdin_open: true tty: true volumes: - - ./dspace/src/main/docker-compose/environment.dev.js:/app/config/environment.dev.js + - ./dspace/src/main/docker-compose/environment.dev.ts:/app/src/environments/environment.dev.ts diff --git a/dspace/src/main/docker-compose/environment.dev.js b/dspace/src/main/docker-compose/environment.dev.ts similarity index 76% rename from dspace/src/main/docker-compose/environment.dev.js rename to dspace/src/main/docker-compose/environment.dev.ts index f88506012f..e8c88112fa 100644 --- a/dspace/src/main/docker-compose/environment.dev.js +++ b/dspace/src/main/docker-compose/environment.dev.ts @@ -5,7 +5,9 @@ * * http://www.dspace.org/license/ */ -module.exports = { +import { GlobalConfig } from '../src/config/global-config.interface'; + +export const environment: Partial = { rest: { ssl: false, host: 'localhost', diff --git a/dspace/src/main/docker-compose/local.cfg b/dspace/src/main/docker-compose/local.cfg index 70bc45c112..a511c25789 100644 --- a/dspace/src/main/docker-compose/local.cfg +++ b/dspace/src/main/docker-compose/local.cfg @@ -1,5 +1,6 @@ dspace.dir=/dspace db.url=jdbc:postgresql://dspacedb:5432/dspace dspace.server.url=http://localhost:8080/server +dspace.ui.url=http://localhost:4000 dspace.name=DSpace Started with Docker Compose solr.server=http://dspacesolr:8983/solr diff --git a/dspace/src/main/docker/local.cfg b/dspace/src/main/docker/local.cfg index 480e05372f..28a4f68734 100644 --- a/dspace/src/main/docker/local.cfg +++ b/dspace/src/main/docker/local.cfg @@ -5,4 +5,5 @@ dspace.dir = /dspace db.url = jdbc:postgresql://dspacedb:5432/dspace dspace.server.url=http://localhost:8080/server +dspace.ui.url=http://localhost:4000 solr.server=http://dspacesolr:8983/solr From bc7cf1484cff1925e77be34b712dfc97f5fecdbc Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Thu, 28 May 2020 09:41:58 +0200 Subject: [PATCH 073/125] Fixes after master merge --- .../repository/ProcessRestRepository.java | 14 +++ .../app/rest/ScriptRestRepositoryIT.java | 108 ++++++++++++------ 2 files changed, 88 insertions(+), 34 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java index 15d5cf6530..283c062b7a 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java @@ -7,6 +7,7 @@ */ package org.dspace.app.rest.repository; +import java.io.IOException; import java.sql.SQLException; import java.util.Collections; import java.util.List; @@ -14,6 +15,7 @@ import java.util.stream.Collectors; import org.apache.log4j.Logger; import org.dspace.app.rest.converter.ConverterService; +import org.dspace.app.rest.exception.RepositoryMethodNotImplementedException; import org.dspace.app.rest.model.BitstreamRest; import org.dspace.app.rest.model.ProcessFileWrapperRest; import org.dspace.app.rest.model.ProcessRest; @@ -167,6 +169,18 @@ public class ProcessRestRepository extends DSpaceRestRepository getDomainClass() { return ProcessRest.class; diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java index ada6950056..8d98eeff57 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java @@ -10,6 +10,7 @@ package org.dspace.app.rest; import static org.hamcrest.Matchers.containsInAnyOrder; import static org.hamcrest.Matchers.hasItem; import static org.hamcrest.Matchers.is; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.fileUpload; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; @@ -21,8 +22,10 @@ import java.sql.SQLException; import java.util.Arrays; import java.util.LinkedList; import java.util.List; +import java.util.Map; import java.util.stream.Collectors; +import com.fasterxml.jackson.databind.ObjectMapper; import com.google.gson.Gson; import org.apache.commons.collections4.CollectionUtils; import org.dspace.app.rest.builder.CollectionBuilder; @@ -50,6 +53,7 @@ import org.junit.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.MediaType; import org.springframework.mock.web.MockMultipartFile; +import org.springframework.test.web.servlet.MvcResult; public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { @@ -174,12 +178,22 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { String token = getAuthToken(admin.getEmail(), password); - getClient(token).perform(post("/api/system/scripts/mock-script/processes").contentType("multipart/form-data")) - .andExpect(status().isAccepted()) - .andExpect(jsonPath("$", is( - ProcessMatcher.matchProcess("mock-script", - String.valueOf(admin.getID()), new LinkedList<>(), - ProcessStatus.FAILED)))); + MvcResult mvcResult = getClient(token) + .perform(post("/api/system/scripts/mock-script/processes").contentType("multipart/form-data")) + .andExpect(status().isAccepted()) + .andExpect(jsonPath("$", is( + ProcessMatcher.matchProcess("mock-script", + String.valueOf(admin.getID()), new LinkedList<>(), + ProcessStatus.FAILED)))).andReturn(); + + ObjectMapper mapper = new ObjectMapper(); + + String content = mvcResult.getResponse().getContentAsString(); + Map map = mapper.readValue(content, Map.class); + Integer processId = Integer.valueOf(String.valueOf(map.get("processId"))); + + getClient(token).perform(delete("/api/system/processes/" + processId)); + } @Test @@ -207,14 +221,22 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { String token = getAuthToken(admin.getEmail(), password); - getClient(token).perform(post("/api/system/scripts/mock-script/processes").contentType("multipart/form-data") - .param("properties", - new Gson().toJson(list))) - .andExpect(status().isAccepted()) - .andExpect(jsonPath("$", is( - ProcessMatcher.matchProcess("mock-script", - String.valueOf(admin.getID()), parameters, - ProcessStatus.FAILED)))); + MvcResult mvcResult = getClient(token) + .perform(post("/api/system/scripts/mock-script/processes").contentType("multipart/form-data") + .param("properties", + new Gson().toJson(list))) + .andExpect(status().isAccepted()) + .andExpect(jsonPath("$", is( + ProcessMatcher.matchProcess("mock-script", + String.valueOf(admin.getID()), parameters, + ProcessStatus.FAILED)))).andReturn(); + ObjectMapper mapper = new ObjectMapper(); + + String content = mvcResult.getResponse().getContentAsString(); + Map map = mapper.readValue(content, Map.class); + Integer processId = Integer.valueOf(String.valueOf(map.get("processId"))); + + getClient(token).perform(delete("/api/system/processes/" + processId)); } @Test @@ -244,15 +266,24 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { ProcessStatus.RUNNING, ProcessStatus.COMPLETED)); - getClient(token).perform(post("/api/system/scripts/mock-script/processes").contentType("multipart/form-data") - .param("properties", - new Gson().toJson(list))) - .andExpect(status().isAccepted()) - .andExpect(jsonPath("$", is( - ProcessMatcher.matchProcess("mock-script", - String.valueOf(admin.getID()), - parameters, - acceptableProcessStatuses)))); + MvcResult mvcResult = getClient(token) + .perform(post("/api/system/scripts/mock-script/processes").contentType("multipart/form-data") + .param("properties", + new Gson().toJson(list))) + .andExpect(status().isAccepted()) + .andExpect(jsonPath("$", is( + ProcessMatcher.matchProcess("mock-script", + String.valueOf(admin.getID()), + parameters, + acceptableProcessStatuses)))).andReturn(); + + ObjectMapper mapper = new ObjectMapper(); + + String content = mvcResult.getResponse().getContentAsString(); + Map map = mapper.readValue(content, Map.class); + Integer processId = Integer.valueOf(String.valueOf(map.get("processId"))); + + getClient(token).perform(delete("/api/system/processes/" + processId)); } @@ -293,9 +324,9 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { String bitstreamContent = "Hello, World!"; MockMultipartFile bitstreamFile = new MockMultipartFile("file", - "hello.txt", MediaType.TEXT_PLAIN_VALUE, + "helloProcessFile.txt", MediaType.TEXT_PLAIN_VALUE, bitstreamContent.getBytes()); - parameters.add(new DSpaceCommandLineParameter("-f", "hello.txt")); + parameters.add(new DSpaceCommandLineParameter("-f", "helloProcessFile.txt")); List list = parameters.stream() .map(dSpaceCommandLineParameter -> dSpaceRunnableParameterConverter @@ -308,15 +339,24 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { ProcessStatus.RUNNING, ProcessStatus.COMPLETED)); - getClient(token).perform(fileUpload("/api/system/scripts/mock-script/processes").file(bitstreamFile) - .param("properties", - new Gson().toJson(list))) - .andExpect(status().isAccepted()) - .andExpect(jsonPath("$", is( - ProcessMatcher.matchProcess("mock-script", - String.valueOf(admin.getID()), - parameters, - acceptableProcessStatuses)))); + MvcResult mvcResult = getClient(token) + .perform(fileUpload("/api/system/scripts/mock-script/processes").file(bitstreamFile) + .param("properties", + new Gson().toJson(list))) + .andExpect(status().isAccepted()) + .andExpect(jsonPath("$", is( + ProcessMatcher.matchProcess("mock-script", + String.valueOf(admin.getID()), + parameters, + acceptableProcessStatuses)))).andReturn(); + + ObjectMapper mapper = new ObjectMapper(); + + String content = mvcResult.getResponse().getContentAsString(); + Map map = mapper.readValue(content, Map.class); + Integer processId = Integer.valueOf(String.valueOf(map.get("processId"))); + + getClient(token).perform(delete("/api/system/processes/" + processId)); } From 8045194cc38f637683405acae796a23b4f6107ef Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Thu, 28 May 2020 10:29:09 +0200 Subject: [PATCH 074/125] [Task 70911] applied feedback on the Process endpoints --- ...er.java => ProcessFilesRestController.java} | 11 +++++++---- .../link/process/ProcessHalLinkFactory.java | 4 ++-- .../process/ProcessResourceHalLinkFactory.java | 6 +++--- .../repository/ProcessFilesLinkRepository.java | 18 ++++++++++++++++++ 4 files changed, 30 insertions(+), 9 deletions(-) rename dspace-server-webapp/src/main/java/org/dspace/app/rest/{ProcessRestController.java => ProcessFilesRestController.java} (90%) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessRestController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessFilesRestController.java similarity index 90% rename from dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessRestController.java rename to dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessFilesRestController.java index edf79003b7..1029489e5d 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessRestController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessFilesRestController.java @@ -30,14 +30,15 @@ import org.springframework.data.web.PagedResourcesAssembler; import org.springframework.hateoas.Link; import org.springframework.hateoas.PagedModel; import org.springframework.hateoas.server.mvc.WebMvcLinkBuilder; +import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RestController; @RestController -@RequestMapping("/api/" + ProcessRest.CATEGORY + "/" + ProcessRest.PLURAL_NAME) -public class ProcessRestController { +@RequestMapping("/api/" + ProcessRest.CATEGORY + "/" + ProcessRest.PLURAL_NAME + "/{processId}/files") +public class ProcessFilesRestController { private static final Logger log = LogManager.getLogger(); @@ -53,7 +54,8 @@ public class ProcessRestController { @Autowired ProcessResourceHalLinkFactory processResourceHalLinkFactory; - @RequestMapping(method = RequestMethod.GET, value = "/{processId}/files/{fileType}") + @RequestMapping(method = RequestMethod.GET, value = "/{fileType}") + @PreAuthorize("hasAuthority('ADMIN')") public PagedModel listFilesWithTypeFromProcess( @PathVariable(name = "processId") Integer processId, @PathVariable(name = "fileType") String fileType, @@ -79,7 +81,8 @@ public class ProcessRestController { } - @RequestMapping(method = RequestMethod.GET, value = "/{processId}/files/name/{fileName:.+}") + @RequestMapping(method = RequestMethod.GET, value = "/name/{fileName:.+}") + @PreAuthorize("hasAuthority('ADMIN')") public BitstreamResource getBitstreamByName(@PathVariable(name = "processId") Integer processId, @PathVariable(name = "fileName") String fileName) throws SQLException, AuthorizeException { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessHalLinkFactory.java index aef3c81081..1ef52f6b1c 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessHalLinkFactory.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessHalLinkFactory.java @@ -7,7 +7,7 @@ */ package org.dspace.app.rest.link.process; -import org.dspace.app.rest.ProcessRestController; +import org.dspace.app.rest.ProcessFilesRestController; import org.dspace.app.rest.link.HalLinkFactory; /** @@ -15,5 +15,5 @@ import org.dspace.app.rest.link.HalLinkFactory; * and make it more easy to read or define which methods should be found in the getMethodOn methods when building links * @param This parameter should be of type {@link org.dspace.app.rest.model.hateoas.HALResource} */ -public abstract class ProcessHalLinkFactory extends HalLinkFactory { +public abstract class ProcessHalLinkFactory extends HalLinkFactory { } \ No newline at end of file diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java index fcf0945a96..1dc8058ac7 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java @@ -9,7 +9,7 @@ package org.dspace.app.rest.link.process; import java.util.LinkedList; -import org.dspace.app.rest.ProcessRestController; +import org.dspace.app.rest.ProcessFilesRestController; import org.dspace.app.rest.model.hateoas.ProcessResource; import org.dspace.services.ConfigurationService; import org.springframework.beans.factory.annotation.Autowired; @@ -35,8 +35,8 @@ public class ProcessResourceHalLinkFactory extends ProcessHalLinkFactory getControllerClass() { - return ProcessRestController.class; + protected Class getControllerClass() { + return ProcessFilesRestController.class; } @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java index 89d9d3531a..3a271ab060 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java @@ -17,14 +17,32 @@ import org.dspace.app.rest.projection.Projection; import org.dspace.authorize.AuthorizeException; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.domain.Pageable; +import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Component; +/** + * This is the {@link LinkRestRepository} implementation that takes care of retrieving the + * {@link ProcessFileWrapperRest} for the Process endpoints + * + */ @Component(ProcessRest.CATEGORY + "." + ProcessRest.NAME + "." + ProcessRest.FILES) public class ProcessFilesLinkRepository extends AbstractDSpaceRestRepository implements LinkRestRepository { @Autowired private ProcessRestRepository processRestRepository; + /** + * This method will retrieve all the files from the process and wrap them into a {@link ProcessFileWrapperRest} + * object to return + * @param request The current request + * @param processId The processId for the Process to use + * @param optionalPageable Pageable if applicable + * @param projection Projection if applicable + * @return A {@link ProcessFileWrapperRest} object filled with the bitstreams from the process + * @throws SQLException If something goes wrong + * @throws AuthorizeException If something goes wrong + */ + @PreAuthorize("hasAuthority('ADMIN')") public ProcessFileWrapperRest getFilesFromProcess(@Nullable HttpServletRequest request, Integer processId, @Nullable Pageable optionalPageable, From ce9ba1263b6ead1c3f337fac25d52e22785f5906 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Thu, 28 May 2020 11:40:01 +0200 Subject: [PATCH 075/125] Added more descriptive log to the ProcessRestRepository#delete method --- .../dspace/app/rest/repository/ProcessRestRepository.java | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java index 283c062b7a..72f350be34 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java @@ -174,10 +174,8 @@ public class ProcessRestRepository extends DSpaceRestRepository Date: Thu, 28 May 2020 15:30:52 +0200 Subject: [PATCH 076/125] [Task 70911] applied feedback to the MetadataExport and MetadataImport scripts as well as general Process functionality feedback --- .../dspace/app/bulkedit/MetadataExport.java | 18 ++- .../dspace/app/bulkedit/MetadataImport.java | 105 +++++++++--------- .../org/dspace/scripts/DSpaceRunnable.java | 2 + .../app/rest/ProcessFilesRestController.java | 4 +- .../repository/ProcessRestRepository.java | 3 +- 5 files changed, 65 insertions(+), 67 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java index b3e00bd99f..2e4f333820 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExport.java @@ -24,7 +24,6 @@ import org.dspace.utils.DSpace; */ public class MetadataExport extends DSpaceRunnable { - private Context context = null; private boolean help = false; private String filename = null; private String handle = null; @@ -40,13 +39,20 @@ public class MetadataExport extends DSpaceRunnable { - /** - * The Context - */ - Context c; /** * The DSpaceCSV object we're processing @@ -181,6 +177,35 @@ public class MetadataImport extends DSpaceRunnable runImport(boolean change, + public List runImport(Context c, boolean change, boolean useWorkflow, boolean workflowNotify, boolean useTemplate) @@ -371,7 +367,7 @@ public class MetadataImport extends DSpaceRunnable actualCollections = item.getCollections(); - compare(item, collections, actualCollections, whatHasChanged, change); + compare(c, item, collections, actualCollections, whatHasChanged, change); } // Iterate through each metadata element in the csv line @@ -422,7 +418,7 @@ public class MetadataImport extends DSpaceRunnablecsv for (int v = 0; v < fromCSV.length; v++) { String value = fromCSV[v]; - BulkEditMetadataValue dcv = getBulkEditValueFromCSV(language, schema, element, qualifier, value, + BulkEditMetadataValue dcv = getBulkEditValueFromCSV(c, language, schema, element, qualifier, value, fromAuthority); if (fromAuthority != null) { value = dcv.getValue() + csv.getAuthoritySeparator() + dcv.getAuthority() + csv @@ -957,7 +953,7 @@ public class MetadataImport extends DSpaceRunnable collections, List actualCollections, BulkEditChange bechange, @@ -1054,8 +1050,8 @@ public class MetadataImport extends DSpaceRunnable 0) { relTypeValue = relTypes.get(0).getValue(); originType = entityTypeService.findByEntityType(c, relTypeValue).getLabel(); - validateTypesByTypeByTypeName(targetType, originType, typeName, originRow); + validateTypesByTypeByTypeName(c, targetType, originType, typeName, originRow); } else { relationValidationErrors.add("Error on CSV row " + originRow + ":" + "\n" + "Cannot resolve Entity type for reference: " @@ -1749,7 +1745,8 @@ public class MetadataImport extends DSpaceRunnable implements R /** * Generic getter for the epersonIdentifier + * This EPerson identifier variable is the uuid of the eperson that's running the script * @return the epersonIdentifier value of this DSpaceRunnable */ public UUID getEpersonIdentifier() { @@ -144,6 +145,7 @@ public abstract class DSpaceRunnable implements R /** * Generic setter for the epersonIdentifier + * This EPerson identifier variable is the uuid of the eperson that's running the script * @param epersonIdentifier The epersonIdentifier to be set on this DSpaceRunnable */ public void setEpersonIdentifier(UUID epersonIdentifier) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessFilesRestController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessFilesRestController.java index 1029489e5d..d2f24928e1 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessFilesRestController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessFilesRestController.java @@ -55,7 +55,7 @@ public class ProcessFilesRestController { ProcessResourceHalLinkFactory processResourceHalLinkFactory; @RequestMapping(method = RequestMethod.GET, value = "/{fileType}") - @PreAuthorize("hasAuthority('ADMIN')") + @PreAuthorize("hasPermission(#processId, 'PROCESS', 'READ')") public PagedModel listFilesWithTypeFromProcess( @PathVariable(name = "processId") Integer processId, @PathVariable(name = "fileType") String fileType, @@ -82,7 +82,7 @@ public class ProcessFilesRestController { @RequestMapping(method = RequestMethod.GET, value = "/name/{fileName:.+}") - @PreAuthorize("hasAuthority('ADMIN')") + @PreAuthorize("hasPermission(#processId, 'PROCESS', 'READ')") public BitstreamResource getBitstreamByName(@PathVariable(name = "processId") Integer processId, @PathVariable(name = "fileName") String fileName) throws SQLException, AuthorizeException { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java index 72f350be34..f5fb6ab3ab 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java @@ -175,7 +175,8 @@ public class ProcessRestRepository extends DSpaceRestRepository Date: Thu, 28 May 2020 15:48:03 +0200 Subject: [PATCH 077/125] [Task 70911] added required parameter e check in the MetadataImport setup and cleanup --- .../main/java/org/dspace/app/bulkedit/MetadataImport.java | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java index 88f5d89e87..13a63bada9 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java @@ -163,7 +163,6 @@ public class MetadataImport extends DSpaceRunnable Date: Thu, 28 May 2020 19:07:50 +0200 Subject: [PATCH 078/125] added ITs to prove that admins of community/collection can manage their own groups --- .../org/dspace/app/util/AuthorizeUtil.java | 7 +- .../org/dspace/eperson/GroupServiceImpl.java | 19 + .../rest/CollectionGroupRestControllerIT.java | 39 -- .../app/rest/EPersonRestRepositoryIT.java | 44 +-- .../app/rest/GroupRestRepositoryIT.java | 335 +++++++++++++++--- 5 files changed, 340 insertions(+), 104 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/app/util/AuthorizeUtil.java b/dspace-api/src/main/java/org/dspace/app/util/AuthorizeUtil.java index 6b5d7f9003..ea1fb87ff4 100644 --- a/dspace-api/src/main/java/org/dspace/app/util/AuthorizeUtil.java +++ b/dspace-api/src/main/java/org/dspace/app/util/AuthorizeUtil.java @@ -590,8 +590,11 @@ public class AuthorizeUtil { authorizeManageAdminGroup(context, collection); return; } - - + // if we reach this point, it means that the group is related + // to a collection but as it is not the submitters, nor the administrators, + // nor a workflow groups it must be a default item/bitstream groups + authorizeManageDefaultReadGroup(context, collection); + return; } if (parentObject.getType() == Constants.COMMUNITY) { Community community = (Community) parentObject; diff --git a/dspace-api/src/main/java/org/dspace/eperson/GroupServiceImpl.java b/dspace-api/src/main/java/org/dspace/eperson/GroupServiceImpl.java index 7c23216458..449ddca973 100644 --- a/dspace-api/src/main/java/org/dspace/eperson/GroupServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/eperson/GroupServiceImpl.java @@ -23,7 +23,9 @@ import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.tuple.Pair; import org.dspace.authorize.AuthorizeConfiguration; import org.dspace.authorize.AuthorizeException; +import org.dspace.authorize.ResourcePolicy; import org.dspace.authorize.service.AuthorizeService; +import org.dspace.authorize.service.ResourcePolicyService; import org.dspace.content.Collection; import org.dspace.content.DSpaceObject; import org.dspace.content.DSpaceObjectServiceImpl; @@ -76,6 +78,8 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl implements @Autowired(required = true) protected AuthorizeService authorizeService; + @Autowired(required = true) + protected ResourcePolicyService resourcePolicyService; protected GroupServiceImpl() { super(); @@ -654,6 +658,21 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl implements return collectionService.getParentObject(context, collection); } } + } else { + if (AuthorizeConfiguration.canCollectionAdminManagePolicies()) { + List groups = new ArrayList(); + groups.add(group); + List policies = resourcePolicyService.find(context, null, groups, + Constants.DEFAULT_ITEM_READ, Constants.COLLECTION); + if (policies.size() > 0) { + return policies.get(0).getdSpaceObject(); + } + policies = resourcePolicyService.find(context, null, groups, + Constants.DEFAULT_BITSTREAM_READ, Constants.COLLECTION); + if (policies.size() > 0) { + return policies.get(0).getdSpaceObject(); + } + } } } if (AuthorizeConfiguration.canCommunityAdminManageAdminGroup()) { diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionGroupRestControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionGroupRestControllerIT.java index 58d5ff93ad..7464e9c38c 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionGroupRestControllerIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionGroupRestControllerIT.java @@ -35,7 +35,6 @@ import org.dspace.eperson.Group; import org.dspace.eperson.service.GroupService; import org.dspace.workflow.WorkflowService; import org.junit.Before; -import org.junit.Ignore; import org.junit.Test; import org.springframework.beans.factory.annotation.Autowired; @@ -971,11 +970,7 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati jsonPath("$", GroupMatcher.matchGroupEntry(role.getID(), role.getName()))); } - // Put on ignore because there's no support to identify read rights on a group for a user in a special - // com/coll admin group - // Please refer to: https://jira.lyrasis.org/browse/DS-4505 @Test - @Ignore public void getCollectionDefaultItemReadGroupTestParentCommunityAdmin() throws Exception { context.turnOffAuthorisationSystem(); String itemGroupString = "ITEM"; @@ -993,11 +988,7 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati jsonPath("$", GroupMatcher.matchGroupEntry(role.getID(), role.getName()))); } - // Put on ignore because there's no support to identify read rights on a group for a user in a special - // com/coll admin group - // Please refer to: https://jira.lyrasis.org/browse/DS-4505 @Test - @Ignore public void getCollectionDefaultItemReadGroupTestCollectionAdmin() throws Exception { context.turnOffAuthorisationSystem(); String itemGroupString = "ITEM"; @@ -1120,13 +1111,7 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati } - - - // Put on ignore because there's no support to identify read rights on a group for a user in a special - // com/coll admin group - // Please refer to: https://jira.lyrasis.org/browse/DS-4505 @Test - @Ignore public void postCollectionDefaultItemReadGroupCreateDefaultItemReadGroupSuccessParentCommunityAdmin() throws Exception { @@ -1161,12 +1146,7 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati } - - // Put on ignore because there's no support to identify read rights on a group for a user in a special - // com/coll admin group - // Please refer to: https://jira.lyrasis.org/browse/DS-4505 @Test - @Ignore public void postCollectionDefaultItemReadGroupCreateDefaultItemReadGroupSuccessCollectionAdmin() throws Exception { ObjectMapper mapper = new ObjectMapper(); @@ -1475,11 +1455,7 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati jsonPath("$", GroupMatcher.matchGroupEntry(role.getID(), role.getName()))); } - // Put on ignore because there's no support to identify read rights on a group for a user in a special - // com/coll admin group - // Please refer to: https://jira.lyrasis.org/browse/DS-4505 @Test - @Ignore public void getCollectionDefaultBitstreamReadGroupTestParentCommunityAdmin() throws Exception { context.turnOffAuthorisationSystem(); String bitstreamGroupString = "BITSTREAM"; @@ -1497,11 +1473,7 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati jsonPath("$", GroupMatcher.matchGroupEntry(role.getID(), role.getName()))); } - // Put on ignore because there's no support to identify read rights on a group for a user in a special - // com/coll admin group - // Please refer to: https://jira.lyrasis.org/browse/DS-4505 @Test - @Ignore public void getCollectionDefaultBitstreamReadGroupTestCollectionAdmin() throws Exception { context.turnOffAuthorisationSystem(); String bitstreamGroupString = "BITSTREAM"; @@ -1627,13 +1599,7 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati } - - - // Put on ignore because there's no support to identify read rights on a group for a user in a special - // com/coll admin group - // Please refer to: https://jira.lyrasis.org/browse/DS-4505 @Test - @Ignore public void postCollectionDefaultBitstreamReadGroupCreateDefaultBitstreamReadGroupSuccessParentCommunityAdmin() throws Exception { @@ -1668,12 +1634,7 @@ public class CollectionGroupRestControllerIT extends AbstractControllerIntegrati } - - // Put on ignore because there's no support to identify read rights on a group for a user in a special - // com/coll admin group - // Please refer to: https://jira.lyrasis.org/browse/DS-4505 @Test - @Ignore public void postCollectionDefaultBitstreamReadGroupCreateDefaultBitstreamReadGroupSuccessCollectionAdmin() throws Exception { diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/EPersonRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/EPersonRestRepositoryIT.java index 9de5eabe94..8d42788df4 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/EPersonRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/EPersonRestRepositoryIT.java @@ -1915,18 +1915,18 @@ public class EPersonRestRepositoryIT extends AbstractControllerIntegrationTest { String tokenAdminCol = getAuthToken(adminCol.getEmail(), password); String tokenAdminComm = getAuthToken(adminChild1.getEmail(), password); - getClient(tokenAdminCol).perform(get("/api/eperson/epersons/search/byMetadata") - .param("query", "Rossi")) - .andExpect(status().isOk()) - .andExpect(content().contentType(contentType)) - .andExpect(jsonPath("$._embedded.epersons", Matchers.containsInAnyOrder( - EPersonMatcher.matchEPersonEntry(adminChild1), - EPersonMatcher.matchEPersonEntry(adminCol), - EPersonMatcher.matchEPersonEntry(col1Submitter) - ))) - .andExpect(jsonPath("$.page.totalElements", is(3))); - for (String prop : confPropsCollectionAdmins) { + getClient(tokenAdminCol).perform(get("/api/eperson/epersons/search/byMetadata") + .param("query", "Rossi")) + .andExpect(status().isOk()) + .andExpect(content().contentType(contentType)) + .andExpect(jsonPath("$._embedded.epersons", Matchers.containsInAnyOrder( + EPersonMatcher.matchEPersonEntry(adminChild1), + EPersonMatcher.matchEPersonEntry(adminCol), + EPersonMatcher.matchEPersonEntry(col1Submitter) + ))) + .andExpect(jsonPath("$.page.totalElements", is(3))); + configurationService.setProperty(prop, false); } @@ -1934,18 +1934,18 @@ public class EPersonRestRepositoryIT extends AbstractControllerIntegrationTest { .param("query", "Rossi")) .andExpect(status().isForbidden()); - getClient(tokenAdminComm).perform(get("/api/eperson/epersons/search/byMetadata") - .param("query", "Rossi")) - .andExpect(status().isOk()) - .andExpect(content().contentType(contentType)) - .andExpect(jsonPath("$._embedded.epersons", Matchers.containsInAnyOrder( - EPersonMatcher.matchEPersonEntry(adminChild1), - EPersonMatcher.matchEPersonEntry(adminCol), - EPersonMatcher.matchEPersonEntry(col1Submitter) - ))) - .andExpect(jsonPath("$.page.totalElements", is(3))); - for (String prop : confPropsCommunityAdmins) { + getClient(tokenAdminComm).perform(get("/api/eperson/epersons/search/byMetadata") + .param("query", "Rossi")) + .andExpect(status().isOk()) + .andExpect(content().contentType(contentType)) + .andExpect(jsonPath("$._embedded.epersons", Matchers.containsInAnyOrder( + EPersonMatcher.matchEPersonEntry(adminChild1), + EPersonMatcher.matchEPersonEntry(adminCol), + EPersonMatcher.matchEPersonEntry(col1Submitter) + ))) + .andExpect(jsonPath("$.page.totalElements", is(3))); + configurationService.setProperty(prop, false); } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java index 7a415e2af0..2799d88e2e 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java @@ -44,10 +44,12 @@ import org.dspace.app.rest.model.patch.Operation; import org.dspace.app.rest.model.patch.ReplaceOperation; import org.dspace.app.rest.test.AbstractControllerIntegrationTest; import org.dspace.app.rest.test.MetadataPatchSuite; +import org.dspace.authorize.service.AuthorizeService; import org.dspace.authorize.service.ResourcePolicyService; import org.dspace.content.Collection; import org.dspace.content.Community; import org.dspace.content.factory.ContentServiceFactory; +import org.dspace.content.service.CollectionService; import org.dspace.content.service.CommunityService; import org.dspace.core.Constants; import org.dspace.eperson.EPerson; @@ -70,6 +72,10 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { ResourcePolicyService resourcePolicyService; @Autowired private ConfigurationService configurationService; + @Autowired + private CollectionService collectionService; + @Autowired + private AuthorizeService authorizeService; @Test public void createTest() @@ -2061,17 +2067,17 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { String tokenAdminCol = getAuthToken(adminCol1.getEmail(), password); String tokenAdminComm = getAuthToken(adminChild1.getEmail(), password); - getClient(tokenAdminCol).perform(get("/api/eperson/groups/search/byMetadata") - .param("query", group1.getName())) - .andExpect(status().isOk()) - .andExpect(content().contentType(contentType)) - .andExpect(jsonPath("$._embedded.groups",Matchers.containsInAnyOrder( - GroupMatcher.matchGroupEntry(group1.getID(), group1.getName()), - GroupMatcher.matchGroupEntry(group2.getID(), group2.getName()), - GroupMatcher.matchGroupEntry(group3.getID(), group3.getName())))) - .andExpect(jsonPath("$.page.totalElements", is(3))); - for (String prop : confPropsCollectionAdmins) { + getClient(tokenAdminCol).perform(get("/api/eperson/groups/search/byMetadata") + .param("query", group1.getName())) + .andExpect(status().isOk()) + .andExpect(content().contentType(contentType)) + .andExpect(jsonPath("$._embedded.groups",Matchers.containsInAnyOrder( + GroupMatcher.matchGroupEntry(group1.getID(), group1.getName()), + GroupMatcher.matchGroupEntry(group2.getID(), group2.getName()), + GroupMatcher.matchGroupEntry(group3.getID(), group3.getName())))) + .andExpect(jsonPath("$.page.totalElements", is(3))); + configurationService.setProperty(prop, false); } @@ -2079,17 +2085,17 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { .param("query", group1.getName())) .andExpect(status().isForbidden()); - getClient(tokenAdminComm).perform(get("/api/eperson/groups/search/byMetadata") - .param("query", group1.getName())) - .andExpect(status().isOk()) - .andExpect(content().contentType(contentType)) - .andExpect(jsonPath("$._embedded.groups",Matchers.containsInAnyOrder( - GroupMatcher.matchGroupEntry(group1.getID(), group1.getName()), - GroupMatcher.matchGroupEntry(group2.getID(), group2.getName()), - GroupMatcher.matchGroupEntry(group3.getID(), group3.getName())))) - .andExpect(jsonPath("$.page.totalElements", is(3))); - for (String prop : confPropsCommunityAdmins) { + getClient(tokenAdminComm).perform(get("/api/eperson/groups/search/byMetadata") + .param("query", group1.getName())) + .andExpect(status().isOk()) + .andExpect(content().contentType(contentType)) + .andExpect(jsonPath("$._embedded.groups",Matchers.containsInAnyOrder( + GroupMatcher.matchGroupEntry(group1.getID(), group1.getName()), + GroupMatcher.matchGroupEntry(group2.getID(), group2.getName()), + GroupMatcher.matchGroupEntry(group3.getID(), group3.getName())))) + .andExpect(jsonPath("$.page.totalElements", is(3))); + configurationService.setProperty(prop, false); } @@ -2098,6 +2104,57 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { .andExpect(status().isForbidden()); } + @Test + public void commAdminManageOwnerAdminGroupTest() throws Exception { + + GroupService groupService = EPersonServiceFactory.getInstance().getGroupService(); + + context.turnOffAuthorisationSystem(); + + EPerson adminChild1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Oliver", "Rossi") + .withEmail("adminChild1@example.com") + .withPassword(password) + .build(); + + EPerson submitter1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Carl", "Rossi") + .withEmail("submitter1@example.com") + .withPassword(password) + .build(); + + + parentCommunity = CommunityBuilder.createCommunity(context) + .withName("Parent Community") + .build(); + Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) + .withName("Sub Community") + .withAdminGroup(adminChild1) + .build(); + + Group groupAdmins = child1.getAdministrators(); + + context.restoreAuthSystemState(); + + String tokenCommAdmin = getAuthToken(adminChild1.getEmail(), password); + + assertFalse(groupService.isMember(context, submitter1, groupAdmins)); + + getClient(tokenCommAdmin).perform(post("/api/eperson/groups/" + groupAdmins.getID() + "/epersons") + .contentType(parseMediaType(TEXT_URI_LIST_VALUE)) + .content(REST_SERVER_URL + "eperson/groups/" + submitter1.getID() + )) + .andExpect(status().isNoContent()); + + assertTrue(groupService.isMember(context, submitter1, groupAdmins)); + + getClient(tokenCommAdmin).perform(delete("/api/eperson/groups/" + + groupAdmins.getID() + "/epersons/" + submitter1.getID())) + .andExpect(status().isNoContent()); + + assertFalse(groupService.isMember(context, submitter1, groupAdmins)); + } + @Test public void colAdminManageSubmitterGroupAndAdminGroupTest() throws Exception { @@ -2133,7 +2190,6 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { parentCommunity = CommunityBuilder.createCommunity(context) .withName("Parent Community") - .withAdminGroup(eperson) .build(); Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) .withName("Sub Community") @@ -2154,6 +2210,7 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { String tokenAdminCol = getAuthToken(adminCol1.getEmail(), password); assertFalse(groupService.isMember(context, submitter1, groupSubmitters)); + assertFalse(groupService.isMember(context, submitter2, groupSubmitters)); getClient(tokenAdminCol).perform(post("/api/eperson/groups/" + groupSubmitters.getID() + "/epersons") .contentType(parseMediaType(TEXT_URI_LIST_VALUE)) @@ -2218,7 +2275,6 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { parentCommunity = CommunityBuilder.createCommunity(context) .withName("Parent Community") - .withAdminGroup(eperson) .build(); Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) .withName("Sub Community") @@ -2264,7 +2320,7 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { } @Test - public void commAdminManageSubmitterGroupAndAdminGroupTest() throws Exception { + public void commAdminManageSunCollectionOfSubmittersAndAdminsTest() throws Exception { GroupService groupService = EPersonServiceFactory.getInstance().getGroupService(); @@ -2293,7 +2349,6 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { parentCommunity = CommunityBuilder.createCommunity(context) .withName("Parent Community") - .withAdminGroup(eperson) .build(); Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) .withName("Sub Community") @@ -2307,12 +2362,14 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { .build(); Group groupSubmitters = col1.getSubmitters(); + Group groupAdministrators = col1.getAdministrators(); context.restoreAuthSystemState(); String tokenAdminComm = getAuthToken(adminChild1.getEmail(), password); assertFalse(groupService.isMember(context, submitter1, groupSubmitters)); + assertFalse(groupService.isMember(context, submitter2, groupSubmitters)); getClient(tokenAdminComm).perform(post("/api/eperson/groups/" + groupSubmitters.getID() + "/epersons") .contentType(parseMediaType(TEXT_URI_LIST_VALUE)) @@ -2324,10 +2381,25 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { assertTrue(groupService.isMember(context, submitter1, groupSubmitters)); assertTrue(groupService.isMember(context, submitter2, groupSubmitters)); + getClient(tokenAdminComm).perform(delete("/api/eperson/groups/" + + groupSubmitters.getID() + "/epersons/" + submitter1.getID())) + .andExpect(status().isNoContent()); + + assertFalse(groupService.isMember(context, submitter1, groupSubmitters)); + assertTrue(groupService.isMember(context, submitter2, groupSubmitters)); + + assertTrue(groupService.isMember(context, adminCol1, groupAdministrators)); + getClient(tokenAdminComm).perform(delete("/api/eperson/groups/" + + groupAdministrators.getID() + "/epersons/" + adminCol1.getID())) + .andExpect(status().isNoContent()); + + assertFalse(groupService.isMember(context, adminCol1, groupAdministrators)); + } + @Test - public void commAdminDeleteColAdminFromAdminGroupTest() throws Exception { + public void commAdminAndColAdminCanManageItemReadGroupTest() throws Exception { GroupService groupService = EPersonServiceFactory.getInstance().getGroupService(); @@ -2348,10 +2420,14 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { .withEmail("submitter1@example.com") .withPassword(password) .build(); + EPerson submitter2 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Robert", "Clarks") + .withEmail("submitter2@example.com") + .withPassword(password) + .build(); parentCommunity = CommunityBuilder.createCommunity(context) .withName("Parent Community") - .withAdminGroup(eperson) .build(); Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) .withName("Sub Community") @@ -2364,30 +2440,207 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { .withSubmitterGroup(eperson) .build(); - Group groupAdministrators = col1.getAdministrators(); - Group groupSubmitters = col1.getSubmitters(); + String itemGroupString = "ITEM"; + int defaultItemRead = Constants.DEFAULT_ITEM_READ; + Group itemReadGroup = collectionService.createDefaultReadGroup(context, col1, itemGroupString, defaultItemRead); context.restoreAuthSystemState(); String tokenAdminComm = getAuthToken(adminChild1.getEmail(), password); - String tokenAdminCol = getAuthToken(adminCol1.getEmail(), password); + String tokenAdminCol = getAuthToken(adminChild1.getEmail(), password); - assertTrue(groupService.isMember(context, adminCol1, groupAdministrators)); + assertFalse(groupService.isMember(context, submitter1, itemReadGroup)); + assertFalse(groupService.isMember(context, submitter2, itemReadGroup)); - getClient(tokenAdminComm).perform(delete("/api/eperson/groups/" - + groupAdministrators.getID() + "/epersons/" + adminCol1.getID())) - .andExpect(status().isNoContent()); + getClient(tokenAdminCol).perform(post("/api/eperson/groups/" + itemReadGroup.getID() + "/epersons") + .contentType(parseMediaType(TEXT_URI_LIST_VALUE)) + .content(REST_SERVER_URL + "eperson/groups/" + submitter1.getID())) + .andExpect(status().isNoContent()); - assertFalse(groupService.isMember(context, adminCol1, groupAdministrators)); - assertFalse(groupService.isMember(context, submitter1, groupSubmitters)); + assertTrue(groupService.isMember(context, submitter1, itemReadGroup)); - getClient(tokenAdminCol).perform(post("/api/eperson/groups/" + groupSubmitters.getID() + "/epersons") - .contentType(parseMediaType(TEXT_URI_LIST_VALUE)) - .content(REST_SERVER_URL + "eperson/groups/" + submitter1.getID() - )) - .andExpect(status().isForbidden()); - assertFalse(groupService.isMember(context, submitter1, groupSubmitters)); + getClient(tokenAdminComm).perform(post("/api/eperson/groups/" + itemReadGroup.getID() + "/epersons") + .contentType(parseMediaType(TEXT_URI_LIST_VALUE)) + .content(REST_SERVER_URL + "eperson/groups/" + submitter2.getID())) + .andExpect(status().isNoContent()); + + assertTrue(groupService.isMember(context, submitter2, itemReadGroup)); + + getClient(tokenAdminComm).perform(delete("/api/eperson/groups/" + + itemReadGroup.getID() + "/epersons/" + submitter2.getID())) + .andExpect(status().isNoContent()); + + assertFalse(groupService.isMember(context, submitter2, itemReadGroup)); + + getClient(tokenAdminCol).perform(delete("/api/eperson/groups/" + + itemReadGroup.getID() + "/epersons/" + submitter1.getID())) + .andExpect(status().isNoContent()); + + assertFalse(groupService.isMember(context, submitter1, itemReadGroup)); } + + @Test + public void commAdminAndColAdminCanManageBitstreamReadGroupTest() throws Exception { + + GroupService groupService = EPersonServiceFactory.getInstance().getGroupService(); + + context.turnOffAuthorisationSystem(); + + EPerson adminChild1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Oliver", "Rossi") + .withEmail("adminChild1@example.com") + .withPassword(password) + .build(); + EPerson adminCol1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("James", "Rossi") + .withEmail("adminCol1@example.com") + .withPassword(password) + .build(); + EPerson submitter1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Carl", "Rossi") + .withEmail("submitter1@example.com") + .withPassword(password) + .build(); + EPerson submitter2 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Robert", "Clarks") + .withEmail("submitter2@example.com") + .withPassword(password) + .build(); + + parentCommunity = CommunityBuilder.createCommunity(context) + .withName("Parent Community") + .build(); + Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) + .withName("Sub Community") + .withAdminGroup(adminChild1) + .build(); + + Collection col1 = CollectionBuilder.createCollection(context, child1) + .withName("Collection 1") + .withAdminGroup(adminCol1) + .withSubmitterGroup(eperson) + .build(); + + String bitstreamGroupString = "BITSTREAM"; + int defaultBitstreamRead = Constants.DEFAULT_BITSTREAM_READ; + + Group bitstreamReadGroup = collectionService.createDefaultReadGroup(context, col1, bitstreamGroupString, + defaultBitstreamRead); + + context.restoreAuthSystemState(); + + String tokenAdminComm = getAuthToken(adminChild1.getEmail(), password); + String tokenAdminCol = getAuthToken(adminChild1.getEmail(), password); + + assertFalse(groupService.isMember(context, submitter1, bitstreamReadGroup)); + assertFalse(groupService.isMember(context, submitter2, bitstreamReadGroup)); + + getClient(tokenAdminCol).perform(post("/api/eperson/groups/" + bitstreamReadGroup.getID() + "/epersons") + .contentType(parseMediaType(TEXT_URI_LIST_VALUE)) + .content(REST_SERVER_URL + "eperson/groups/" + submitter1.getID())) + .andExpect(status().isNoContent()); + + assertTrue(groupService.isMember(context, submitter1, bitstreamReadGroup)); + + + getClient(tokenAdminComm).perform(post("/api/eperson/groups/" + bitstreamReadGroup.getID() + "/epersons") + .contentType(parseMediaType(TEXT_URI_LIST_VALUE)) + .content(REST_SERVER_URL + "eperson/groups/" + submitter2.getID())) + .andExpect(status().isNoContent()); + + assertTrue(groupService.isMember(context, submitter2, bitstreamReadGroup)); + + getClient(tokenAdminComm).perform(delete("/api/eperson/groups/" + + bitstreamReadGroup.getID() + "/epersons/" + submitter2.getID())) + .andExpect(status().isNoContent()); + + assertFalse(groupService.isMember(context, submitter2, bitstreamReadGroup)); + + getClient(tokenAdminCol).perform(delete("/api/eperson/groups/" + + bitstreamReadGroup.getID() + "/epersons/" + submitter1.getID())) + .andExpect(status().isNoContent()); + + assertFalse(groupService.isMember(context, submitter1, bitstreamReadGroup)); + + } + + @Test + public void commAdminAndColAdminCanManageWorkflowGroupsTest() throws Exception { + GroupService groupService = EPersonServiceFactory.getInstance().getGroupService(); + context.turnOffAuthorisationSystem(); + + EPerson adminChild1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Oliver", "Rossi") + .withEmail("adminChild1@example.com") + .withPassword(password) + .build(); + EPerson adminCol1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("James", "Rossi") + .withEmail("adminCol1@example.com") + .withPassword(password) + .build(); + EPerson submitter1 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Carl", "Rossi") + .withEmail("submitter1@example.com") + .withPassword(password) + .build(); + EPerson submitter2 = EPersonBuilder.createEPerson(context) + .withNameInMetadata("Robert", "Clarks") + .withEmail("submitter2@example.com") + .withPassword(password) + .build(); + + parentCommunity = CommunityBuilder.createCommunity(context) + .withName("Parent Community") + .build(); + Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) + .withName("Sub Community") + .withAdminGroup(adminChild1) + .build(); + + Collection col1 = CollectionBuilder.createCollection(context, child1) + .withName("Collection 1") + .withAdminGroup(adminCol1) + .withWorkflowGroup(1, eperson) + .withWorkflowGroup(2, eperson) + .build(); + + Group workflowGroupStep1 = col1.getWorkflowStep1(context); + Group workflowGroupStep2 = col1.getWorkflowStep2(context); + + context.restoreAuthSystemState(); + + assertFalse(groupService.isMember(context, submitter1, workflowGroupStep1)); + assertFalse(groupService.isMember(context, submitter2, workflowGroupStep2)); + + String tokenAdminComm = getAuthToken(adminChild1.getEmail(), password); + String tokenAdminCol = getAuthToken(adminChild1.getEmail(), password); + + getClient(tokenAdminComm).perform(post("/api/eperson/groups/" + workflowGroupStep1.getID() + "/epersons") + .contentType(parseMediaType(TEXT_URI_LIST_VALUE)) + .content(REST_SERVER_URL + "eperson/groups/" + submitter1.getID())) + .andExpect(status().isNoContent()); + + assertTrue(groupService.isMember(context, submitter1, workflowGroupStep1)); + + getClient(tokenAdminCol).perform(post("/api/eperson/groups/" + workflowGroupStep2.getID() + "/epersons") + .contentType(parseMediaType(TEXT_URI_LIST_VALUE)) + .content(REST_SERVER_URL + "eperson/groups/" + submitter2.getID())) + .andExpect(status().isNoContent()); + + assertTrue(groupService.isMember(context, submitter2, workflowGroupStep2)); + + getClient(tokenAdminComm).perform(delete("/api/eperson/groups/" + + workflowGroupStep2.getID() + "/epersons/" + submitter2.getID())) + .andExpect(status().isNoContent()); + + getClient(tokenAdminCol).perform(delete("/api/eperson/groups/" + + workflowGroupStep1.getID() + "/epersons/" + submitter1.getID())) + .andExpect(status().isNoContent()); + + assertFalse(groupService.isMember(context, submitter1, workflowGroupStep1)); + assertFalse(groupService.isMember(context, submitter2, workflowGroupStep2)); + } } From fcdbc1727a344458a390bfc964510f26feb457f7 Mon Sep 17 00:00:00 2001 From: Tim Donohue Date: Thu, 28 May 2020 16:21:04 -0500 Subject: [PATCH 079/125] Fix/update license header checking configuration in Maven --- dspace-api/pom.xml | 14 -------------- dspace/src/main/docker-compose/environment.dev.ts | 2 +- pom.xml | 12 +++++------- 3 files changed, 6 insertions(+), 22 deletions(-) diff --git a/dspace-api/pom.xml b/dspace-api/pom.xml index c714746337..a0714c04ee 100644 --- a/dspace-api/pom.xml +++ b/dspace-api/pom.xml @@ -98,20 +98,6 @@ - - - com.mycila - license-maven-plugin - - - **/src/test/resources/** - **/src/test/data/** - **/.gitignore - **/src/main/resources/rebel.xml - src/test/data/dspaceFolder/config/spiders/** - - - org.codehaus.mojo diff --git a/dspace/src/main/docker-compose/environment.dev.ts b/dspace/src/main/docker-compose/environment.dev.ts index e8c88112fa..11e3a92fe2 100644 --- a/dspace/src/main/docker-compose/environment.dev.ts +++ b/dspace/src/main/docker-compose/environment.dev.ts @@ -1,4 +1,4 @@ -/* +/** * 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 diff --git a/pom.xml b/pom.xml index 9bceb6c1d9..aa8a8b15dd 100644 --- a/pom.xml +++ b/pom.xml @@ -391,7 +391,7 @@ src/** + http://mycila.mathieu.photography/license-maven-plugin/ --> true @@ -399,21 +399,19 @@ **/src/test/resources/** **/src/test/data/** **/src/main/license/** - **/test.cfg **/META-INF/** **/robots.txt - **/*.LICENSE **/LICENSE* **/README* **/readme* **/.gitignore - **/src/main/resources/rebel.xml + **/*.cfg - + SCRIPT_STYLE - TEXT + JAVADOC_STYLE UTF-8 From 614ad3d054e09046112caec89fd6bb68b3ffacee Mon Sep 17 00:00:00 2001 From: Yana De Pauw Date: Fri, 29 May 2020 11:51:26 +0200 Subject: [PATCH 080/125] 71199: Fix PR issues --- .../SubmissionCCLicenseSearchController.java | 2 ++ .../SubmissionCCLicenseUrlConverter.java | 1 + .../model/SubmissionCCLicenseUrlRest.java | 4 +++ .../SubmissionCCLicenseRestRepository.java | 5 ++- ...censeUrlRestPermissionEvaluatorPlugin.java | 32 +++++++++++++++++++ 5 files changed, 43 insertions(+), 1 deletion(-) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionCCLicenseUrlRestPermissionEvaluatorPlugin.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java index f47376757c..17116884cf 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java @@ -23,6 +23,7 @@ import org.dspace.services.RequestService; import org.dspace.utils.DSpace; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.rest.webmvc.ResourceNotFoundException; +import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RestController; @@ -33,6 +34,7 @@ import org.springframework.web.bind.annotation.RestController; @RestController @RequestMapping("/api/" + SubmissionCCLicenseRest.CATEGORY + "/" + SubmissionCCLicenseRest.PLURAL + "/search" + "/rightsByQuestions") +@PreAuthorize("permitAll()") public class SubmissionCCLicenseSearchController { @Autowired diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseUrlConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseUrlConverter.java index 5411ac306c..99945661c5 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseUrlConverter.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/SubmissionCCLicenseUrlConverter.java @@ -29,6 +29,7 @@ public class SubmissionCCLicenseUrlConverter implements DSpaceConverter { return id; } + public void setId(String id) { + this.id = id; + } + public String getUrl() { return url; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java index 88ba438639..6d3cf03237 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java @@ -17,6 +17,7 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.data.rest.webmvc.ResourceNotFoundException; +import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Component; /** @@ -29,6 +30,7 @@ public class SubmissionCCLicenseRestRepository extends DSpaceRestRepository findAll(final Context context, final Pageable pageable) { List allCCLicenses = creativeCommonsService.findAllCCLicenses(); - return converter.toRestPage(utils.getPage(allCCLicenses, pageable), utils.obtainProjection()); + return converter.toRestPage(allCCLicenses, pageable, utils.obtainProjection()); } @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionCCLicenseUrlRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionCCLicenseUrlRestPermissionEvaluatorPlugin.java new file mode 100644 index 0000000000..284333e020 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionCCLicenseUrlRestPermissionEvaluatorPlugin.java @@ -0,0 +1,32 @@ +/** + * 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.rest.security; + +import java.io.Serializable; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.DiscoveryResultsRest; +import org.dspace.app.rest.model.SubmissionCCLicenseUrlRest; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Component; + +/** + * This class will handle calls made to SubmissionCCLicenseUrlRest endpoints. + * It will return true because access can be granted anytime it's linked from another resource + */ +@Component +public class SubmissionCCLicenseUrlRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { + @Override + public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, + DSpaceRestPermission restPermission) { + if (!StringUtils.equalsIgnoreCase(SubmissionCCLicenseUrlRest.NAME, targetType)) { + return false; + } + return true; + } +} From 72ac35025054b6f2ea4da4ca15c7e877ba4506c7 Mon Sep 17 00:00:00 2001 From: Yana De Pauw Date: Fri, 29 May 2020 13:19:20 +0200 Subject: [PATCH 081/125] Remove unused import --- .../SubmissionCCLicenseUrlRestPermissionEvaluatorPlugin.java | 1 - 1 file changed, 1 deletion(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionCCLicenseUrlRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionCCLicenseUrlRestPermissionEvaluatorPlugin.java index 284333e020..2fd8c7647f 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionCCLicenseUrlRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionCCLicenseUrlRestPermissionEvaluatorPlugin.java @@ -10,7 +10,6 @@ package org.dspace.app.rest.security; import java.io.Serializable; import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.DiscoveryResultsRest; import org.dspace.app.rest.model.SubmissionCCLicenseUrlRest; import org.springframework.security.core.Authentication; import org.springframework.stereotype.Component; From 361086710537d061df59e6c7b17ea1aa47466870 Mon Sep 17 00:00:00 2001 From: Kevin Van de Velde Date: Fri, 29 May 2020 13:19:49 +0200 Subject: [PATCH 082/125] Add missing test from https://github.com/DSpace/DSpace/pull/2770 --- .../CommunityAdminGroupRestControllerIT.java | 392 ++++++++++++++++++ .../app/rest/GroupRestRepositoryIT.java | 280 ++++++++++++- 2 files changed, 671 insertions(+), 1 deletion(-) diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityAdminGroupRestControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityAdminGroupRestControllerIT.java index 7d5e1a393b..bf606def8c 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityAdminGroupRestControllerIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityAdminGroupRestControllerIT.java @@ -10,6 +10,7 @@ package org.dspace.app.rest; import static com.jayway.jsonpath.JsonPath.read; import static org.dspace.app.rest.matcher.MetadataMatcher.matchMetadata; import static org.hamcrest.Matchers.allOf; +import static org.springframework.http.MediaType.parseMediaType; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; @@ -20,21 +21,31 @@ import java.util.UUID; import java.util.concurrent.atomic.AtomicReference; import com.fasterxml.jackson.databind.ObjectMapper; +import org.dspace.app.rest.builder.CollectionBuilder; import org.dspace.app.rest.builder.CommunityBuilder; +import org.dspace.app.rest.builder.EPersonBuilder; +import org.dspace.app.rest.builder.GroupBuilder; +import org.dspace.app.rest.matcher.EPersonMatcher; import org.dspace.app.rest.matcher.GroupMatcher; import org.dspace.app.rest.model.GroupRest; import org.dspace.app.rest.model.MetadataRest; import org.dspace.app.rest.model.MetadataValueRest; import org.dspace.app.rest.test.AbstractControllerIntegrationTest; import org.dspace.authorize.service.AuthorizeService; +import org.dspace.content.Collection; import org.dspace.content.Community; +import org.dspace.content.service.CollectionService; import org.dspace.content.service.CommunityService; import org.dspace.core.Constants; +import org.dspace.eperson.EPerson; import org.dspace.eperson.Group; import org.dspace.eperson.service.GroupService; +import org.dspace.services.ConfigurationService; +import org.hamcrest.Matchers; import org.junit.Before; import org.junit.Test; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.MediaType; public class CommunityAdminGroupRestControllerIT extends AbstractControllerIntegrationTest { @@ -48,10 +59,19 @@ public class CommunityAdminGroupRestControllerIT extends AbstractControllerInteg @Autowired private AuthorizeService authorizeService; + @Autowired + private CollectionService collectionService; + + @Autowired + private ConfigurationService configurationService; + + Collection collection; + @Before public void setup() { context.turnOffAuthorisationSystem(); parentCommunity = CommunityBuilder.createCommunity(context).withName("test").build(); + collection = CollectionBuilder.createCollection(context, parentCommunity).withName("Collection 1").build(); context.restoreAuthSystemState(); } @@ -437,4 +457,376 @@ public class CommunityAdminGroupRestControllerIT extends AbstractControllerInteg getClient(token).perform(delete("/api/core/communities/" + UUID.randomUUID() + "/adminGroup")) .andExpect(status().isNotFound()); } + + @Test + public void communityAdminAddMembersToCommunityAdminGroupPropertySetToFalse() throws Exception { + + context.turnOffAuthorisationSystem(); + Group adminGroup = communityService.createAdministrators(context, parentCommunity); + authorizeService.addPolicy(context, parentCommunity, Constants.ADMIN, eperson); + EPerson ePerson = EPersonBuilder.createEPerson(context).withEmail("testToAdd@test.com").build(); + configurationService.setProperty("core.authorization.community-admin.admin-group", false); + context.restoreAuthSystemState(); + + + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform( + post("/api/eperson/groups/" + adminGroup.getID() + "/epersons") + .contentType(parseMediaType + (org.springframework.data.rest.webmvc.RestMediaTypes.TEXT_URI_LIST_VALUE)) + .content("https://localhost:8080/server/api/eperson/epersons/" + ePerson.getID())) + .andExpect(status().isForbidden()); + + token = getAuthToken(admin.getEmail(), password); + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/epersons")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.epersons", Matchers.not(Matchers.hasItem( + EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) + )))); + + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.admin-group", true); + context.restoreAuthSystemState(); + + } + + @Test + public void communityAdminRemoveMembersFromCommunityAdminGroupPropertySetToFalse() throws Exception { + + context.turnOffAuthorisationSystem(); + Group adminGroup = communityService.createAdministrators(context, parentCommunity); + authorizeService.addPolicy(context, parentCommunity, Constants.ADMIN, eperson); + EPerson ePerson = EPersonBuilder.createEPerson(context).withEmail("testToAdd@test.com").build(); + context.restoreAuthSystemState(); + + + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform( + post("/api/eperson/groups/" + adminGroup.getID() + "/epersons") + .contentType(parseMediaType + (org.springframework.data.rest.webmvc.RestMediaTypes + .TEXT_URI_LIST_VALUE)) + .content("https://localhost:8080/server/api/eperson/epersons/" + ePerson.getID())); + + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/epersons")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.epersons", Matchers.hasItem( + EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) + ))); + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.admin-group", false); + context.restoreAuthSystemState(); + + getClient(token).perform(delete("/api/eperson/groups/" + adminGroup.getID() + "/epersons/" + ePerson.getID())) + .andExpect(status().isForbidden()); + + token = getAuthToken(admin.getEmail(), password); + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/epersons")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.epersons", Matchers.hasItem( + EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) + ))); + + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.admin-group", true); + context.restoreAuthSystemState(); + + } + + @Test + public void communityAdminAddChildGroupToCommunityAdminGroupPropertySetToFalse() throws Exception { + + context.turnOffAuthorisationSystem(); + Group adminGroup = communityService.createAdministrators(context, parentCommunity); + authorizeService.addPolicy(context, parentCommunity, Constants.ADMIN, eperson); + Group group = GroupBuilder.createGroup(context).withName("testGroup").build(); + configurationService.setProperty("core.authorization.community-admin.admin-group", false); + context.restoreAuthSystemState(); + + + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform( + post("/api/eperson/groups/" + adminGroup.getID() + "/subgroups") + .contentType(parseMediaType + (org.springframework.data.rest.webmvc.RestMediaTypes + .TEXT_URI_LIST_VALUE)) + .content("https://localhost:8080/server/api/eperson/groups/" + group.getID())) + .andExpect(status().isForbidden()); + + token = getAuthToken(admin.getEmail(), password); + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/subgroups")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.subgroups", Matchers.not(Matchers.hasItem( + GroupMatcher.matchGroupWithName(group.getName()) + )))); + + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.admin-group", true); + context.restoreAuthSystemState(); + + } + + @Test + public void communityAdminRemoveChildGroupFromCommunityAdminGroupPropertySetToFalse() throws Exception { + + context.turnOffAuthorisationSystem(); + Group adminGroup = communityService.createAdministrators(context, parentCommunity); + authorizeService.addPolicy(context, parentCommunity, Constants.ADMIN, eperson); + Group group = GroupBuilder.createGroup(context).withName("testGroup").build(); + context.restoreAuthSystemState(); + + + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform( + post("/api/eperson/groups/" + adminGroup.getID() + "/subgroups") + .contentType(parseMediaType + (org.springframework.data.rest.webmvc.RestMediaTypes + .TEXT_URI_LIST_VALUE)) + .content("https://localhost:8080/server/api/eperson/groups/" + group.getID())); + + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/subgroups")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.subgroups", Matchers.hasItem( + GroupMatcher.matchGroupWithName(group.getName()) + ))); + + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.admin-group", false); + context.restoreAuthSystemState(); + + getClient(token).perform(delete("/api/eperson/groups/" + adminGroup.getID() + "/subgroups/" + group.getID())) + .andExpect(status().isForbidden()); + + token = getAuthToken(admin.getEmail(), password); + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/subgroups")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.subgroups", Matchers.hasItem( + GroupMatcher.matchGroupWithName(group.getName()) + ))); + + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.admin-group", true); + context.restoreAuthSystemState(); + } + + @Test + public void communityAdminAddChildGroupToCollectionAdminGroupSuccess() throws Exception { + + context.turnOffAuthorisationSystem(); + Group adminGroup = collectionService.createAdministrators(context, collection); + authorizeService.addPolicy(context, parentCommunity, Constants.ADMIN, eperson); + Group group = GroupBuilder.createGroup(context).withName("testGroup").build(); + context.restoreAuthSystemState(); + + + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform( + post("/api/eperson/groups/" + adminGroup.getID() + "/subgroups") + .contentType(MediaType.parseMediaType + (org.springframework.data.rest.webmvc.RestMediaTypes + .TEXT_URI_LIST_VALUE)) + .content("https://localhost:8080/server/api/eperson/groups/" + group.getID())); + + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/subgroups")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.subgroups", Matchers.hasItem( + GroupMatcher.matchGroupWithName(group.getName()) + ))); + + } + + @Test + public void communityAdminRemoveChildGroupFromCollectionAdminGroupSuccess() throws Exception { + + context.turnOffAuthorisationSystem(); + Group adminGroup = collectionService.createAdministrators(context, collection); + authorizeService.addPolicy(context, parentCommunity, Constants.ADMIN, eperson); + Group group = GroupBuilder.createGroup(context).withName("testGroup").build(); + context.restoreAuthSystemState(); + + + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform( + post("/api/eperson/groups/" + adminGroup.getID() + "/subgroups") + .contentType(MediaType.parseMediaType + (org.springframework.data.rest.webmvc.RestMediaTypes + .TEXT_URI_LIST_VALUE)) + .content("https://localhost:8080/server/api/eperson/groups/" + group.getID())); + + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/subgroups")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.subgroups", Matchers.hasItem( + GroupMatcher.matchGroupWithName(group.getName()) + ))); + + + getClient(token).perform(delete("/api/eperson/groups/" + adminGroup.getID() + "/subgroups/" + group.getID())) + .andExpect(status().isNoContent()); + + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/subgroups")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.subgroups", Matchers.not(Matchers.hasItem( + GroupMatcher.matchGroupWithName(group.getName()) + )))); + + } + + @Test + public void communityAdminAddMembersToCollectionAdminGroupPropertySetToFalse() throws Exception { + + context.turnOffAuthorisationSystem(); + Group adminGroup = collectionService.createAdministrators(context, collection); + authorizeService.addPolicy(context, parentCommunity, Constants.ADMIN, eperson); + EPerson ePerson = EPersonBuilder.createEPerson(context).withEmail("testToAdd@test.com").build(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", false); + configurationService.setProperty("core.authorization.collection-admin.admin-group", false); + context.restoreAuthSystemState(); + + + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform( + post("/api/eperson/groups/" + adminGroup.getID() + "/epersons") + .contentType(MediaType.parseMediaType + (org.springframework.data.rest.webmvc.RestMediaTypes.TEXT_URI_LIST_VALUE)) + .content("https://localhost:8080/server/api/eperson/epersons/" + ePerson.getID())) + .andExpect(status().isForbidden()); + + token = getAuthToken(admin.getEmail(), password); + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/epersons")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.epersons", Matchers.not(Matchers.hasItem( + EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) + )))); + + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", true); + configurationService.setProperty("core.authorization.collection-admin.admin-group", true); + context.restoreAuthSystemState(); + + } + + @Test + public void communityAdminRemoveMembersFromCollectionAdminGroupPropertySetToFalse() throws Exception { + + context.turnOffAuthorisationSystem(); + Group adminGroup = collectionService.createAdministrators(context, collection); + authorizeService.addPolicy(context, parentCommunity, Constants.ADMIN, eperson); + EPerson ePerson = EPersonBuilder.createEPerson(context).withEmail("testToAdd@test.com").build(); + context.restoreAuthSystemState(); + + + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform( + post("/api/eperson/groups/" + adminGroup.getID() + "/epersons") + .contentType(MediaType.parseMediaType + (org.springframework.data.rest.webmvc.RestMediaTypes + .TEXT_URI_LIST_VALUE)) + .content("https://localhost:8080/server/api/eperson/epersons/" + ePerson.getID())); + + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/epersons")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.epersons", Matchers.hasItem( + EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) + ))); + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", false); + configurationService.setProperty("core.authorization.collection-admin.admin-group", false); + context.restoreAuthSystemState(); + + getClient(token).perform(delete("/api/eperson/groups/" + adminGroup.getID() + "/epersons/" + ePerson.getID())) + .andExpect(status().isForbidden()); + + token = getAuthToken(admin.getEmail(), password); + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/epersons")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.epersons", Matchers.hasItem( + EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) + ))); + + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", true); + configurationService.setProperty("core.authorization.collection-admin.admin-group", true); + context.restoreAuthSystemState(); + + } + + @Test + public void communityAdminAddChildGroupToCollectionAdminGroupPropertySetToFalse() throws Exception { + + context.turnOffAuthorisationSystem(); + Group adminGroup = collectionService.createAdministrators(context, collection); + authorizeService.addPolicy(context, parentCommunity, Constants.ADMIN, eperson); + Group group = GroupBuilder.createGroup(context).withName("testGroup").build(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", false); + configurationService.setProperty("core.authorization.collection-admin.admin-group", false); + context.restoreAuthSystemState(); + + + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform( + post("/api/eperson/groups/" + adminGroup.getID() + "/subgroups") + .contentType(MediaType.parseMediaType + (org.springframework.data.rest.webmvc.RestMediaTypes + .TEXT_URI_LIST_VALUE)) + .content("https://localhost:8080/server/api/eperson/groups/" + group.getID())) + .andExpect(status().isForbidden()); + + token = getAuthToken(admin.getEmail(), password); + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/subgroups")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.subgroups", Matchers.not(Matchers.hasItem( + GroupMatcher.matchGroupWithName(group.getName()) + )))); + + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", true); + configurationService.setProperty("core.authorization.collection-admin.admin-group", true); + context.restoreAuthSystemState(); + + } + + @Test + public void communityAdminRemoveChildGroupFromCollectionAdminGroupPropertySetToFalse() throws Exception { + + context.turnOffAuthorisationSystem(); + Group adminGroup = collectionService.createAdministrators(context, collection); + authorizeService.addPolicy(context, parentCommunity, Constants.ADMIN, eperson); + Group group = GroupBuilder.createGroup(context).withName("testGroup").build(); + context.restoreAuthSystemState(); + + + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform( + post("/api/eperson/groups/" + adminGroup.getID() + "/subgroups") + .contentType(MediaType.parseMediaType + (org.springframework.data.rest.webmvc.RestMediaTypes + .TEXT_URI_LIST_VALUE)) + .content("https://localhost:8080/server/api/eperson/groups/" + group.getID())); + + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/subgroups")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.subgroups", Matchers.hasItem( + GroupMatcher.matchGroupWithName(group.getName()) + ))); + + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", false); + configurationService.setProperty("core.authorization.collection-admin.admin-group", false); + context.restoreAuthSystemState(); + + getClient(token).perform(delete("/api/eperson/groups/" + adminGroup.getID() + "/subgroups/" + group.getID())) + .andExpect(status().isForbidden()); + + token = getAuthToken(admin.getEmail(), password); + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/subgroups")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.subgroups", Matchers.hasItem( + GroupMatcher.matchGroupWithName(group.getName()) + ))); + + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", true); + configurationService.setProperty("core.authorization.collection-admin.admin-group", true); + context.restoreAuthSystemState(); + } } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java index 2799d88e2e..ff5e69c396 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java @@ -35,6 +35,7 @@ import org.dspace.app.rest.builder.CollectionBuilder; import org.dspace.app.rest.builder.CommunityBuilder; import org.dspace.app.rest.builder.EPersonBuilder; import org.dspace.app.rest.builder.GroupBuilder; +import org.dspace.app.rest.matcher.EPersonMatcher; import org.dspace.app.rest.matcher.GroupMatcher; import org.dspace.app.rest.matcher.HalMatcher; import org.dspace.app.rest.model.GroupRest; @@ -59,6 +60,7 @@ import org.dspace.eperson.service.EPersonService; import org.dspace.eperson.service.GroupService; import org.dspace.services.ConfigurationService; import org.hamcrest.Matchers; +import org.junit.Before; import org.junit.Test; import org.springframework.beans.factory.annotation.Autowired; @@ -74,9 +76,21 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { private ConfigurationService configurationService; @Autowired private CollectionService collectionService; + @Autowired private AuthorizeService authorizeService; + Collection collection; + + @Before + public void setup() { + context.turnOffAuthorisationSystem(); + parentCommunity = CommunityBuilder.createCommunity(context).withName("test").build(); + collection = CollectionBuilder.createCollection(context, parentCommunity).withName("Collection 1").build(); + + context.restoreAuthSystemState(); + } + @Test public void createTest() throws Exception { @@ -2320,7 +2334,7 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { } @Test - public void commAdminManageSunCollectionOfSubmittersAndAdminsTest() throws Exception { + public void communityAdminCanManageCollectionSubmittersGroupAndAdminsGroupsTest() throws Exception { GroupService groupService = EPersonServiceFactory.getInstance().getGroupService(); @@ -2388,6 +2402,13 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { assertFalse(groupService.isMember(context, submitter1, groupSubmitters)); assertTrue(groupService.isMember(context, submitter2, groupSubmitters)); + getClient(tokenAdminComm).perform(post("/api/eperson/groups/" + groupAdministrators.getID() + "/epersons") + .contentType(parseMediaType(TEXT_URI_LIST_VALUE)) + .content(REST_SERVER_URL + "eperson/groups/" + submitter1.getID() + )) + .andExpect(status().isNoContent()); + + assertTrue(groupService.isMember(context, submitter1, groupAdministrators)); assertTrue(groupService.isMember(context, adminCol1, groupAdministrators)); getClient(tokenAdminComm).perform(delete("/api/eperson/groups/" + groupAdministrators.getID() + "/epersons/" + adminCol1.getID())) @@ -2643,4 +2664,261 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { assertFalse(groupService.isMember(context, submitter1, workflowGroupStep1)); assertFalse(groupService.isMember(context, submitter2, workflowGroupStep2)); } + + @Test + public void collectionAdminRemoveMembersFromCollectionAdminGroupSuccess() throws Exception { + + context.turnOffAuthorisationSystem(); + Group adminGroup = collectionService.createAdministrators(context, collection); + authorizeService.addPolicy(context, collection, Constants.ADMIN, eperson); + EPerson ePerson = EPersonBuilder.createEPerson(context).withEmail("testToAdd@test.com").build(); + context.restoreAuthSystemState(); + + + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform( + post("/api/eperson/groups/" + adminGroup.getID() + "/epersons") + .contentType(parseMediaType + (org.springframework.data.rest.webmvc.RestMediaTypes + .TEXT_URI_LIST_VALUE)) + .content("https://localhost:8080/server/api/eperson/epersons/" + ePerson.getID())); + + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/epersons")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.epersons", Matchers.hasItem( + EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) + ))); + + getClient(token).perform(delete("/api/eperson/groups/" + adminGroup.getID() + "/epersons/" + ePerson.getID())) + .andExpect(status().isNoContent()); + + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/epersons")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.epersons", Matchers.not(Matchers.hasItem( + EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) + )))); + + } + + @Test + public void collectionAdminAddChildGroupToCollectionAdminGroupSuccess() throws Exception { + + context.turnOffAuthorisationSystem(); + Group adminGroup = collectionService.createAdministrators(context, collection); + authorizeService.addPolicy(context, collection, Constants.ADMIN, eperson); + Group group = GroupBuilder.createGroup(context).withName("testGroup").build(); + context.restoreAuthSystemState(); + + + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform( + post("/api/eperson/groups/" + adminGroup.getID() + "/subgroups") + .contentType(parseMediaType + (org.springframework.data.rest.webmvc.RestMediaTypes + .TEXT_URI_LIST_VALUE)) + .content("https://localhost:8080/server/api/eperson/groups/" + group.getID())); + + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/subgroups")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.subgroups", Matchers.hasItem( + GroupMatcher.matchGroupWithName(group.getName()) + ))); + + } + + @Test + public void collectionAdminRemoveChildGroupFromCollectionAdminGroupSuccess() throws Exception { + + context.turnOffAuthorisationSystem(); + Group adminGroup = collectionService.createAdministrators(context, collection); + authorizeService.addPolicy(context, collection, Constants.ADMIN, eperson); + Group group = GroupBuilder.createGroup(context).withName("testGroup").build(); + context.restoreAuthSystemState(); + + + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform( + post("/api/eperson/groups/" + adminGroup.getID() + "/subgroups") + .contentType(parseMediaType + (org.springframework.data.rest.webmvc.RestMediaTypes + .TEXT_URI_LIST_VALUE)) + .content("https://localhost:8080/server/api/eperson/groups/" + group.getID())); + + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/subgroups")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.subgroups", Matchers.hasItem( + GroupMatcher.matchGroupWithName(group.getName()) + ))); + + + getClient(token).perform(delete("/api/eperson/groups/" + adminGroup.getID() + "/subgroups/" + group.getID())) + .andExpect(status().isNoContent()); + + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/subgroups")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.subgroups", Matchers.not(Matchers.hasItem( + GroupMatcher.matchGroupWithName(group.getName()) + )))); + + } + + @Test + public void collectionAdminAddMembersToCollectionAdminGroupPropertySetToFalse() throws Exception { + + context.turnOffAuthorisationSystem(); + Group adminGroup = collectionService.createAdministrators(context, collection); + authorizeService.addPolicy(context, collection, Constants.ADMIN, eperson); + EPerson ePerson = EPersonBuilder.createEPerson(context).withEmail("testToAdd@test.com").build(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", false); + configurationService.setProperty("core.authorization.collection-admin.admin-group", false); + context.restoreAuthSystemState(); + + + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform( + post("/api/eperson/groups/" + adminGroup.getID() + "/epersons") + .contentType(parseMediaType + (org.springframework.data.rest.webmvc.RestMediaTypes.TEXT_URI_LIST_VALUE)) + .content("https://localhost:8080/server/api/eperson/epersons/" + ePerson.getID())) + .andExpect(status().isForbidden()); + + token = getAuthToken(admin.getEmail(), password); + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/epersons")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.epersons", Matchers.not(Matchers.hasItem( + EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) + )))); + + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", true); + configurationService.setProperty("core.authorization.collection-admin.admin-group", true); + context.restoreAuthSystemState(); + + } + + @Test + public void collectionAdminRemoveMembersFromCollectionAdminGroupPropertySetToFalse() throws Exception { + + context.turnOffAuthorisationSystem(); + Group adminGroup = collectionService.createAdministrators(context, collection); + authorizeService.addPolicy(context, collection, Constants.ADMIN, eperson); + EPerson ePerson = EPersonBuilder.createEPerson(context).withEmail("testToAdd@test.com").build(); + context.restoreAuthSystemState(); + + + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform( + post("/api/eperson/groups/" + adminGroup.getID() + "/epersons") + .contentType(parseMediaType + (org.springframework.data.rest.webmvc.RestMediaTypes + .TEXT_URI_LIST_VALUE)) + .content("https://localhost:8080/server/api/eperson/epersons/" + ePerson.getID())); + + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/epersons")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.epersons", Matchers.hasItem( + EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) + ))); + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", false); + configurationService.setProperty("core.authorization.collection-admin.admin-group", false); + context.restoreAuthSystemState(); + + getClient(token).perform(delete("/api/eperson/groups/" + adminGroup.getID() + "/epersons/" + ePerson.getID())) + .andExpect(status().isForbidden()); + + token = getAuthToken(admin.getEmail(), password); + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/epersons")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.epersons", Matchers.hasItem( + EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) + ))); + + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", true); + configurationService.setProperty("core.authorization.collection-admin.admin-group", true); + context.restoreAuthSystemState(); + + } + + @Test + public void collectionAdminAddChildGroupToCollectionAdminGroupPropertySetToFalse() throws Exception { + + context.turnOffAuthorisationSystem(); + Group adminGroup = collectionService.createAdministrators(context, collection); + authorizeService.addPolicy(context, collection, Constants.ADMIN, eperson); + Group group = GroupBuilder.createGroup(context).withName("testGroup").build(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", false); + configurationService.setProperty("core.authorization.collection-admin.admin-group", false); + context.restoreAuthSystemState(); + + + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform( + post("/api/eperson/groups/" + adminGroup.getID() + "/subgroups") + .contentType(parseMediaType + (org.springframework.data.rest.webmvc.RestMediaTypes + .TEXT_URI_LIST_VALUE)) + .content("https://localhost:8080/server/api/eperson/groups/" + group.getID())) + .andExpect(status().isForbidden()); + + token = getAuthToken(admin.getEmail(), password); + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/subgroups")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.subgroups", Matchers.not(Matchers.hasItem( + GroupMatcher.matchGroupWithName(group.getName()) + )))); + + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", true); + configurationService.setProperty("core.authorization.collection-admin.admin-group", true); + context.restoreAuthSystemState(); + + } + + @Test + public void collectionAdminRemoveChildGroupFromCollectionAdminGroupPropertySetToFalse() throws Exception { + + context.turnOffAuthorisationSystem(); + Group adminGroup = collectionService.createAdministrators(context, collection); + authorizeService.addPolicy(context, collection, Constants.ADMIN, eperson); + Group group = GroupBuilder.createGroup(context).withName("testGroup").build(); + context.restoreAuthSystemState(); + + + String token = getAuthToken(eperson.getEmail(), password); + getClient(token).perform( + post("/api/eperson/groups/" + adminGroup.getID() + "/subgroups") + .contentType(parseMediaType + (org.springframework.data.rest.webmvc.RestMediaTypes + .TEXT_URI_LIST_VALUE)) + .content("https://localhost:8080/server/api/eperson/groups/" + group.getID())); + + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/subgroups")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.subgroups", Matchers.hasItem( + GroupMatcher.matchGroupWithName(group.getName()) + ))); + + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", false); + configurationService.setProperty("core.authorization.collection-admin.admin-group", false); + context.restoreAuthSystemState(); + + getClient(token).perform(delete("/api/eperson/groups/" + adminGroup.getID() + "/subgroups/" + group.getID())) + .andExpect(status().isForbidden()); + + token = getAuthToken(admin.getEmail(), password); + getClient(token).perform(get("/api/eperson/groups/" + adminGroup.getID() + "/subgroups")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.subgroups", Matchers.hasItem( + GroupMatcher.matchGroupWithName(group.getName()) + ))); + + context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", true); + configurationService.setProperty("core.authorization.collection-admin.admin-group", true); + context.restoreAuthSystemState(); + } + } From 47b75f313e543923997cbe8c2ae717323aea7170 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Fri, 29 May 2020 15:52:09 +0200 Subject: [PATCH 083/125] Fixed checkstyle --- .../src/main/java/org/dspace/app/bulkedit/MetadataImport.java | 1 - 1 file changed, 1 deletion(-) diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java index 13a63bada9..0e424ead7f 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java @@ -316,7 +316,6 @@ public class MetadataImport extends DSpaceRunnable Date: Fri, 29 May 2020 16:50:19 -0500 Subject: [PATCH 084/125] Bug fixes to Docker configuration --- dspace/src/main/docker-compose/environment.dev.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/dspace/src/main/docker-compose/environment.dev.ts b/dspace/src/main/docker-compose/environment.dev.ts index 11e3a92fe2..11180cae53 100644 --- a/dspace/src/main/docker-compose/environment.dev.ts +++ b/dspace/src/main/docker-compose/environment.dev.ts @@ -5,9 +5,9 @@ * * http://www.dspace.org/license/ */ -import { GlobalConfig } from '../src/config/global-config.interface'; - -export const environment: Partial = { +// This file is based on environment.common.ts provided by Angular UI +export const environment = { + // Default to using the local REST API (running in Docker) rest: { ssl: false, host: 'localhost', From 46ffa51f71eb60856424fb5e9a42fb7f450edc95 Mon Sep 17 00:00:00 2001 From: Tim Donohue Date: Mon, 1 Jun 2020 09:40:28 -0500 Subject: [PATCH 085/125] Fix typo --- dspace/src/main/docker-compose/environment.dev.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dspace/src/main/docker-compose/environment.dev.ts b/dspace/src/main/docker-compose/environment.dev.ts index 11180cae53..573c8ebb67 100644 --- a/dspace/src/main/docker-compose/environment.dev.ts +++ b/dspace/src/main/docker-compose/environment.dev.ts @@ -5,7 +5,7 @@ * * http://www.dspace.org/license/ */ -// This file is based on environment.common.ts provided by Angular UI +// This file is based on environment.template.ts provided by Angular UI export const environment = { // Default to using the local REST API (running in Docker) rest: { From 6c0ee98fa616ea63af7aa68f6a500f7ef25be780 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Tue, 2 Jun 2020 14:56:00 +0200 Subject: [PATCH 086/125] SPEL parsing of the preAuthorize annotation in converterService work --- .../app/rest/converter/ConverterService.java | 16 ++++ .../spel/ExpressionValidationException.java | 7 ++ .../app/rest/spel/ExpressionValidator.java | 86 +++++++++++++++++++ 3 files changed, 109 insertions(+) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/spel/ExpressionValidationException.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/spel/ExpressionValidator.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java index 26eae66e65..cbff22f9a2 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java @@ -31,6 +31,8 @@ import org.dspace.app.rest.projection.DefaultProjection; import org.dspace.app.rest.projection.Projection; import org.dspace.app.rest.repository.DSpaceRestRepository; import org.dspace.app.rest.security.DSpacePermissionEvaluator; +import org.dspace.app.rest.spel.ExpressionValidationException; +import org.dspace.app.rest.spel.ExpressionValidator; import org.dspace.app.rest.utils.Utils; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.config.BeanDefinition; @@ -40,8 +42,12 @@ import org.springframework.core.type.filter.AssignableTypeFilter; import org.springframework.data.domain.Page; import org.springframework.data.domain.PageImpl; import org.springframework.data.domain.Pageable; +import org.springframework.expression.Expression; +import org.springframework.expression.ExpressionParser; +import org.springframework.expression.spel.standard.SpelExpressionParser; import org.springframework.hateoas.EntityModel; import org.springframework.hateoas.Link; +import org.springframework.security.access.expression.SecurityExpressionRoot; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.security.core.context.SecurityContextHolder; import org.springframework.stereotype.Component; @@ -136,6 +142,16 @@ public class ConverterService { String permission = ""; if (preAuthorize != null) { String annotationValue = (String) AnnotationUtils.getValue(preAuthorize); + ExpressionValidator validator = new ExpressionValidator(); + try { + validator.validate("hasPermission(123, 'ITEM', 'WRITE')", SecurityExpressionRoot.class); + } catch (ExpressionValidationException e) { + e.printStackTrace(); + } + +// ExpressionParser parser = new SpelExpressionParser(); +// Expression exp = parser.parseExpression("hasPermission('123', 'ITEM', 'WRITE')"); +// exp.getValue(SecurityExpressionRoot.class, boolean.class); if (StringUtils.contains(annotationValue, "permitAll")) { permission = "permitAll"; } else if (StringUtils.contains(annotationValue, "hasAuthority")) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/spel/ExpressionValidationException.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/spel/ExpressionValidationException.java new file mode 100644 index 0000000000..9fbe73f19f --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/spel/ExpressionValidationException.java @@ -0,0 +1,7 @@ +package org.dspace.app.rest.spel; + +public class ExpressionValidationException extends Exception { + public ExpressionValidationException(String message) { + super(message); + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/spel/ExpressionValidator.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/spel/ExpressionValidator.java new file mode 100644 index 0000000000..8cf1dc2a6c --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/spel/ExpressionValidator.java @@ -0,0 +1,86 @@ +package org.dspace.app.rest.spel; + +import org.springframework.expression.ExpressionParser; +import org.springframework.expression.ParseException; +import org.springframework.expression.spel.SpelNode; +import org.springframework.expression.spel.ast.BeanReference; +import org.springframework.expression.spel.ast.MethodReference; +import org.springframework.expression.spel.ast.Operator; +import org.springframework.expression.spel.ast.TypeReference; +import org.springframework.expression.spel.ast.VariableReference; +import org.springframework.expression.spel.standard.SpelExpression; +import org.springframework.expression.spel.standard.SpelExpressionParser; +import org.springframework.security.access.expression.SecurityExpressionRoot; +import org.springframework.security.core.Authentication; +import org.springframework.security.core.context.SecurityContextHolder; + +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; + +public class ExpressionValidator { + private final ExpressionParser parser = new SpelExpressionParser(); + + public void validate(String expression, Class expressionRoot) throws ExpressionValidationException, ParseException { + SpelExpression exp = (SpelExpression) parser.parseExpression(expression); + if (expressionRoot != null) { + SpelNode node = exp.getAST(); + handle(node, expressionRoot); + } + } + + private void handle(SpelNode node, Class expressionRoot) throws ExpressionValidationException{ + if (node instanceof MethodReference) { + verify((MethodReference) node, expressionRoot); + } else if (node instanceof Operator) { + Operator operator = (Operator) node; + handle(operator.getLeftOperand(), expressionRoot); + handle(operator.getRightOperand(), expressionRoot); + } else if (node != null) { + for(int i=0; i expressionRoot) throws ExpressionValidationException { + String methodName = node.getName(); + int args = node.getChildCount(); + Method[] methods = expressionRoot.getDeclaredMethods(); + for(Method m : methods) { + if (m.getName().equals(methodName)) { + // exact match on the args + if (args == m.getParameterCount()) { + try { + SecurityExpressionRoot.class.getConstructor(Authentication.class).newInstance( + SecurityContextHolder.getContext().getAuthentication()); + } catch (InstantiationException | IllegalAccessException | InvocationTargetException | NoSuchMethodException e) { + e.printStackTrace(); + } + return; + } + Class[] parameterTypes = m.getParameterTypes(); + if (m.getName().equals(methodName) && + parameterTypes != null && + parameterTypes.length>=1 && + parameterTypes[parameterTypes.length-1].isArray()) { + // allow the number of params to be one less or >= the reported length + if(args == m.getParameterCount()-1 || args >= m.getParameterCount()) { + return; + } + } + } + } + // if we get here, then we were unable to match the method call + String pattern = "Unable to match method %s with %d params"; + throw new ExpressionValidationException(String.format(pattern, methodName, args)); + } + +} From bf790e072b33768fc10ca2cd63504064035839b3 Mon Sep 17 00:00:00 2001 From: Tim Donohue Date: Tue, 2 Jun 2020 17:01:48 -0500 Subject: [PATCH 087/125] Rename root properties in REST API to match dspace.cfg configuration names --- .../app/rest/converter/RootConverter.java | 4 +-- .../app/rest/link/RootHalLinkFactory.java | 2 +- .../ProcessResourceHalLinkFactory.java | 4 +-- .../org/dspace/app/rest/model/RootRest.java | 28 +++++++++---------- .../rest/RootRestResourceControllerIT.java | 4 +-- .../app/rest/converter/RootConverterTest.java | 4 +-- 6 files changed, 23 insertions(+), 23 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/RootConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/RootConverter.java index b75f5f2751..c49d19842d 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/RootConverter.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/RootConverter.java @@ -24,8 +24,8 @@ public class RootConverter { public RootRest convert() { RootRest rootRest = new RootRest(); rootRest.setDspaceName(configurationService.getProperty("dspace.name")); - rootRest.setDspaceURL(configurationService.getProperty("dspace.ui.url")); - rootRest.setDspaceRest(configurationService.getProperty("dspace.server.url")); + rootRest.setDspaceUI(configurationService.getProperty("dspace.ui.url")); + rootRest.setDspaceServer(configurationService.getProperty("dspace.server.url")); return rootRest; } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/RootHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/RootHalLinkFactory.java index 55751435d4..7ce95aa18c 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/RootHalLinkFactory.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/RootHalLinkFactory.java @@ -30,7 +30,7 @@ public class RootHalLinkFactory extends HalLinkFactory list) throws Exception { - String dspaceRestUrl = configurationService.getProperty("dspace.server.url"); + String dspaceServerUrl = configurationService.getProperty("dspace.server.url"); list.add( - buildLink("script", dspaceRestUrl + "/api/system/scripts/" + halResource.getContent().getScriptName())); + buildLink("script", dspaceServerUrl + "/api/system/scripts/" + halResource.getContent().getScriptName())); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/RootRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/RootRest.java index bb20ef9e43..3079f1a0c2 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/RootRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/RootRest.java @@ -17,9 +17,9 @@ import org.dspace.app.rest.RootRestResourceController; public class RootRest extends RestAddressableModel { public static final String NAME = "root"; public static final String CATEGORY = RestModel.ROOT; - private String dspaceURL; + private String dspaceUI; private String dspaceName; - private String dspaceRest; + private String dspaceServer; public String getCategory() { return CATEGORY; @@ -33,13 +33,13 @@ public class RootRest extends RestAddressableModel { return RootRestResourceController.class; } - public String getDspaceURL() { + public String getDspaceUI() { - return dspaceURL; + return dspaceUI; } - public void setDspaceURL(String dspaceURL) { - this.dspaceURL = dspaceURL; + public void setDspaceUI(String dspaceUI) { + this.dspaceUI = dspaceUI; } public String getDspaceName() { @@ -50,12 +50,12 @@ public class RootRest extends RestAddressableModel { this.dspaceName = dspaceName; } - public String getDspaceRest() { - return dspaceRest; + public String getDspaceServer() { + return dspaceServer; } - public void setDspaceRest(String dspaceRest) { - this.dspaceRest = dspaceRest; + public void setDspaceServer(String dspaceServerURL) { + this.dspaceServer = dspaceServerURL; } @Override @@ -64,9 +64,9 @@ public class RootRest extends RestAddressableModel { new EqualsBuilder().append(this.getCategory(), ((RootRest) object).getCategory()) .append(this.getType(), ((RootRest) object).getType()) .append(this.getController(), ((RootRest) object).getController()) - .append(this.getDspaceURL(), ((RootRest) object).getDspaceURL()) + .append(this.getDspaceUI(), ((RootRest) object).getDspaceUI()) .append(this.getDspaceName(), ((RootRest) object).getDspaceName()) - .append(this.getDspaceRest(), ((RootRest) object).getDspaceRest()) + .append(this.getDspaceServer(), ((RootRest) object).getDspaceServer()) .isEquals()); } @@ -77,8 +77,8 @@ public class RootRest extends RestAddressableModel { .append(this.getType()) .append(this.getController()) .append(this.getDspaceName()) - .append(this.getDspaceURL()) - .append(this.getDspaceRest()) + .append(this.getDspaceUI()) + .append(this.getDspaceServer()) .toHashCode(); } } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/RootRestResourceControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/RootRestResourceControllerIT.java index ad69790cbf..6c1c4a9427 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/RootRestResourceControllerIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/RootRestResourceControllerIT.java @@ -33,9 +33,9 @@ public class RootRestResourceControllerIT extends AbstractControllerIntegrationT .andExpect(status().isOk()) //We expect the content type to be "application/hal+json;charset=UTF-8" .andExpect(content().contentType(contentType)) - .andExpect(jsonPath("$.dspaceURL", Matchers.is("http://localhost:4000"))) + .andExpect(jsonPath("$.dspaceUI", Matchers.is("http://localhost:4000"))) .andExpect(jsonPath("$.dspaceName", Matchers.is("DSpace at My University"))) - .andExpect(jsonPath("$.dspaceRest", Matchers.is(BASE_REST_SERVER_URL))) + .andExpect(jsonPath("$.dspaceServer", Matchers.is(BASE_REST_SERVER_URL))) .andExpect(jsonPath("$.type", Matchers.is("root"))); } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/RootConverterTest.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/RootConverterTest.java index 36124f9502..3cbda52272 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/RootConverterTest.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/RootConverterTest.java @@ -48,9 +48,9 @@ public class RootConverterTest { public void testCorrectPropertiesSetFromConfigurationService() throws Exception { String restUrl = "rest"; RootRest rootRest = rootConverter.convert(); - assertEquals("dspaceurl", rootRest.getDspaceURL()); + assertEquals("dspaceurl", rootRest.getDspaceUI()); assertEquals("dspacename", rootRest.getDspaceName()); - assertEquals(restUrl, rootRest.getDspaceRest()); + assertEquals(restUrl, rootRest.getDspaceServer()); } @Test From 746fa4fd27a704cc44827ee457bf0a80f1087857 Mon Sep 17 00:00:00 2001 From: Mykhaylo Date: Wed, 3 Jun 2020 21:41:21 +0200 Subject: [PATCH 088/125] splitted links in their owner repository --- .../link/RootDiscoverableNestedLinks.java | 70 ------------------- .../repository/AuthorityRestRepository.java | 18 ++++- .../repository/ClaimedTaskRestRepository.java | 17 ++++- .../repository/EPersonRestRepository.java | 16 ++++- .../repository/PoolTaskRestRepository.java | 17 ++++- .../ResourcePolicyRestRepository.java | 17 ++++- .../app/rest/AuthorityRestRepositoryIT.java | 15 ++++ .../app/rest/EPersonRestRepositoryIT.java | 14 ++++ .../rest/ResourcePolicyRestRepositoryIT.java | 13 ++++ .../rest/RootDiscoverableNestedLinksIT.java | 49 ------------- .../rest/WorkflowItemRestRepositoryIT.java | 17 +++++ 11 files changed, 139 insertions(+), 124 deletions(-) delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/link/RootDiscoverableNestedLinks.java delete mode 100644 dspace-server-webapp/src/test/java/org/dspace/app/rest/RootDiscoverableNestedLinksIT.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/RootDiscoverableNestedLinks.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/RootDiscoverableNestedLinks.java deleted file mode 100644 index 00a43b9db1..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/RootDiscoverableNestedLinks.java +++ /dev/null @@ -1,70 +0,0 @@ -/** - * 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.rest.link; - -import java.util.Arrays; - -import org.dspace.app.rest.DiscoverableEndpointsService; -import org.dspace.app.rest.model.AuthorizationRest; -import org.dspace.app.rest.model.ClaimedTaskRest; -import org.dspace.app.rest.model.EPersonRest; -import org.dspace.app.rest.model.PoolTaskRest; -import org.dspace.app.rest.model.ResourcePolicyRest; -import org.dspace.app.rest.repository.AuthorityRestRepository; -import org.dspace.app.rest.repository.ClaimedTaskRestRepository; -import org.dspace.app.rest.repository.EPersonRestRepository; -import org.dspace.app.rest.repository.PoolTaskRestRepository; -import org.dspace.app.rest.repository.ResourcePolicyRestRepository; -import org.springframework.beans.factory.InitializingBean; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.hateoas.Link; -import org.springframework.stereotype.Component; - -/** - * This class is responsible to add to the root endpoint the links to standard nested endpoint - * that are not discoverable due to limitation to access some resource collection endpoint via GET. - * If a custom endpoint should require to add extra links to the root is recommended to register - * them directly from the Repository class implementation or the custom controller. - * - * @author Mykhaylo Boychuk (mykhaylo.boychuk at 4science) - */ -@Component -public class RootDiscoverableNestedLinks implements InitializingBean { - - @Autowired - DiscoverableEndpointsService discoverableEndpointsService; - - @Override - public void afterPropertiesSet() throws Exception { - discoverableEndpointsService - .register(ResourcePolicyRestRepository.class , Arrays.asList(new Link("/api/" - + ResourcePolicyRest.CATEGORY + "/" + ResourcePolicyRest.NAME + "/search", - ResourcePolicyRest.NAME + "-search"))); - - discoverableEndpointsService - .register(AuthorityRestRepository.class , Arrays.asList(new Link("/api/" - + AuthorizationRest.CATEGORY + "/" + AuthorizationRest.NAME + "/search", - AuthorizationRest.NAME + "-search"))); - - discoverableEndpointsService - .register(ClaimedTaskRestRepository.class , Arrays.asList(new Link("/api/" - + ClaimedTaskRest.CATEGORY + "/" + ClaimedTaskRest.NAME + "/search", - ClaimedTaskRest.NAME + "-search"))); - - discoverableEndpointsService - .register(PoolTaskRestRepository.class , Arrays.asList(new Link("/api/" - + PoolTaskRest.CATEGORY + "/" + PoolTaskRest.NAME + "/search", - PoolTaskRest.NAME + "-search"))); - - discoverableEndpointsService - .register(EPersonRestRepository.class , Arrays.asList(new Link("/api/" - + EPersonRest.CATEGORY + "/registrations", EPersonRest.NAME + "-registration"))); - - } - -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorityRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorityRestRepository.java index 18120775d0..d5dda5a0bc 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorityRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorityRestRepository.java @@ -8,19 +8,24 @@ package org.dspace.app.rest.repository; import java.util.ArrayList; +import java.util.Arrays; import java.util.List; import java.util.Set; +import org.dspace.app.rest.DiscoverableEndpointsService; import org.dspace.app.rest.model.AuthorityRest; +import org.dspace.app.rest.model.AuthorizationRest; import org.dspace.app.rest.projection.Projection; import org.dspace.app.rest.utils.AuthorityUtils; import org.dspace.content.authority.ChoiceAuthority; import org.dspace.content.authority.service.ChoiceAuthorityService; import org.dspace.core.Context; +import org.springframework.beans.factory.InitializingBean; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.domain.Page; import org.springframework.data.domain.PageImpl; import org.springframework.data.domain.Pageable; +import org.springframework.hateoas.Link; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Component; @@ -30,7 +35,8 @@ import org.springframework.stereotype.Component; * @author Luigi Andrea Pascarelli (luigiandrea.pascarelli at 4science.it) */ @Component(AuthorityRest.CATEGORY + "." + AuthorityRest.NAME) -public class AuthorityRestRepository extends DSpaceRestRepository { +public class AuthorityRestRepository extends DSpaceRestRepository + implements InitializingBean { @Autowired private ChoiceAuthorityService cas; @@ -38,6 +44,9 @@ public class AuthorityRestRepository extends DSpaceRestRepository getDomainClass() { return AuthorityRest.class; } + + @Override + public void afterPropertiesSet() throws Exception { + discoverableEndpointsService.register(this, Arrays.asList( + new Link("/api/" + AuthorizationRest.CATEGORY + "/" + AuthorizationRest.NAME + "/search", + AuthorizationRest.NAME + "-search"))); + } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ClaimedTaskRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ClaimedTaskRestRepository.java index cb44c3c4cc..e3b9bfec61 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ClaimedTaskRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ClaimedTaskRestRepository.java @@ -9,6 +9,7 @@ package org.dspace.app.rest.repository; import java.io.IOException; import java.sql.SQLException; +import java.util.Arrays; import java.util.List; import java.util.UUID; import javax.mail.MessagingException; @@ -16,6 +17,7 @@ import javax.servlet.http.HttpServletRequest; import org.apache.commons.lang3.StringUtils; import org.apache.log4j.Logger; +import org.dspace.app.rest.DiscoverableEndpointsService; import org.dspace.app.rest.Parameter; import org.dspace.app.rest.SearchRestMethod; import org.dspace.app.rest.exception.RESTAuthorizationException; @@ -42,10 +44,12 @@ import org.dspace.xmlworkflow.state.actions.WorkflowActionConfig; import org.dspace.xmlworkflow.storedcomponents.ClaimedTask; import org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItem; import org.dspace.xmlworkflow.storedcomponents.service.ClaimedTaskService; +import org.springframework.beans.factory.InitializingBean; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.data.rest.webmvc.ResourceNotFoundException; +import org.springframework.hateoas.Link; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Component; @@ -56,7 +60,8 @@ import org.springframework.stereotype.Component; */ @Component(PoolTaskRest.CATEGORY + "." + ClaimedTaskRest.NAME) -public class ClaimedTaskRestRepository extends DSpaceRestRepository { +public class ClaimedTaskRestRepository extends DSpaceRestRepository + implements InitializingBean { private static final Logger log = Logger.getLogger(ClaimedTaskRestRepository.class); @@ -78,6 +83,9 @@ public class ClaimedTaskRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { throw new RepositoryMethodNotImplementedException(ClaimedTaskRest.NAME, "findAll"); } + + @Override + public void afterPropertiesSet() throws Exception { + discoverableEndpointsService.register(this, Arrays.asList( + new Link("/api/" + ClaimedTaskRest.CATEGORY + "/" + ClaimedTaskRest.NAME + "/search", + ClaimedTaskRest.NAME + "-search"))); + } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonRestRepository.java index 073d1b25bd..d8257d48d0 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonRestRepository.java @@ -9,12 +9,14 @@ package org.dspace.app.rest.repository; import java.io.IOException; import java.sql.SQLException; +import java.util.Arrays; import java.util.List; import java.util.UUID; import javax.servlet.http.HttpServletRequest; import com.fasterxml.jackson.databind.ObjectMapper; import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.DiscoverableEndpointsService; import org.dspace.app.rest.Parameter; import org.dspace.app.rest.SearchRestMethod; import org.dspace.app.rest.exception.UnprocessableEntityException; @@ -25,9 +27,11 @@ import org.dspace.authorize.service.AuthorizeService; import org.dspace.core.Context; import org.dspace.eperson.EPerson; import org.dspace.eperson.service.EPersonService; +import org.springframework.beans.factory.InitializingBean; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; +import org.springframework.hateoas.Link; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Component; @@ -39,11 +43,15 @@ import org.springframework.stereotype.Component; */ @Component(EPersonRest.CATEGORY + "." + EPersonRest.NAME) -public class EPersonRestRepository extends DSpaceObjectRestRepository { +public class EPersonRestRepository extends DSpaceObjectRestRepository + implements InitializingBean { @Autowired AuthorizeService authorizeService; + @Autowired + DiscoverableEndpointsService discoverableEndpointsService; + private final EPersonService es; @@ -195,4 +203,10 @@ public class EPersonRestRepository extends DSpaceObjectRestRepository getDomainClass() { return EPersonRest.class; } + + @Override + public void afterPropertiesSet() throws Exception { + discoverableEndpointsService.register(this, Arrays.asList( + new Link("/api/" + EPersonRest.CATEGORY + "/registrations", EPersonRest.NAME + "-registration"))); + } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/PoolTaskRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/PoolTaskRestRepository.java index cddc1e2286..8875dff3ea 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/PoolTaskRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/PoolTaskRestRepository.java @@ -9,12 +9,14 @@ package org.dspace.app.rest.repository; import java.io.IOException; import java.sql.SQLException; +import java.util.Arrays; import java.util.List; import java.util.UUID; import javax.mail.MessagingException; import javax.servlet.http.HttpServletRequest; import org.apache.log4j.Logger; +import org.dspace.app.rest.DiscoverableEndpointsService; import org.dspace.app.rest.Parameter; import org.dspace.app.rest.SearchRestMethod; import org.dspace.app.rest.exception.RESTAuthorizationException; @@ -36,10 +38,12 @@ import org.dspace.xmlworkflow.state.Workflow; import org.dspace.xmlworkflow.state.actions.WorkflowActionConfig; import org.dspace.xmlworkflow.storedcomponents.PoolTask; import org.dspace.xmlworkflow.storedcomponents.service.PoolTaskService; +import org.springframework.beans.factory.InitializingBean; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.data.rest.webmvc.ResourceNotFoundException; +import org.springframework.hateoas.Link; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Component; @@ -50,7 +54,8 @@ import org.springframework.stereotype.Component; */ @Component(PoolTaskRest.CATEGORY + "." + PoolTaskRest.NAME) -public class PoolTaskRestRepository extends DSpaceRestRepository { +public class PoolTaskRestRepository extends DSpaceRestRepository + implements InitializingBean { private static final Logger log = Logger.getLogger(PoolTaskRestRepository.class); @@ -72,6 +77,9 @@ public class PoolTaskRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { throw new RuntimeException("Method not allowed!"); } + + @Override + public void afterPropertiesSet() throws Exception { + discoverableEndpointsService.register(this, Arrays.asList( + new Link("/api/" + PoolTaskRest.CATEGORY + "/" + PoolTaskRest.NAME + "/search", + PoolTaskRest.NAME + "-search"))); + } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ResourcePolicyRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ResourcePolicyRestRepository.java index 009e0c4594..e67bcfa040 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ResourcePolicyRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ResourcePolicyRestRepository.java @@ -9,11 +9,13 @@ package org.dspace.app.rest.repository; import java.io.IOException; import java.sql.SQLException; +import java.util.Arrays; import java.util.List; import java.util.UUID; import javax.servlet.http.HttpServletRequest; import com.fasterxml.jackson.databind.ObjectMapper; +import org.dspace.app.rest.DiscoverableEndpointsService; import org.dspace.app.rest.Parameter; import org.dspace.app.rest.SearchRestMethod; import org.dspace.app.rest.exception.MissingParameterException; @@ -35,10 +37,12 @@ import org.dspace.eperson.EPerson; import org.dspace.eperson.Group; import org.dspace.eperson.service.EPersonService; import org.dspace.eperson.service.GroupService; +import org.springframework.beans.factory.InitializingBean; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.data.rest.webmvc.ResourceNotFoundException; +import org.springframework.hateoas.Link; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Component; @@ -48,7 +52,8 @@ import org.springframework.stereotype.Component; * @author Luigi Andrea Pascarelli (luigiandrea.pascarelli at 4science.it) */ @Component(ResourcePolicyRest.CATEGORY + "." + ResourcePolicyRest.NAME) -public class ResourcePolicyRestRepository extends DSpaceRestRepository { +public class ResourcePolicyRestRepository extends DSpaceRestRepository + implements InitializingBean { @Autowired ResourcePolicyService resourcePolicyService; @@ -68,6 +73,9 @@ public class ResourcePolicyRestRepository extends DSpaceRestRepository resourcePatch; + @Autowired + DiscoverableEndpointsService discoverableEndpointsService; + @Override @PreAuthorize("hasPermission(#id, 'resourcepolicy', 'READ')") public ResourcePolicyRest findOne(Context context, Integer id) { @@ -312,4 +320,11 @@ public class ResourcePolicyRestRepository extends DSpaceRestRepository Date: Thu, 4 Jun 2020 14:04:41 +0200 Subject: [PATCH 089/125] 71220: Configuration properties endpoint - PR feedback --- .../test/data/dspaceFolder/config/local.cfg | 3 ++ .../link/PropertyResourceHalLinkFactory.java | 37 ------------------- .../dspace/app/rest/model/PropertyRest.java | 10 ++++- .../ConfigurationRestRepository.java | 17 +++++---- .../rest/exposed-properties-configuration.xml | 14 ------- .../rest/ConfigurationRestRepositoryIT.java | 2 +- dspace/config/modules/rest.cfg | 6 +++ .../rest/exposed-properties-configuration.xml | 12 ------ 8 files changed, 29 insertions(+), 72 deletions(-) delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/link/PropertyResourceHalLinkFactory.java delete mode 100644 dspace-server-webapp/src/test/data/dspaceFolder/config/spring/rest/exposed-properties-configuration.xml delete mode 100644 dspace/config/spring/rest/exposed-properties-configuration.xml diff --git a/dspace-api/src/test/data/dspaceFolder/config/local.cfg b/dspace-api/src/test/data/dspaceFolder/config/local.cfg index 4550b3d626..51ce1a0165 100644 --- a/dspace-api/src/test/data/dspaceFolder/config/local.cfg +++ b/dspace-api/src/test/data/dspaceFolder/config/local.cfg @@ -113,6 +113,9 @@ plugin.sequence.java.util.Collection = \ # PROPERTIES USED TO TEST CONFIGURATION # # PROPERTY EXPOSURE VIA REST # ########################################### +rest.properties.exposed = configuration.exposed.single.value +rest.properties.exposed = configuration.exposed.array.value +rest.properties.exposed = configuration.not.existing configuration.not.exposed = secret_value configuration.exposed.single.value = public_value diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/PropertyResourceHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/PropertyResourceHalLinkFactory.java deleted file mode 100644 index 98d06179d2..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/PropertyResourceHalLinkFactory.java +++ /dev/null @@ -1,37 +0,0 @@ -/** - * 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.rest.link; - -import java.util.LinkedList; - -import org.dspace.app.rest.RestResourceController; -import org.dspace.app.rest.model.hateoas.PropertyResource; -import org.springframework.data.domain.Pageable; -import org.springframework.hateoas.Link; -import org.springframework.stereotype.Component; - -/** - * This class' purpose is to remove all links from the PropertyResource. - */ -@Component -public class PropertyResourceHalLinkFactory extends HalLinkFactory { - @Override - protected void addLinks(PropertyResource halResource, Pageable pageable, LinkedList list) throws Exception { - halResource.removeLinks(); - } - - @Override - protected Class getControllerClass() { - return RestResourceController.class; - } - - @Override - protected Class getResourceClass() { - return PropertyResource.class; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PropertyRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PropertyRest.java index a6b6fa73af..ada5f5db2f 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PropertyRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PropertyRest.java @@ -9,13 +9,15 @@ package org.dspace.app.rest.model; import java.util.List; +import com.fasterxml.jackson.annotation.JsonIgnore; import org.dspace.app.rest.RestResourceController; +import org.springframework.hateoas.Identifiable; /** * This class acts as the REST representation of a DSpace configuration property. * This class acts as a data holder for the PropertyResource */ -public class PropertyRest extends RestAddressableModel { +public class PropertyRest extends RestAddressableModel implements Identifiable { public static final String NAME = "property"; public static final String CATEGORY = RestAddressableModel.CONFIGURATION; @@ -38,6 +40,12 @@ public class PropertyRest extends RestAddressableModel { public String name; public List values; + @Override + @JsonIgnore + public String getId() { + return this.name; + } + @Override public String getCategory() { return CATEGORY; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRestRepository.java index 1b35d07794..4a696bb664 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRestRepository.java @@ -7,9 +7,8 @@ */ package org.dspace.app.rest.repository; -import java.util.ArrayList; import java.util.Arrays; -import javax.annotation.Resource; +import java.util.List; import org.dspace.app.rest.exception.RepositoryMethodNotImplementedException; import org.dspace.app.rest.model.PropertyRest; @@ -26,11 +25,15 @@ import org.springframework.stereotype.Component; */ @Component(PropertyRest.CATEGORY + "." + PropertyRest.NAME) public class ConfigurationRestRepository extends DSpaceRestRepository { - @Autowired - private ConfigurationService configurationService; - @Resource(name = "exposedConfigurationProperties") - private ArrayList exposedProperties; + private ConfigurationService configurationService; + private List exposedProperties; + + @Autowired + public ConfigurationRestRepository(ConfigurationService configurationService) { + this.configurationService = configurationService; + this.exposedProperties = Arrays.asList(configurationService.getArrayProperty("rest.properties.exposed")); + } /** * Gets the value of a configuration property if it is exposed via REST @@ -49,7 +52,7 @@ public class ConfigurationRestRepository extends DSpaceRestRepository - - - - - configuration.exposed.single.value - configuration.exposed.array.value - configuration.not.existing - - \ No newline at end of file diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ConfigurationRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ConfigurationRestRepositoryIT.java index f1ecc474b4..1eab1ef68e 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ConfigurationRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ConfigurationRestRepositoryIT.java @@ -25,7 +25,7 @@ public class ConfigurationRestRepositoryIT extends AbstractControllerIntegration .andExpect(jsonPath("$.values[0]", is("public_value"))) .andExpect(jsonPath("$.type", is("property"))) .andExpect(jsonPath("$.name", is("configuration.exposed.single.value"))) - .andExpect(jsonPath("$._links").doesNotExist()); + .andExpect(jsonPath("$._links.self.href", is("http://localhost/api/config/properties/configuration.exposed.single.value"))); } @Test diff --git a/dspace/config/modules/rest.cfg b/dspace/config/modules/rest.cfg index 2e13d73f97..29e5c1d77e 100644 --- a/dspace/config/modules/rest.cfg +++ b/dspace/config/modules/rest.cfg @@ -152,3 +152,9 @@ rest.report-regex-non-ascii = ^.*[^\\p{ASCII}].*$ # The maximum number of results to return for 1 request rest.search.max.results = 100 + +# Define which configuration properties are exposed through the http:///api/config/properties/ +# rest endpoint. If a rest request is made for a property which exists, but isn't listed here, the server will +# respond that the property wasn't found. This property can be defined multiple times to allow access to multiple +# configuration properties. +rest.properties.exposed = google.analytics.key diff --git a/dspace/config/spring/rest/exposed-properties-configuration.xml b/dspace/config/spring/rest/exposed-properties-configuration.xml deleted file mode 100644 index 159d2ed8a3..0000000000 --- a/dspace/config/spring/rest/exposed-properties-configuration.xml +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - google.analytics.key - - \ No newline at end of file From 099caaf86f2c0f7eb3d6f9402a75021549fb5f82 Mon Sep 17 00:00:00 2001 From: Yana De Pauw Date: Thu, 4 Jun 2020 16:38:37 +0200 Subject: [PATCH 090/125] 71266: Community feedback #1 --- .../SubmissionCCLicenseSearchController.java | 2 +- .../SubmissionCCLicenseRestRepository.java | 4 +- .../rest/CCLicenseRemovePatchOperationIT.java | 42 +++++++++++++++++-- .../SubmissionCCLicenseRestRepositoryIT.java | 25 +++++++++-- ...SubmissionCCLicenseSearchControllerIT.java | 31 +++++++++++--- 5 files changed, 90 insertions(+), 14 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java index 17116884cf..76ed1021d3 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java @@ -34,7 +34,7 @@ import org.springframework.web.bind.annotation.RestController; @RestController @RequestMapping("/api/" + SubmissionCCLicenseRest.CATEGORY + "/" + SubmissionCCLicenseRest.PLURAL + "/search" + "/rightsByQuestions") -@PreAuthorize("permitAll()") +@PreAuthorize("hasAuthority('AUTHENTICATED')") public class SubmissionCCLicenseSearchController { @Autowired diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java index 6d3cf03237..0dab42f9bd 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionCCLicenseRestRepository.java @@ -30,7 +30,7 @@ public class SubmissionCCLicenseRestRepository extends DSpaceRestRepository findAll(final Context context, final Pageable pageable) { List allCCLicenses = creativeCommonsService.findAllCCLicenses(); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java index afee0aa882..40828a7667 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java @@ -59,7 +59,7 @@ public class CCLicenseRemovePatchOperationIT extends AbstractControllerIntegrati context.restoreAuthSystemState(); - String adminToken = getAuthToken(admin.getEmail(), password); + String epersonToken = getAuthToken(eperson.getEmail(), password); // First add a license and verify it is added List ops = new ArrayList(); @@ -70,7 +70,7 @@ public class CCLicenseRemovePatchOperationIT extends AbstractControllerIntegrati String patchBody = getPatchContent(ops); - getClient(adminToken).perform(patch("/api/submission/workspaceitems/" + workspaceItem.getID()) + getClient(epersonToken).perform(patch("/api/submission/workspaceitems/" + workspaceItem.getID()) .content(patchBody) .contentType(MediaType.APPLICATION_JSON_PATCH_JSON)) .andExpect(status().isOk()) @@ -91,10 +91,46 @@ public class CCLicenseRemovePatchOperationIT extends AbstractControllerIntegrati String removePatch = getPatchContent(removeOps); - getClient(adminToken).perform(patch("/api/submission/workspaceitems/" + workspaceItem.getID()) + getClient(epersonToken).perform(patch("/api/submission/workspaceitems/" + workspaceItem.getID()) .content(removePatch) .contentType(MediaType.APPLICATION_JSON_PATCH_JSON)) .andExpect(status().isOk()) .andExpect(jsonPath("$.sections", not(hasJsonPath("cclicense")))); } + + + @Test + public void patchRemoveSubmissionCCLicenseNonExisting() throws Exception { + context.turnOffAuthorisationSystem(); + + Community community = CommunityBuilder.createCommunity(context) + .withName("Community") + .build(); + + Collection collection = CollectionBuilder.createCollection(context, community) + .withName("Collection") + .build(); + + WorkspaceItem workspaceItem = WorkspaceItemBuilder.createWorkspaceItem(context, collection) + .withTitle("Workspace Item") + .build(); + + context.restoreAuthSystemState(); + + String epersonToken = getAuthToken(eperson.getEmail(), password); + + + List removeOps = new ArrayList(); + RemoveOperation removeOperation = new RemoveOperation("/sections/cclicense/uri"); + + removeOps.add(removeOperation); + String removePatch = getPatchContent(removeOps); + + + getClient(epersonToken).perform(patch("/api/submission/workspaceitems/" + workspaceItem.getID()) + .content(removePatch) + .contentType(MediaType.APPLICATION_JSON_PATCH_JSON)) + .andExpect(status().isOk()) + .andExpect(jsonPath("$.sections", not(hasJsonPath("cclicense")))); + } } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseRestRepositoryIT.java index 5fa22470fe..9267cef6c5 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseRestRepositoryIT.java @@ -34,8 +34,9 @@ public class SubmissionCCLicenseRestRepositoryIT extends AbstractControllerInteg */ @Test public void findAllTest() throws Exception { + String epersonToken = getAuthToken(eperson.getEmail(), password); - getClient().perform(get("/api/config/submissioncclicenses")) + getClient(epersonToken).perform(get("/api/config/submissioncclicenses")) .andExpect(status().isOk()) .andExpect(content().contentType(contentType)) .andExpect(jsonPath("$._embedded.submissioncclicenses", Matchers.containsInAnyOrder( @@ -47,7 +48,9 @@ public class SubmissionCCLicenseRestRepositoryIT extends AbstractControllerInteg @Test public void findOneTest() throws Exception { - getClient().perform(get("/api/config/submissioncclicenses/license1")) + String epersonToken = getAuthToken(eperson.getEmail(), password); + + getClient(epersonToken).perform(get("/api/config/submissioncclicenses/license1")) .andExpect(status().isOk()) .andExpect(content().contentType(contentType)) .andExpect(jsonPath("$", Matchers.is( @@ -57,7 +60,23 @@ public class SubmissionCCLicenseRestRepositoryIT extends AbstractControllerInteg @Test public void findOneTestNonExistingLicense() throws Exception { - getClient().perform(get("/api/config/submissioncclicenses/non-existing-license")) + String epersonToken = getAuthToken(eperson.getEmail(), password); + + getClient(epersonToken).perform(get("/api/config/submissioncclicenses/non-existing-license")) .andExpect(status().isNotFound()); } + + @Test + public void findAllTestUnAuthorized() throws Exception { + getClient().perform(get("/api/config/submissioncclicenses")) + .andExpect(status().isUnauthorized()); + } + + @Test + public void findOneTestUnAuthorized() throws Exception { + + getClient().perform(get("/api/config/submissioncclicenses/license1")) + .andExpect(status().isUnauthorized()); + } + } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java index 30734c8cac..8a93e18a8e 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java @@ -29,7 +29,9 @@ public class SubmissionCCLicenseSearchControllerIT extends AbstractControllerInt @Test public void searchRightsByQuestionsTest() throws Exception { - getClient().perform(get( + String epersonToken = getAuthToken(eperson.getEmail(), password); + + getClient(epersonToken).perform(get( "/api/config/submissioncclicenses/search/rightsByQuestions?license=license2&answer_license2-field0" + "=license2-field0-enum1")) .andExpect(status().isOk()) @@ -43,7 +45,10 @@ public class SubmissionCCLicenseSearchControllerIT extends AbstractControllerInt @Test public void searchRightsByQuestionsTestLicenseWithoutFields() throws Exception { - getClient().perform(get("/api/config/submissioncclicenses/search/rightsByQuestions?license=license3")) + String epersonToken = getAuthToken(eperson.getEmail(), password); + + getClient(epersonToken) + .perform(get("/api/config/submissioncclicenses/search/rightsByQuestions?license=license3")) .andExpect(status().isOk()) .andExpect(jsonPath("$.url", is("mock-license-uri"))) .andExpect(jsonPath("$.type", is("submissioncclicenseUrl"))) @@ -54,7 +59,9 @@ public class SubmissionCCLicenseSearchControllerIT extends AbstractControllerInt @Test public void searchRightsByQuestionsNonExistingLicense() throws Exception { - getClient().perform(get( + String epersonToken = getAuthToken(eperson.getEmail(), password); + + getClient(epersonToken).perform(get( "/api/config/submissioncclicenses/search/rightsByQuestions?license=nonexisting-license" + "&answer_license2-field0=license2-field0-enum1")) .andExpect(status().isNotFound()); @@ -62,7 +69,9 @@ public class SubmissionCCLicenseSearchControllerIT extends AbstractControllerInt @Test public void searchRightsByQuestionsMissingRequiredAnswer() throws Exception { - getClient().perform(get( + String epersonToken = getAuthToken(eperson.getEmail(), password); + + getClient(epersonToken).perform(get( "/api/config/submissioncclicenses/search/rightsByQuestions?license=license1&answer_license1field0" + "=license1field0enum1")) .andExpect(status().isBadRequest()); @@ -70,9 +79,21 @@ public class SubmissionCCLicenseSearchControllerIT extends AbstractControllerInt @Test public void searchRightsByQuestionsAdditionalNonExistingAnswer() throws Exception { - getClient().perform(get( + String epersonToken = getAuthToken(eperson.getEmail(), password); + + getClient(epersonToken).perform(get( "/api/config/submissioncclicenses/search/rightsByQuestions?license=license2" + "&answer_license2field0=license2field0enum1&answer_nonexisting=test")) .andExpect(status().isBadRequest()); } + + @Test + public void searchRightsByQuestionsAdditionalUnAuthorized() throws Exception { + + getClient().perform(get( + "/api/config/submissioncclicenses/search/rightsByQuestions?license=license2&answer_license2-field0" + + "=license2-field0-enum1")) + .andExpect(status().isUnauthorized()); + + } } From 397a156186f33333e83e16bebb3b3940761fe5e7 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Fri, 5 Jun 2020 13:56:39 +0200 Subject: [PATCH 091/125] [Task 71143] Intermediate work on PreAuthorize annotation parsing --- .../app/rest/converter/ConverterService.java | 78 ++++++----------- .../WebSecurityExpressionEvaluator.java | 56 ++++++++++++ .../spel/ExpressionValidationException.java | 7 -- .../app/rest/spel/ExpressionValidator.java | 86 ------------------- 4 files changed, 82 insertions(+), 145 deletions(-) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WebSecurityExpressionEvaluator.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/spel/ExpressionValidationException.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/spel/ExpressionValidator.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java index cbff22f9a2..e1d282fc8b 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java @@ -31,9 +31,9 @@ import org.dspace.app.rest.projection.DefaultProjection; import org.dspace.app.rest.projection.Projection; import org.dspace.app.rest.repository.DSpaceRestRepository; import org.dspace.app.rest.security.DSpacePermissionEvaluator; -import org.dspace.app.rest.spel.ExpressionValidationException; -import org.dspace.app.rest.spel.ExpressionValidator; +import org.dspace.app.rest.security.WebSecurityExpressionEvaluator; import org.dspace.app.rest.utils.Utils; +import org.dspace.services.RequestService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.config.BeanDefinition; import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider; @@ -42,14 +42,9 @@ import org.springframework.core.type.filter.AssignableTypeFilter; import org.springframework.data.domain.Page; import org.springframework.data.domain.PageImpl; import org.springframework.data.domain.Pageable; -import org.springframework.expression.Expression; -import org.springframework.expression.ExpressionParser; -import org.springframework.expression.spel.standard.SpelExpressionParser; import org.springframework.hateoas.EntityModel; import org.springframework.hateoas.Link; -import org.springframework.security.access.expression.SecurityExpressionRoot; import org.springframework.security.access.prepost.PreAuthorize; -import org.springframework.security.core.context.SecurityContextHolder; import org.springframework.stereotype.Component; import org.springframework.stereotype.Service; @@ -83,6 +78,12 @@ public class ConverterService { @Autowired private DSpacePermissionEvaluator dSpacePermissionEvaluator; + @Autowired + private WebSecurityExpressionEvaluator webSecurityExpressionEvaluator; + + @Autowired + private RequestService requestService; + /** * Converts the given model object to a rest object, using the appropriate {@link DSpaceConverter} and * the given projection. @@ -106,19 +107,12 @@ public class ConverterService { DSpaceConverter converter = requireConverter(modelObject.getClass()); R restObject = converter.convert(transformedModel, projection); if (restObject instanceof BaseObjectRest) { - String permission = getPermissionForRestObject((BaseObjectRest) restObject); - if (!StringUtils.equalsIgnoreCase(permission, "permitAll")) { - if (StringUtils.equalsIgnoreCase(permission, "admin")) { - //TODO - } else if (StringUtils.equalsIgnoreCase(permission, "authenticated")) { - //TODO - } else { - if (!dSpacePermissionEvaluator.hasPermission(SecurityContextHolder.getContext().getAuthentication(), - restObject, permission)) { - log.info("Access denied on " + restObject.getClass()); - return null; - } - } + String preAuthorizeValue = getPreAuthorizeAnnotationForBaseObject((BaseObjectRest) restObject); + if (!webSecurityExpressionEvaluator + .evaluate(preAuthorizeValue, requestService.getCurrentRequest().getHttpServletRequest(), + requestService.getCurrentRequest().getHttpServletResponse())) { + log.info("Access denied on " + restObject.getClass()); + return null; } } if (restObject instanceof RestModel) { @@ -127,41 +121,21 @@ public class ConverterService { return restObject; } - private String getPermissionForRestObject(BaseObjectRest restObject) { + private String getPreAuthorizeAnnotationForBaseObject(BaseObjectRest restObject) { Annotation preAuthorize = getAnnotationForRestObject(restObject); if (preAuthorize == null) { preAuthorize = getDefaultFindOnePreAuthorize(); } - String permission = "READ"; - permission = parseAnnotation(preAuthorize); - return permission; + return parseAnnotation(preAuthorize); + } private String parseAnnotation(Annotation preAuthorize) { - String permission = ""; if (preAuthorize != null) { - String annotationValue = (String) AnnotationUtils.getValue(preAuthorize); - ExpressionValidator validator = new ExpressionValidator(); - try { - validator.validate("hasPermission(123, 'ITEM', 'WRITE')", SecurityExpressionRoot.class); - } catch (ExpressionValidationException e) { - e.printStackTrace(); - } - -// ExpressionParser parser = new SpelExpressionParser(); -// Expression exp = parser.parseExpression("hasPermission('123', 'ITEM', 'WRITE')"); -// exp.getValue(SecurityExpressionRoot.class, boolean.class); - if (StringUtils.contains(annotationValue, "permitAll")) { - permission = "permitAll"; - } else if (StringUtils.contains(annotationValue, "hasAuthority")) { - permission = StringUtils.substringBetween(annotationValue, "hasAuthority('", "')"); - } else if (StringUtils.contains(annotationValue,"hasPermission")) { - permission = StringUtils.split(annotationValue, ",")[2]; - permission = StringUtils.substringBetween(permission, "'"); - } + return (String) AnnotationUtils.getValue(preAuthorize); } - return permission; + return null; } private Annotation getAnnotationForRestObject(BaseObjectRest restObject) { @@ -410,19 +384,19 @@ public class ConverterService { ClassPathScanningCandidateComponentProvider provider = new ClassPathScanningCandidateComponentProvider(false); provider.addIncludeFilter(new AssignableTypeFilter(EntityModel.class)); Set beanDefinitions = provider.findCandidateComponents( - HALResource.class.getPackage().getName().replaceAll("\\.", "/")); + HALResource.class.getPackage().getName().replaceAll("\\.", "/")); for (BeanDefinition beanDefinition : beanDefinitions) { String resourceClassName = beanDefinition.getBeanClassName(); String resourceClassSimpleName = resourceClassName.substring(resourceClassName.lastIndexOf(".") + 1); String restClassSimpleName = resourceClassSimpleName - .replaceAll("ResourceWrapper$", "RestWrapper") - .replaceAll("Resource$", "Rest"); + .replaceAll("ResourceWrapper$", "RestWrapper") + .replaceAll("Resource$", "Rest"); String restClassName = RestModel.class.getPackage().getName() + "." + restClassSimpleName; try { Class restClass = - (Class) Class.forName(restClassName); + (Class) Class.forName(restClassName); Class> resourceClass = - (Class>) Class.forName(resourceClassName); + (Class>) Class.forName(resourceClassName); Constructor compatibleConstructor = null; for (Constructor constructor : resourceClass.getDeclaredConstructors()) { if (constructor.getParameterCount() == 2 && constructor.getParameterTypes()[1] == Utils.class) { @@ -436,11 +410,11 @@ public class ConverterService { resourceConstructors.put(restClass, compatibleConstructor); } else { log.warn("Skipping registration of resource class " + resourceClassName - + "; compatible constructor not found"); + + "; compatible constructor not found"); } } catch (ClassNotFoundException e) { log.warn("Skipping registration of resource class " + resourceClassName - + "; rest class not found: " + restClassName); + + "; rest class not found: " + restClassName); } } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WebSecurityExpressionEvaluator.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WebSecurityExpressionEvaluator.java new file mode 100644 index 0000000000..ce8668e89f --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WebSecurityExpressionEvaluator.java @@ -0,0 +1,56 @@ +package org.dspace.app.rest.security; + +import java.util.List; +import javax.servlet.FilterChain; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import org.springframework.core.GenericTypeResolver; +import org.springframework.expression.EvaluationContext; +import org.springframework.expression.Expression; +import org.springframework.security.access.expression.ExpressionUtils; +import org.springframework.security.access.expression.SecurityExpressionHandler; +import org.springframework.security.core.Authentication; +import org.springframework.security.core.context.SecurityContextHolder; +import org.springframework.security.web.FilterInvocation; +import org.springframework.stereotype.Component; + +@Component +public class WebSecurityExpressionEvaluator { + + private static final FilterChain EMPTY_CHAIN = (request, response) -> { + throw new UnsupportedOperationException(); + }; + + private final List securityExpressionHandlers; + + public WebSecurityExpressionEvaluator(List securityExpressionHandlers) { + this.securityExpressionHandlers = securityExpressionHandlers; + } + + public boolean evaluate(String securityExpression, HttpServletRequest request, HttpServletResponse response) { + SecurityExpressionHandler handler = getFilterSecurityHandler(); + + Expression expression = handler.getExpressionParser().parseExpression(securityExpression); + + EvaluationContext evaluationContext = createEvaluationContext(handler, request, response); + + return ExpressionUtils.evaluateAsBoolean(expression, evaluationContext); + } + + @SuppressWarnings("unchecked") + private EvaluationContext createEvaluationContext(SecurityExpressionHandler handler, HttpServletRequest request, HttpServletResponse response) { + Authentication authentication = SecurityContextHolder.getContext().getAuthentication(); + FilterInvocation filterInvocation = new FilterInvocation(request, response, EMPTY_CHAIN); + + return handler.createEvaluationContext(authentication, filterInvocation); + } + + private SecurityExpressionHandler getFilterSecurityHandler() { + return securityExpressionHandlers.stream() + .filter(handler -> FilterInvocation.class.equals(GenericTypeResolver + .resolveTypeArgument(handler.getClass(), SecurityExpressionHandler.class))) + .findAny() + .orElseThrow(() -> new IllegalStateException("No filter invocation security expression handler has been found! Handlers: " + securityExpressionHandlers.size())); + } +} \ No newline at end of file diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/spel/ExpressionValidationException.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/spel/ExpressionValidationException.java deleted file mode 100644 index 9fbe73f19f..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/spel/ExpressionValidationException.java +++ /dev/null @@ -1,7 +0,0 @@ -package org.dspace.app.rest.spel; - -public class ExpressionValidationException extends Exception { - public ExpressionValidationException(String message) { - super(message); - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/spel/ExpressionValidator.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/spel/ExpressionValidator.java deleted file mode 100644 index 8cf1dc2a6c..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/spel/ExpressionValidator.java +++ /dev/null @@ -1,86 +0,0 @@ -package org.dspace.app.rest.spel; - -import org.springframework.expression.ExpressionParser; -import org.springframework.expression.ParseException; -import org.springframework.expression.spel.SpelNode; -import org.springframework.expression.spel.ast.BeanReference; -import org.springframework.expression.spel.ast.MethodReference; -import org.springframework.expression.spel.ast.Operator; -import org.springframework.expression.spel.ast.TypeReference; -import org.springframework.expression.spel.ast.VariableReference; -import org.springframework.expression.spel.standard.SpelExpression; -import org.springframework.expression.spel.standard.SpelExpressionParser; -import org.springframework.security.access.expression.SecurityExpressionRoot; -import org.springframework.security.core.Authentication; -import org.springframework.security.core.context.SecurityContextHolder; - -import java.lang.reflect.InvocationTargetException; -import java.lang.reflect.Method; - -public class ExpressionValidator { - private final ExpressionParser parser = new SpelExpressionParser(); - - public void validate(String expression, Class expressionRoot) throws ExpressionValidationException, ParseException { - SpelExpression exp = (SpelExpression) parser.parseExpression(expression); - if (expressionRoot != null) { - SpelNode node = exp.getAST(); - handle(node, expressionRoot); - } - } - - private void handle(SpelNode node, Class expressionRoot) throws ExpressionValidationException{ - if (node instanceof MethodReference) { - verify((MethodReference) node, expressionRoot); - } else if (node instanceof Operator) { - Operator operator = (Operator) node; - handle(operator.getLeftOperand(), expressionRoot); - handle(operator.getRightOperand(), expressionRoot); - } else if (node != null) { - for(int i=0; i expressionRoot) throws ExpressionValidationException { - String methodName = node.getName(); - int args = node.getChildCount(); - Method[] methods = expressionRoot.getDeclaredMethods(); - for(Method m : methods) { - if (m.getName().equals(methodName)) { - // exact match on the args - if (args == m.getParameterCount()) { - try { - SecurityExpressionRoot.class.getConstructor(Authentication.class).newInstance( - SecurityContextHolder.getContext().getAuthentication()); - } catch (InstantiationException | IllegalAccessException | InvocationTargetException | NoSuchMethodException e) { - e.printStackTrace(); - } - return; - } - Class[] parameterTypes = m.getParameterTypes(); - if (m.getName().equals(methodName) && - parameterTypes != null && - parameterTypes.length>=1 && - parameterTypes[parameterTypes.length-1].isArray()) { - // allow the number of params to be one less or >= the reported length - if(args == m.getParameterCount()-1 || args >= m.getParameterCount()) { - return; - } - } - } - } - // if we get here, then we were unable to match the method call - String pattern = "Unable to match method %s with %d params"; - throw new ExpressionValidationException(String.format(pattern, methodName, args)); - } - -} From 26f6a7d0d879221845b5bac7f79f8c5bf5f107f4 Mon Sep 17 00:00:00 2001 From: Mykhaylo Date: Fri, 5 Jun 2020 17:13:37 +0200 Subject: [PATCH 092/125] Implement community feedbacks --- .../dspace/content/CollectionServiceImpl.java | 74 +++++++++++++++++++ .../content/service/CollectionService.java | 32 ++++++++ .../repository/CollectionRestRepository.java | 65 +++------------- dspace/solr/search/conf/schema.xml | 2 + 4 files changed, 117 insertions(+), 56 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/content/CollectionServiceImpl.java b/dspace-api/src/main/java/org/dspace/content/CollectionServiceImpl.java index c4f8d288b3..dbe34a2051 100644 --- a/dspace-api/src/main/java/org/dspace/content/CollectionServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/CollectionServiceImpl.java @@ -17,11 +17,13 @@ import java.util.Iterator; import java.util.List; import java.util.Map; import java.util.MissingResourceException; +import java.util.Set; import java.util.UUID; import org.apache.commons.collections4.CollectionUtils; import org.apache.commons.lang3.StringUtils; import org.apache.logging.log4j.Logger; +import org.apache.solr.client.solrj.util.ClientUtils; import org.dspace.app.util.AuthorizeUtil; import org.dspace.authorize.AuthorizeConfiguration; import org.dspace.authorize.AuthorizeException; @@ -40,6 +42,13 @@ import org.dspace.core.Context; import org.dspace.core.I18nUtil; import org.dspace.core.LogManager; import org.dspace.core.service.LicenseService; +import org.dspace.discovery.DiscoverQuery; +import org.dspace.discovery.DiscoverResult; +import org.dspace.discovery.IndexableObject; +import org.dspace.discovery.SearchService; +import org.dspace.discovery.SearchServiceException; +import org.dspace.discovery.indexobject.IndexableCollection; +import org.dspace.eperson.EPerson; import org.dspace.eperson.Group; import org.dspace.eperson.service.GroupService; import org.dspace.eperson.service.SubscribeService; @@ -100,6 +109,9 @@ public class CollectionServiceImpl extends DSpaceObjectServiceImpl i @Autowired(required = true) protected CollectionRoleService collectionRoleService; + @Autowired(required = true) + protected SearchService searchService; + protected CollectionServiceImpl() { super(); } @@ -907,4 +919,66 @@ public class CollectionServiceImpl extends DSpaceObjectServiceImpl i return role; } + @Override + public List findAuthorizedCollectionsInSOLR(String q, Context context, Community community, + int offset, int limit) throws SQLException, SearchServiceException { + + List collections = new ArrayList(); + StringBuilder query = new StringBuilder(); + DiscoverQuery discoverQuery = new DiscoverQuery(); + discoverQuery.setDSpaceObjectFilter(IndexableCollection.TYPE); + discoverQuery.setStart(offset); + discoverQuery.setMaxResults(limit); + DiscoverResult resp = resultSolrQuery(context, query, discoverQuery,community, q); + for (IndexableObject solrCollections : resp.getIndexableObjects()) { + Collection c = ((IndexableCollection) solrCollections).getIndexedObject(); + collections.add(c); + } + return collections; + } + + @Override + public int countAuthorizedCollectionsInSOLR(String q, Context context, Community community) + throws SQLException, SearchServiceException { + + StringBuilder query = new StringBuilder(); + DiscoverQuery discoverQuery = new DiscoverQuery(); + discoverQuery.setDSpaceObjectFilter(IndexableCollection.TYPE); + DiscoverResult resp = resultSolrQuery(context, query, discoverQuery,community,q); + return (int)resp.getTotalSearchResults(); + } + + private DiscoverResult resultSolrQuery(Context context, StringBuilder query, DiscoverQuery discoverQuery, + Community community, String q) throws SQLException, SearchServiceException { + + EPerson currentUser = context.getCurrentUser(); + if (!authorizeService.isAdmin(context)) { + Group anonymousGroup = groupService.findByName(context, Group.ANONYMOUS); + String anonGroupId = ""; + if (anonymousGroup != null) { + anonGroupId = anonymousGroup.getID().toString(); + } + query.append("submit:(g").append(anonGroupId); + if (currentUser != null) { + query.append(" OR e").append(currentUser.getID()); + } + Set groups = groupService.allMemberGroupsSet(context, currentUser); + for (Group group : groups) { + query.append(" OR g").append(group.getID()); + } + query.append(")"); + discoverQuery.addFilterQueries(query.toString()); + } + if (community != null) { + discoverQuery.addFilterQueries("location.comm:" + community.getID().toString()); + } + if (StringUtils.isNotBlank(q)) { + StringBuilder buildQuery = new StringBuilder(); + String escapedQuery = ClientUtils.escapeQueryChars(q); + buildQuery.append(escapedQuery).append(" OR ").append(escapedQuery).append("*"); + discoverQuery.setQuery(buildQuery.toString()); + } + DiscoverResult resp = searchService.search(context, discoverQuery); + return resp; + } } diff --git a/dspace-api/src/main/java/org/dspace/content/service/CollectionService.java b/dspace-api/src/main/java/org/dspace/content/service/CollectionService.java index 5038aef6d7..1194ac70b0 100644 --- a/dspace-api/src/main/java/org/dspace/content/service/CollectionService.java +++ b/dspace-api/src/main/java/org/dspace/content/service/CollectionService.java @@ -20,8 +20,10 @@ import org.dspace.content.Collection; import org.dspace.content.Community; import org.dspace.content.Item; import org.dspace.core.Context; +import org.dspace.discovery.SearchServiceException; import org.dspace.eperson.Group; + /** * Service interface class for the Collection object. * The implementation of this class is responsible for all business logic calls for the Collection object and is @@ -354,4 +356,34 @@ public interface CollectionService */ Group createDefaultReadGroup(Context context, Collection collection, String typeOfGroupString, int defaultRead) throws SQLException, AuthorizeException; + + /** + * + * @param q limit the returned collection to those with metadata values matching the query terms. + * The terms are used to make also a prefix query on SOLR so it can be used to implement + * an autosuggest feature over the collection name + * @param context DSpace Context + * @param community parent community + * @param offset the position of the first result to return + * @param limit paging limit + * @return discovery search result objects + * @throws SQLException if something goes wrong + * @throws SearchServiceException if search error + */ + public List findAuthorizedCollectionsInSOLR(String q, Context context, Community community, + int offset, int limit) throws SQLException, SearchServiceException; + + /** + * + * @param q limit the returned collection to those with metadata values matching the query terms. + * The terms are used to make also a prefix query on SOLR so it can be used to implement + * an autosuggest feature over the collection name + * @param context DSpace Context + * @param community parent community + * @return total collections found + * @throws SQLException if something goes wrong + * @throws SearchServiceException if search error + */ + public int countAuthorizedCollectionsInSOLR(String q, Context context, Community community) + throws SQLException, SearchServiceException; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java index c08bc69ca7..47b66c7933 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java @@ -11,7 +11,6 @@ import java.io.IOException; import java.sql.SQLException; import java.util.LinkedList; import java.util.List; -import java.util.Set; import java.util.SortedMap; import java.util.UUID; import javax.servlet.ServletInputStream; @@ -21,7 +20,6 @@ import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; import org.apache.commons.lang3.StringUtils; import org.apache.logging.log4j.Logger; -import org.apache.solr.client.solrj.util.ClientUtils; import org.dspace.app.rest.Parameter; import org.dspace.app.rest.SearchRestMethod; import org.dspace.app.rest.exception.DSpaceBadRequestException; @@ -56,7 +54,6 @@ import org.dspace.discovery.IndexableObject; import org.dspace.discovery.SearchService; import org.dspace.discovery.SearchServiceException; import org.dspace.discovery.indexobject.IndexableCollection; -import org.dspace.eperson.EPerson; import org.dspace.eperson.Group; import org.dspace.eperson.service.GroupService; import org.dspace.workflow.WorkflowException; @@ -178,70 +175,26 @@ public class CollectionRestRepository extends DSpaceObjectRestRepository collections = new LinkedList(); - DiscoverResult resp = discoverAuthorizedCollections(pageable, q, context, com); - long tot = resp.getTotalSearchResults(); - for (IndexableObject solrCollections : resp.getIndexableObjects()) { - Collection c = ((IndexableCollection) solrCollections).getIndexedObject(); - collections.add(c); - } + List collections = cs.findAuthorizedCollectionsInSOLR(q, context, com, + Math.toIntExact(pageable.getOffset()), + Math.toIntExact(pageable.getOffset() + pageable.getPageSize())); + int tot = cs.countAuthorizedCollectionsInSOLR(q, context, com); return converter.toRestPage(collections, pageable, tot , utils.obtainProjection()); } catch (SQLException | SearchServiceException e) { throw new RuntimeException(e.getMessage(), e); } } - private DiscoverResult discoverAuthorizedCollections(Pageable pageable, String q, Context context, Community com) - throws SQLException, SearchServiceException { - StringBuilder query = new StringBuilder(); - DiscoverQuery discoverQuery = new DiscoverQuery(); - discoverQuery.setDSpaceObjectFilter(IndexableCollection.TYPE); - discoverQuery.setStart(Math.toIntExact(pageable.getOffset())); - discoverQuery.setMaxResults(pageable.getPageSize()); - EPerson currentUser = context.getCurrentUser(); - if (!authorizeService.isAdmin(context)) { - Group anonymousGroup = groupService.findByName(context, Group.ANONYMOUS); - String anonGroupId = ""; - if (anonymousGroup != null) { - anonGroupId = anonymousGroup.getID().toString(); - } - query.append("submit:(g").append(anonGroupId); - if (currentUser != null) { - query.append(" OR e").append(currentUser.getID()); - } - Set groups = groupService.allMemberGroupsSet(context, currentUser); - for (Group group : groups) { - query.append(" OR g").append(group.getID()); - } - query.append(")"); - discoverQuery.addFilterQueries(query.toString()); - } - if (com != null) { - discoverQuery.addFilterQueries("location.comm:" + com.getID().toString()); - } - if (StringUtils.isNotBlank(q)) { - StringBuilder buildQuery = new StringBuilder(); - String escapedQuery = ClientUtils.escapeQueryChars(q); - buildQuery.append(escapedQuery).append(" OR ").append(escapedQuery).append("*"); - discoverQuery.setQuery(buildQuery.toString()); - } - DiscoverResult resp = searchService.search(context, discoverQuery); - return resp; - } - @SearchRestMethod(name = "findAuthorized") public Page findAuthorized(@Parameter(value = "query") String q, Pageable pageable) throws SearchServiceException { try { Context context = obtainContext(); - List collections = new LinkedList(); - DiscoverResult resp = discoverAuthorizedCollections(pageable, q, context, null); - long tot = resp.getTotalSearchResults(); - for (IndexableObject solrCollections : resp.getIndexableObjects()) { - Collection c = ((IndexableCollection) solrCollections).getIndexedObject(); - collections.add(c); - } - return converter.toRestPage(collections, pageable, tot , utils.obtainProjection()); + List collections = cs.findAuthorizedCollectionsInSOLR(q, context, null, + Math.toIntExact(pageable.getOffset()), + Math.toIntExact(pageable.getOffset() + pageable.getPageSize())); + int tot = cs.countAuthorizedCollectionsInSOLR(q, context, null); + return converter.toRestPage(collections, pageable, tot, utils.obtainProjection()); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); } diff --git a/dspace/solr/search/conf/schema.xml b/dspace/solr/search/conf/schema.xml index 60920eb5ee..e16e213135 100644 --- a/dspace/solr/search/conf/schema.xml +++ b/dspace/solr/search/conf/schema.xml @@ -254,12 +254,14 @@ + + From a7aeb102d4d714c26d9d4a138088cc40f1df1bef Mon Sep 17 00:00:00 2001 From: Peter Nijs Date: Fri, 5 Jun 2020 17:28:24 +0200 Subject: [PATCH 093/125] 71220: Configuration properties endpoint - PR feedback - fixes after merging with latest master --- .../src/main/java/org/dspace/app/rest/model/PropertyRest.java | 3 +-- .../app/rest/repository/ConfigurationRestRepository.java | 2 ++ 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PropertyRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PropertyRest.java index ada5f5db2f..365a679019 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PropertyRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/PropertyRest.java @@ -11,13 +11,12 @@ import java.util.List; import com.fasterxml.jackson.annotation.JsonIgnore; import org.dspace.app.rest.RestResourceController; -import org.springframework.hateoas.Identifiable; /** * This class acts as the REST representation of a DSpace configuration property. * This class acts as a data holder for the PropertyResource */ -public class PropertyRest extends RestAddressableModel implements Identifiable { +public class PropertyRest extends BaseObjectRest { public static final String NAME = "property"; public static final String CATEGORY = RestAddressableModel.CONFIGURATION; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRestRepository.java index 4a696bb664..caadb9f6f3 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ConfigurationRestRepository.java @@ -18,6 +18,7 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.data.rest.webmvc.ResourceNotFoundException; +import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Component; /** @@ -51,6 +52,7 @@ public class ConfigurationRestRepository extends DSpaceRestRepository Date: Sat, 6 Jun 2020 05:34:27 +0000 Subject: [PATCH 094/125] Bump spring-security.version in /dspace-rest Bumps `spring-security.version` from 5.3.1.RELEASE to 5.3.3.RELEASE. Updates `spring-security-core` from 5.3.1.RELEASE to 5.3.3.RELEASE - [Release notes](https://github.com/spring-projects/spring-security/releases) - [Commits](https://github.com/spring-projects/spring-security/compare/5.3.1.RELEASE...5.3.3.RELEASE) Updates `spring-security-web` from 5.3.1.RELEASE to 5.3.3.RELEASE - [Release notes](https://github.com/spring-projects/spring-security/releases) - [Commits](https://github.com/spring-projects/spring-security/compare/5.3.1.RELEASE...5.3.3.RELEASE) Updates `spring-security-config` from 5.3.1.RELEASE to 5.3.3.RELEASE - [Release notes](https://github.com/spring-projects/spring-security/releases) - [Commits](https://github.com/spring-projects/spring-security/compare/5.3.1.RELEASE...5.3.3.RELEASE) Signed-off-by: dependabot[bot] --- dspace-rest/pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dspace-rest/pom.xml b/dspace-rest/pom.xml index 8f69306085..1038617b49 100644 --- a/dspace-rest/pom.xml +++ b/dspace-rest/pom.xml @@ -19,7 +19,7 @@ ${basedir}/.. - 5.3.1.RELEASE + 5.3.3.RELEASE From 49d40598f0e2ca26f3683128852887c970ee8046 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Mon, 8 Jun 2020 13:04:59 +0200 Subject: [PATCH 095/125] [Task 71143] implemented the PreAuthorize check in ConverterService for the findOne of a BaseObjectRest when the toRest method is called --- .../app/rest/converter/ConverterService.java | 6 ++-- .../rest/model/ExternalSourceEntryRest.java | 2 +- .../rest/repository/BundleRestRepository.java | 6 ++-- .../rest/repository/ItemRestRepository.java | 2 +- .../WebSecurityExpressionEvaluator.java | 12 +++++-- .../rest/AuthorizationRestRepositoryIT.java | 6 ++++ .../app/rest/ProcessRestRepositoryIT.java | 7 ++++ .../rest/converter/ConverterServiceIT.java | 9 +++++ .../repository/MockObjectRestRepository.java | 36 +++++++++++++++++++ 9 files changed, 77 insertions(+), 9 deletions(-) create mode 100644 dspace-server-webapp/src/test/java/org/dspace/app/rest/repository/MockObjectRestRepository.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java index e1d282fc8b..bf959f719e 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java @@ -107,10 +107,12 @@ public class ConverterService { DSpaceConverter converter = requireConverter(modelObject.getClass()); R restObject = converter.convert(transformedModel, projection); if (restObject instanceof BaseObjectRest) { - String preAuthorizeValue = getPreAuthorizeAnnotationForBaseObject((BaseObjectRest) restObject); + BaseObjectRest baseObjectRest = (BaseObjectRest) restObject; + String preAuthorizeValue = getPreAuthorizeAnnotationForBaseObject(baseObjectRest); if (!webSecurityExpressionEvaluator .evaluate(preAuthorizeValue, requestService.getCurrentRequest().getHttpServletRequest(), - requestService.getCurrentRequest().getHttpServletResponse())) { + requestService.getCurrentRequest().getHttpServletResponse(), + String.valueOf(baseObjectRest.getId()))) { log.info("Access denied on " + restObject.getClass()); return null; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ExternalSourceEntryRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ExternalSourceEntryRest.java index aa5dfa8cf2..06af7e2227 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ExternalSourceEntryRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ExternalSourceEntryRest.java @@ -12,7 +12,7 @@ import org.dspace.app.rest.ExternalSourcesRestController; /** * This class serves as a REST representation for an entry of external data */ -public class ExternalSourceEntryRest extends BaseObjectRest { +public class ExternalSourceEntryRest extends RestAddressableModel { public static final String NAME = "externalSourceEntry"; public static final String PLURAL_NAME = "externalSourceEntries"; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BundleRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BundleRestRepository.java index d26ceeb2bf..f750743db6 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BundleRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BundleRestRepository.java @@ -74,11 +74,11 @@ public class BundleRestRepository extends DSpaceObjectRestRepository { + try { + processService.delete(context, process); + } catch (SQLException e) { + throw new RuntimeException(e); + } + }); parameters.add(new DSpaceCommandLineParameter("-r", "test")); parameters.add(new DSpaceCommandLineParameter("-i", null)); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java index e1d2e2d089..ea1a15dc04 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java @@ -13,6 +13,7 @@ import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertThat; import static org.junit.Assert.assertTrue; import static org.junit.Assert.fail; +import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; import java.util.HashMap; @@ -41,6 +42,9 @@ import org.springframework.hateoas.EntityModel; import org.springframework.hateoas.Link; import org.springframework.mock.web.MockHttpServletRequest; import org.springframework.mock.web.MockHttpServletResponse; +import org.springframework.security.core.Authentication; +import org.springframework.security.core.context.SecurityContext; +import org.springframework.security.core.context.SecurityContextHolder; /** * Tests functionality of {@link ConverterService}. @@ -76,6 +80,11 @@ public class ConverterServiceIT extends AbstractControllerIntegrationTest { mockHttpServletRequest.setAttribute("dspace.context", new Context()); MockHttpServletResponse mockHttpServletResponse = new MockHttpServletResponse(); requestService.startRequest(mockHttpServletRequest, mockHttpServletResponse); + Authentication authentication = mock(Authentication.class); + SecurityContext securityContext = mock(SecurityContext.class); + when(securityContext.getAuthentication()).thenReturn(authentication); + SecurityContextHolder.setContext(securityContext); + when(SecurityContextHolder.getContext().getAuthentication().getPrincipal()).thenReturn(eperson); } /** * When calling {@code toRest} with an object for which an appropriate {@link DSpaceConverter} can't be found, diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/repository/MockObjectRestRepository.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/repository/MockObjectRestRepository.java new file mode 100644 index 0000000000..5c12bc1b14 --- /dev/null +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/repository/MockObjectRestRepository.java @@ -0,0 +1,36 @@ +/** + * 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.rest.repository; + +import org.dspace.app.rest.model.MockObjectRest; +import org.dspace.core.Context; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; +import org.springframework.security.access.prepost.PreAuthorize; +import org.springframework.stereotype.Component; + +@Component(MockObjectRest.CATEGORY + "." + MockObjectRest.NAME) +public class MockObjectRestRepository extends DSpaceRestRepository { + + @Override + @PreAuthorize("permitAll()") + public MockObjectRest findOne(Context context, Long aLong) { + return null; + } + + @Override + @PreAuthorize("permitAll()") + public Page findAll(Context context, Pageable pageable) { + return null; + } + + @Override + public Class getDomainClass() { + return MockObjectRest.class; + } +} From 7be092813903c4e59f27109fd6702e5d281a1966 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Mon, 8 Jun 2020 15:12:40 +0200 Subject: [PATCH 096/125] [Task 71143] fixed checkstyle --- .../security/WebSecurityExpressionEvaluator.java | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WebSecurityExpressionEvaluator.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WebSecurityExpressionEvaluator.java index 8d75c24b1c..0b1b69e6e1 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WebSecurityExpressionEvaluator.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WebSecurityExpressionEvaluator.java @@ -47,7 +47,8 @@ public class WebSecurityExpressionEvaluator { } @SuppressWarnings("unchecked") - private EvaluationContext createEvaluationContext(SecurityExpressionHandler handler, HttpServletRequest request, HttpServletResponse response) { + private EvaluationContext createEvaluationContext(SecurityExpressionHandler handler, HttpServletRequest request, + HttpServletResponse response) { Authentication authentication = SecurityContextHolder.getContext().getAuthentication(); FilterInvocation filterInvocation = new FilterInvocation(request, response, EMPTY_CHAIN); @@ -56,9 +57,13 @@ public class WebSecurityExpressionEvaluator { private SecurityExpressionHandler getFilterSecurityHandler() { return securityExpressionHandlers.stream() - .filter(handler -> FilterInvocation.class.equals(GenericTypeResolver - .resolveTypeArgument(handler.getClass(), SecurityExpressionHandler.class))) + .filter(handler -> + FilterInvocation.class.equals( + GenericTypeResolver.resolveTypeArgument(handler.getClass(), + SecurityExpressionHandler.class))) .findAny() - .orElseThrow(() -> new IllegalStateException("No filter invocation security expression handler has been found! Handlers: " + securityExpressionHandlers.size())); + .orElseThrow(() -> new IllegalStateException("No filter invocation security" + + " expression handler has been found! Handlers: " + + securityExpressionHandlers.size())); } } \ No newline at end of file From e03a3f47b3cfa8db54058d1f35e46b34e76feace Mon Sep 17 00:00:00 2001 From: Tim Donohue Date: Mon, 8 Jun 2020 15:53:32 -0500 Subject: [PATCH 097/125] Link to the external, new Code Testing Guide --- .github/pull_request_template.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 849fbf93be..3605531adb 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -20,11 +20,8 @@ List of changes in this PR: _This checklist provides a reminder of what we are going to look for when reviewing your PR. You need not complete this checklist prior to creating your PR (draft PRs are always welcome). If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!_ - [ ] My PR is small in size (e.g. less than 1,000 lines of code, not including comments & integration tests). Exceptions may be made if previously agreed upon. -- [ ] My PR passes Checkstyle validation based on the [Code Style Guide](https://wiki.lyrasis.org/display/DSPACE/Code+Style+Guide) +- [ ] My PR passes Checkstyle validation based on the [Code Style Guide](https://wiki.lyrasis.org/display/DSPACE/Code+Style+Guide). - [ ] My PR includes Javadoc for _all new (or modified) public methods and classes_. It also includes Javadoc for large or complex private methods. -- [ ] My PR passes all tests and includes new/updated Unit or Integration Tests for any bug fixes, improvements or new features. A few reminders about what constitutes good tests: - * Include tests for different user types, including: (1) Anonymous user, (2) Logged in user (non-admin), and (3) Administrator. - * Include tests for known error scenarios and error codes (e.g. `400 Bad Request`, `401 Unauthorized`, `403 Forbidden`, `404 Not Found`, etc) - * For bug fixes, include a test that reproduces the bug and proves it is fixed. For clarity, it may be useful to provide the test in a separate commit from the bug fix. +- [ ] My PR passes all tests and includes new/updated Unit or Integration Tests based on the [Code Testing Guide](https://wiki.lyrasis.org/display/DSPACE/Code+Testing+Guide). - [ ] If my PR includes new, third-party dependencies (in any `pom.xml`), I've made sure their licenses align with the [DSpace BSD License](https://github.com/DSpace/DSpace/blob/master/LICENSE) based on the [Licensing of Contributions](https://wiki.lyrasis.org/display/DSPACE/Code+Contribution+Guidelines#CodeContributionGuidelines-LicensingofContributions) documentation. - [ ] If my PR modifies the REST API, I've linked to the REST Contract page (or open PR) related to this change. From 4a40b8d1028aaa37f712fd53243696650a99763b Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Tue, 9 Jun 2020 09:25:06 +0200 Subject: [PATCH 098/125] [Task 71308] applied feedback to the PreAuthorize parsing in converterService feature --- .../app/rest/converter/ConverterService.java | 6 ++++- .../WebSecurityExpressionEvaluator.java | 26 +++++++++++++++++++ .../rest/converter/ConverterServiceIT.java | 4 +++ .../repository/MockObjectRestRepository.java | 5 ++++ 4 files changed, 40 insertions(+), 1 deletion(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java index bf959f719e..fc786bfc85 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ConverterService.java @@ -108,12 +108,16 @@ public class ConverterService { R restObject = converter.convert(transformedModel, projection); if (restObject instanceof BaseObjectRest) { BaseObjectRest baseObjectRest = (BaseObjectRest) restObject; + // This section will verify whether the current user has permissions to retrieve the + // rest object. It'll only return the REST object if the permission is granted. + // If permission isn't granted, it'll return null String preAuthorizeValue = getPreAuthorizeAnnotationForBaseObject(baseObjectRest); if (!webSecurityExpressionEvaluator .evaluate(preAuthorizeValue, requestService.getCurrentRequest().getHttpServletRequest(), requestService.getCurrentRequest().getHttpServletResponse(), String.valueOf(baseObjectRest.getId()))) { - log.info("Access denied on " + restObject.getClass()); + log.debug("Access denied on " + restObject.getClass() + " with id: " + + ((BaseObjectRest) restObject).getId()); return null; } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WebSecurityExpressionEvaluator.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WebSecurityExpressionEvaluator.java index 0b1b69e6e1..364e93e297 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WebSecurityExpressionEvaluator.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WebSecurityExpressionEvaluator.java @@ -22,6 +22,17 @@ import org.springframework.security.core.context.SecurityContextHolder; import org.springframework.security.web.FilterInvocation; import org.springframework.stereotype.Component; +/** + * This class will contain the logic to allow us to evaluate an expression given through a String. + * This will be used by the {@link org.dspace.app.rest.converter.ConverterService} for parsing + * the {@link org.springframework.security.access.prepost.PreAuthorize} annotations used on the findOne + * methods of RestRepositories. A String will be given to the evaluate method and that String will then + * be parsed and a boolean will be returned based on the condition in the String. + * For example: "hasPermission(#id, 'ITEM', 'READ')" is such a String + * This will be evaluated and if the current user has the permission to read an item with the given id, + * a true will be returned, if not it'll be false. + * This works on all the methods in {@link org.springframework.security.access.expression.SecurityExpressionRoot} + */ @Component public class WebSecurityExpressionEvaluator { @@ -31,10 +42,25 @@ public class WebSecurityExpressionEvaluator { private final List securityExpressionHandlers; + /** + * Constructor for this class that sets all the {@link SecurityExpressionHandler} objects in a list + * @param securityExpressionHandlers The {@link SecurityExpressionHandler} for this class + */ public WebSecurityExpressionEvaluator(List securityExpressionHandlers) { this.securityExpressionHandlers = securityExpressionHandlers; } + /** + * This method will have to be used to evaluate the String given. It'll parse the String and resolve + * it to a method in {@link org.springframework.security.access.expression.SecurityExpressionRoot} + * and evaluate it to then return a boolean + * @param securityExpression The String that resembles the expression that has to be parsed + * @param request The current request + * @param response The current response + * @param id The id for the Object that is the subject of the permission + * @return A boolean indicating whether the currentUser adheres to the + * permissions in the securityExpression String or not + */ public boolean evaluate(String securityExpression, HttpServletRequest request, HttpServletResponse response, String id) { SecurityExpressionHandler handler = getFilterSecurityHandler(); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java index ea1a15dc04..685bd5dbfd 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/ConverterServiceIT.java @@ -112,6 +112,10 @@ public class ConverterServiceIT extends AbstractControllerIntegrationTest { /** * When calling {@code toRest} with the default projection, the converter should run and no changes should be made. + * This converter.toRest will now also check permissions through the PreAuthorize annotation on the + * Repository's findOne method. Therefor a repository has been added for this MockObjectRest namely + * {@link org.dspace.app.rest.repository.MockObjectRestRepository} and added PreAuthorize annotations + * on the methods of this Repository */ @Test public void toRestWithDefaultProjection() { diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/repository/MockObjectRestRepository.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/repository/MockObjectRestRepository.java index 5c12bc1b14..0c54811249 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/repository/MockObjectRestRepository.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/repository/MockObjectRestRepository.java @@ -14,9 +14,14 @@ import org.springframework.data.domain.Pageable; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Component; +/** + * This class has been added to allow the MockObjectRest to act as an actual BaseObjectRest since they're + * expected to have a RestRepository + */ @Component(MockObjectRest.CATEGORY + "." + MockObjectRest.NAME) public class MockObjectRestRepository extends DSpaceRestRepository { + // Added a permitAll preAuthorize annotation to allow the object to be used in tests by every user @Override @PreAuthorize("permitAll()") public MockObjectRest findOne(Context context, Long aLong) { From 5d7524970cb63dc903f778fa5b248dad16758415 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Tue, 9 Jun 2020 15:04:51 +0200 Subject: [PATCH 099/125] [Task 71272] applied feedback to the Scripts and Processes functionality --- .../dspace/app/bulkedit/MetadataImport.java | 8 +- .../MetadataDSpaceCsvExportServiceImpl.java | 3 + .../org/dspace/scripts/DSpaceRunnable.java | 7 + .../main/java/org/dspace/scripts/Process.java | 2 + .../dspace/scripts/ProcessServiceImpl.java | 3 +- .../app/bulkedit/MetadataExportTest.java | 6 + .../app/bulkedit/MetadataImportTest.java | 16 ++- .../src/test/resources/test-config.properties | 4 +- .../app/rest/ProcessFilesRestController.java | 42 +----- .../app/rest/RestResourceController.java | 10 +- .../rest/model/ProcessFileWrapperRest.java | 2 + .../hateoas/ProcessFileWrapperResource.java | 4 +- .../ProcessFilesLinkRepository.java | 26 +++- .../app/rest/BitstreamRestRepositoryIT.java | 65 --------- .../app/rest/ScriptRestRepositoryIT.java | 136 +++++++++--------- .../app/rest/builder/ProcessBuilder.java | 18 +++ dspace/config/registries/dspace-types.xml | 2 +- 17 files changed, 165 insertions(+), 189 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java index 0e424ead7f..eb0a4e2935 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java @@ -178,12 +178,8 @@ public class MetadataImport extends DSpaceRunnable + */ public abstract class DSpaceRunnable implements Runnable { /** diff --git a/dspace-api/src/main/java/org/dspace/scripts/Process.java b/dspace-api/src/main/java/org/dspace/scripts/Process.java index bc9204d429..19ce03b7fa 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/Process.java +++ b/dspace-api/src/main/java/org/dspace/scripts/Process.java @@ -80,6 +80,8 @@ public class Process implements ReloadableEntity { @Temporal(TemporalType.TIMESTAMP) private Date creationTime; + public static final String BITSTREAM_TYPE_METADATAFIELD = "dspace.process.type"; + protected Process() { } diff --git a/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java b/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java index 68b6613193..daa7181d37 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java @@ -197,7 +197,8 @@ public class ProcessServiceImpl implements ProcessService { } else { List filteredBitstreams = new ArrayList<>(); for (Bitstream bitstream : allBitstreams) { - if (StringUtils.equals(bitstreamService.getMetadata(bitstream, "dspace.process.type"), type)) { + if (StringUtils.equals(bitstreamService.getMetadata(bitstream, Process.BITSTREAM_TYPE_METADATAFIELD), + type)) { filteredBitstreams.add(bitstream); } } diff --git a/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataExportTest.java b/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataExportTest.java index e08fb62d9c..9594e2a2b1 100644 --- a/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataExportTest.java +++ b/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataExportTest.java @@ -49,6 +49,7 @@ public class MetadataExportTest extends AbstractIntegrationTest { Item item = wi.getItem(); itemService.addMetadata(context, item, "dc", "contributor", "author", null, "Donald, Smith"); item = installItemService.installItem(context, wi); + context.restoreAuthSystemState(); String fileLocation = configurationService.getProperty("dspace.dir") + testProps.get("test.exportcsv") .toString(); @@ -61,5 +62,10 @@ public class MetadataExportTest extends AbstractIntegrationTest { assertTrue(fileContent.contains("Donald, Smith")); assertTrue(fileContent.contains(String.valueOf(item.getID()))); + context.turnOffAuthorisationSystem(); + itemService.delete(context, itemService.find(context, item.getID())); + collectionService.delete(context, collectionService.find(context, collection.getID())); + communityService.delete(context, communityService.find(context, community.getID())); + context.restoreAuthSystemState(); } } diff --git a/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataImportTest.java b/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataImportTest.java index 3b649cabf9..01c189df25 100644 --- a/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataImportTest.java +++ b/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataImportTest.java @@ -9,10 +9,13 @@ package org.dspace.app.bulkedit; import static junit.framework.TestCase.assertTrue; +import java.io.File; + import org.apache.commons.lang3.StringUtils; import org.dspace.AbstractIntegrationTest; import org.dspace.app.launcher.ScriptLauncher; import org.dspace.app.scripts.handler.impl.TestDSpaceRunnableHandler; +import org.dspace.content.Collection; import org.dspace.content.Community; import org.dspace.content.Item; import org.dspace.content.factory.ContentServiceFactory; @@ -34,10 +37,12 @@ public class MetadataImportTest extends AbstractIntegrationTest { public void metadataImportTest() throws Exception { context.turnOffAuthorisationSystem(); Community community = communityService.create(null, context); - collectionService.create(context, community); + Collection collection = collectionService.create(context, community); + context.restoreAuthSystemState(); - String fileLocation = configurationService.getProperty("dspace.dir") + testProps.get("test.importcsv") - .toString(); + String fileLocation = new File(testProps.get("test.importcsv").toString()).getAbsolutePath(); +// String fileLocation = configurationService.getProperty("dspace.dir") + testProps.get("test.importcsv") +// .toString(); String[] args = new String[] {"metadata-import", "-f", fileLocation, "-e", eperson.getEmail(), "-s"}; TestDSpaceRunnableHandler testDSpaceRunnableHandler = new TestDSpaceRunnableHandler(); @@ -48,5 +53,10 @@ public class MetadataImportTest extends AbstractIntegrationTest { itemService.getMetadata(importedItem, "dc", "contributor", "author", Item.ANY).get(0).getValue(), "Donald, SmithImported")); + context.turnOffAuthorisationSystem(); + itemService.delete(context, itemService.find(context, importedItem.getID())); + collectionService.delete(context, collectionService.find(context, collection.getID())); + communityService.delete(context, communityService.find(context, community.getID())); + context.restoreAuthSystemState(); } } diff --git a/dspace-api/src/test/resources/test-config.properties b/dspace-api/src/test/resources/test-config.properties index 4a98ab2e47..66a29ab9a0 100644 --- a/dspace-api/src/test/resources/test-config.properties +++ b/dspace-api/src/test/resources/test-config.properties @@ -11,5 +11,5 @@ test.folder = ./target/testing/ # Path of the test bitstream (to use in BitstreamTest and elsewhere) test.bitstream = ./target/testing/dspace/assetstore/ConstitutionofIreland.pdf -test.exportcsv = /assetstore/test.csv -test.importcsv = /assetstore/testImport.csv +test.exportcsv = ./target/testing/dspace/assetstore/test.csv +test.importcsv = ./target/testing/dspace/assetstore/testImport.csv diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessFilesRestController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessFilesRestController.java index d2f24928e1..ae49af25ee 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessFilesRestController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessFilesRestController.java @@ -7,11 +7,7 @@ */ package org.dspace.app.rest; -import static org.springframework.hateoas.server.mvc.WebMvcLinkBuilder.methodOn; - import java.sql.SQLException; -import java.util.List; -import java.util.stream.Collectors; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; @@ -24,12 +20,6 @@ import org.dspace.app.rest.repository.ProcessRestRepository; import org.dspace.app.rest.utils.Utils; import org.dspace.authorize.AuthorizeException; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.data.domain.Page; -import org.springframework.data.domain.Pageable; -import org.springframework.data.web.PagedResourcesAssembler; -import org.springframework.hateoas.Link; -import org.springframework.hateoas.PagedModel; -import org.springframework.hateoas.server.mvc.WebMvcLinkBuilder; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; @@ -37,7 +27,8 @@ import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RestController; @RestController -@RequestMapping("/api/" + ProcessRest.CATEGORY + "/" + ProcessRest.PLURAL_NAME + "/{processId}/files") +@RequestMapping("/api/" + ProcessRest.CATEGORY + "/" + ProcessRest.PLURAL_NAME + + "/{processId}/files/name/{fileName:.+}") public class ProcessFilesRestController { private static final Logger log = LogManager.getLogger(); @@ -54,34 +45,7 @@ public class ProcessFilesRestController { @Autowired ProcessResourceHalLinkFactory processResourceHalLinkFactory; - @RequestMapping(method = RequestMethod.GET, value = "/{fileType}") - @PreAuthorize("hasPermission(#processId, 'PROCESS', 'READ')") - public PagedModel listFilesWithTypeFromProcess( - @PathVariable(name = "processId") Integer processId, - @PathVariable(name = "fileType") String fileType, - Pageable pageable, PagedResourcesAssembler assembler) throws SQLException, AuthorizeException { - - if (log.isTraceEnabled()) { - log.trace("Retrieving Files with type " + fileType + " from Process with ID: " + processId); - } - - List bitstreamResources = processRestRepository - .getProcessBitstreamsByType(processId, fileType).stream() - .map(bitstreamRest -> new BitstreamResource(bitstreamRest, utils)) - .collect(Collectors.toList()); - - Page page = utils.getPage(bitstreamResources, pageable); - - Link link = WebMvcLinkBuilder.linkTo( - methodOn(this.getClass()).listFilesWithTypeFromProcess(processId, fileType, pageable, assembler)) - .withSelfRel(); - PagedModel result = assembler.toModel(page, link); - - return result; - } - - - @RequestMapping(method = RequestMethod.GET, value = "/name/{fileName:.+}") + @RequestMapping(method = RequestMethod.GET) @PreAuthorize("hasPermission(#processId, 'PROCESS', 'READ')") public BitstreamResource getBitstreamByName(@PathVariable(name = "processId") Integer processId, @PathVariable(name = "fileName") String fileName) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java index a1684d782e..b501ba4406 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java @@ -342,7 +342,15 @@ public class RestResourceController implements InitializingBean { return findRelEntryInternal(request, response, apiCategory, model, id, rel, relid, page, assembler); } - + @RequestMapping(method = RequestMethod.GET, value = REGEX_REQUESTMAPPING_IDENTIFIER_AS_DIGIT + + "/{rel}/{relid}") + public RepresentationModel findRel(HttpServletRequest request, HttpServletResponse response, + @PathVariable String apiCategory, + @PathVariable String model, @PathVariable Integer id, @PathVariable String rel, + @PathVariable String relid, + Pageable page, PagedResourcesAssembler assembler) throws Throwable { + return findRelEntryInternal(request, response, apiCategory, model, id.toString(), rel, relid, page, assembler); + } /** * Execute a POST request; * diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileWrapperRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileWrapperRest.java index 38755ab928..a120ec6208 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileWrapperRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileWrapperRest.java @@ -14,6 +14,8 @@ import com.fasterxml.jackson.annotation.JsonIgnore; /** * The ProcessFileWrapper REST Resource + * This class will provide a way to show the processId alongside a list of embedded Bitstreams for that process + * if that Projection should be chosen * */ public class ProcessFileWrapperRest implements RestModel { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileWrapperResource.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileWrapperResource.java index bc1f6809c8..8429dc4aef 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileWrapperResource.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileWrapperResource.java @@ -16,6 +16,7 @@ import org.dspace.app.rest.model.BitstreamRest; import org.dspace.app.rest.model.MetadataValueRest; import org.dspace.app.rest.model.ProcessFileWrapperRest; import org.dspace.app.rest.utils.Utils; +import org.dspace.scripts.Process; /** * This is the Resource object for the {@link ProcessFileWrapperRest} @@ -35,7 +36,8 @@ public class ProcessFileWrapperResource extends HALResource> bitstreamResourceMap = new HashMap<>(); for (BitstreamRest bitstreamRest : content.getBitstreams()) { - List fileType = bitstreamRest.getMetadata().getMap().get("dspace.process.type"); + List fileType = bitstreamRest.getMetadata().getMap() + .get(Process.BITSTREAM_TYPE_METADATAFIELD); if (fileType != null && !fileType.isEmpty()) { bitstreamResourceMap .computeIfAbsent(fileType.get(0).getValue(), k -> new ArrayList<>()) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java index 3a271ab060..a76019bad7 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java @@ -8,14 +8,19 @@ package org.dspace.app.rest.repository; import java.sql.SQLException; +import java.util.List; import javax.annotation.Nullable; import javax.servlet.http.HttpServletRequest; +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import org.dspace.app.rest.model.BitstreamRest; import org.dspace.app.rest.model.ProcessFileWrapperRest; import org.dspace.app.rest.model.ProcessRest; import org.dspace.app.rest.projection.Projection; import org.dspace.authorize.AuthorizeException; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Component; @@ -28,6 +33,8 @@ import org.springframework.stereotype.Component; @Component(ProcessRest.CATEGORY + "." + ProcessRest.NAME + "." + ProcessRest.FILES) public class ProcessFilesLinkRepository extends AbstractDSpaceRestRepository implements LinkRestRepository { + private static final Logger log = LogManager.getLogger(); + @Autowired private ProcessRestRepository processRestRepository; @@ -38,7 +45,7 @@ public class ProcessFilesLinkRepository extends AbstractDSpaceRestRepository imp * @param processId The processId for the Process to use * @param optionalPageable Pageable if applicable * @param projection Projection if applicable - * @return A {@link ProcessFileWrapperRest} object filled with the bitstreams from the process + * @return A {@link ProcessFileWrapperRest} object filled with the bitstreams from the process * @throws SQLException If something goes wrong * @throws AuthorizeException If something goes wrong */ @@ -55,4 +62,21 @@ public class ProcessFilesLinkRepository extends AbstractDSpaceRestRepository imp return processFileWrapperRest; } + + @PreAuthorize("hasPermission(#processId, 'PROCESS', 'READ')") + public Page getResource(HttpServletRequest request, String processId, String fileType, + Pageable pageable, Projection projection) + throws SQLException, AuthorizeException { + if (log.isTraceEnabled()) { + log.trace("Retrieving Files with type " + fileType + " from Process with ID: " + processId); + } + + List bitstreamRests = processRestRepository + .getProcessBitstreamsByType(Integer.parseInt(processId), fileType); + + Page page = utils.getPage(bitstreamRests, pageable); + + + return page; + } } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/BitstreamRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/BitstreamRestRepositoryIT.java index 356841f268..00cb00918c 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/BitstreamRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/BitstreamRestRepositoryIT.java @@ -102,71 +102,6 @@ public class BitstreamRestRepositoryIT extends AbstractControllerIntegrationTest .andExpect(status().isMethodNotAllowed()); } - @Test - public void findAllPaginationTest() throws Exception { - //We turn off the authorization system in order to create the structure as defined below - context.turnOffAuthorisationSystem(); - - //** GIVEN ** - //1. A community-collection structure with one parent community with sub-community and one collection. - parentCommunity = CommunityBuilder.createCommunity(context) - .withName("Parent Community") - .build(); - Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity) - .withName("Sub Community") - .build(); - Collection col1 = CollectionBuilder.createCollection(context, child1).withName("Collection 1").build(); - - //2. One public items that is readable by Anonymous - Item publicItem1 = ItemBuilder.createItem(context, col1) - .withTitle("Test") - .withIssueDate("2010-10-17") - .withAuthor("Smith, Donald") - .withSubject("ExtraEntry") - .build(); - - String bitstreamContent = "ThisIsSomeDummyText"; - //Add a bitstream to an item - Bitstream bitstream = null; - try (InputStream is = IOUtils.toInputStream(bitstreamContent, CharEncoding.UTF_8)) { - bitstream = BitstreamBuilder. - createBitstream(context, publicItem1, is) - .withName("Bitstream") - .withDescription("descr") - .withMimeType("text/plain") - .build(); - } - - //Add a bitstream to an item - Bitstream bitstream1 = null; - try (InputStream is = IOUtils.toInputStream(bitstreamContent, CharEncoding.UTF_8)) { - bitstream1 = BitstreamBuilder. - createBitstream(context, publicItem1, is) - .withName("Bitstream1") - .withDescription("desscrip1") - .withMimeType("text/plain") - .build(); - } - - context.restoreAuthSystemState(); - - String token = getAuthToken(admin.getEmail(), password); - - getClient(token).perform(get("/api/core/bitstreams/") - .param("size", "1") - .param("projection", "full")) - .andExpect(status().isMethodNotAllowed()); - - getClient(token).perform(get("/api/core/bitstreams/") - .param("size", "1") - .param("page", "1") - .param("projection", "full")) - .andExpect(status().isMethodNotAllowed()); - - getClient().perform(get("/api/core/bitstreams/")) - .andExpect(status().isUnauthorized()); - } - //TODO Re-enable test after https://jira.duraspace.org/browse/DS-3774 is fixed @Ignore @Test diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java index 8d98eeff57..c1ba31305e 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ScriptRestRepositoryIT.java @@ -7,10 +7,10 @@ */ package org.dspace.app.rest; +import static com.jayway.jsonpath.JsonPath.read; import static org.hamcrest.Matchers.containsInAnyOrder; import static org.hamcrest.Matchers.hasItem; import static org.hamcrest.Matchers.is; -import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.fileUpload; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; @@ -22,15 +22,15 @@ import java.sql.SQLException; import java.util.Arrays; import java.util.LinkedList; import java.util.List; -import java.util.Map; +import java.util.concurrent.atomic.AtomicReference; import java.util.stream.Collectors; -import com.fasterxml.jackson.databind.ObjectMapper; import com.google.gson.Gson; import org.apache.commons.collections4.CollectionUtils; import org.dspace.app.rest.builder.CollectionBuilder; import org.dspace.app.rest.builder.CommunityBuilder; import org.dspace.app.rest.builder.ItemBuilder; +import org.dspace.app.rest.builder.ProcessBuilder; import org.dspace.app.rest.converter.DSpaceRunnableParameterConverter; import org.dspace.app.rest.matcher.PageMatcher; import org.dspace.app.rest.matcher.ProcessMatcher; @@ -53,7 +53,6 @@ import org.junit.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.MediaType; import org.springframework.mock.web.MockMultipartFile; -import org.springframework.test.web.servlet.MvcResult; public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { @@ -177,22 +176,22 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { String token = getAuthToken(admin.getEmail(), password); + AtomicReference idRef = new AtomicReference<>(); - MvcResult mvcResult = getClient(token) - .perform(post("/api/system/scripts/mock-script/processes").contentType("multipart/form-data")) - .andExpect(status().isAccepted()) - .andExpect(jsonPath("$", is( - ProcessMatcher.matchProcess("mock-script", - String.valueOf(admin.getID()), new LinkedList<>(), - ProcessStatus.FAILED)))).andReturn(); + try { + getClient(token) + .perform(post("/api/system/scripts/mock-script/processes").contentType("multipart/form-data")) + .andExpect(status().isAccepted()) + .andExpect(jsonPath("$", is( + ProcessMatcher.matchProcess("mock-script", + String.valueOf(admin.getID()), new LinkedList<>(), + ProcessStatus.FAILED)))) + .andDo(result -> idRef + .set(read(result.getResponse().getContentAsString(), "$.processId"))); + } finally { + ProcessBuilder.deleteProcess(idRef.get()); + } - ObjectMapper mapper = new ObjectMapper(); - - String content = mvcResult.getResponse().getContentAsString(); - Map map = mapper.readValue(content, Map.class); - Integer processId = Integer.valueOf(String.valueOf(map.get("processId"))); - - getClient(token).perform(delete("/api/system/processes/" + processId)); } @@ -221,22 +220,23 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { String token = getAuthToken(admin.getEmail(), password); - MvcResult mvcResult = getClient(token) - .perform(post("/api/system/scripts/mock-script/processes").contentType("multipart/form-data") - .param("properties", - new Gson().toJson(list))) - .andExpect(status().isAccepted()) - .andExpect(jsonPath("$", is( - ProcessMatcher.matchProcess("mock-script", - String.valueOf(admin.getID()), parameters, - ProcessStatus.FAILED)))).andReturn(); - ObjectMapper mapper = new ObjectMapper(); + AtomicReference idRef = new AtomicReference<>(); - String content = mvcResult.getResponse().getContentAsString(); - Map map = mapper.readValue(content, Map.class); - Integer processId = Integer.valueOf(String.valueOf(map.get("processId"))); - - getClient(token).perform(delete("/api/system/processes/" + processId)); + try { + getClient(token) + .perform(post("/api/system/scripts/mock-script/processes").contentType("multipart/form-data") + .param("properties", + new Gson().toJson(list))) + .andExpect(status().isAccepted()) + .andExpect(jsonPath("$", is( + ProcessMatcher.matchProcess("mock-script", + String.valueOf(admin.getID()), parameters, + ProcessStatus.FAILED)))) + .andDo(result -> idRef + .set(read(result.getResponse().getContentAsString(), "$.processId"))); + } finally { + ProcessBuilder.deleteProcess(idRef.get()); + } } @Test @@ -266,25 +266,24 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { ProcessStatus.RUNNING, ProcessStatus.COMPLETED)); - MvcResult mvcResult = getClient(token) - .perform(post("/api/system/scripts/mock-script/processes").contentType("multipart/form-data") - .param("properties", - new Gson().toJson(list))) - .andExpect(status().isAccepted()) - .andExpect(jsonPath("$", is( - ProcessMatcher.matchProcess("mock-script", - String.valueOf(admin.getID()), - parameters, - acceptableProcessStatuses)))).andReturn(); - - ObjectMapper mapper = new ObjectMapper(); - - String content = mvcResult.getResponse().getContentAsString(); - Map map = mapper.readValue(content, Map.class); - Integer processId = Integer.valueOf(String.valueOf(map.get("processId"))); - - getClient(token).perform(delete("/api/system/processes/" + processId)); + AtomicReference idRef = new AtomicReference<>(); + try { + getClient(token) + .perform(post("/api/system/scripts/mock-script/processes").contentType("multipart/form-data") + .param("properties", + new Gson().toJson(list))) + .andExpect(status().isAccepted()) + .andExpect(jsonPath("$", is( + ProcessMatcher.matchProcess("mock-script", + String.valueOf(admin.getID()), + parameters, + acceptableProcessStatuses)))) + .andDo(result -> idRef + .set(read(result.getResponse().getContentAsString(), "$.processId"))); + } finally { + ProcessBuilder.deleteProcess(idRef.get()); + } } @Test @@ -339,25 +338,24 @@ public class ScriptRestRepositoryIT extends AbstractControllerIntegrationTest { ProcessStatus.RUNNING, ProcessStatus.COMPLETED)); - MvcResult mvcResult = getClient(token) - .perform(fileUpload("/api/system/scripts/mock-script/processes").file(bitstreamFile) - .param("properties", - new Gson().toJson(list))) - .andExpect(status().isAccepted()) - .andExpect(jsonPath("$", is( - ProcessMatcher.matchProcess("mock-script", - String.valueOf(admin.getID()), - parameters, - acceptableProcessStatuses)))).andReturn(); - - ObjectMapper mapper = new ObjectMapper(); - - String content = mvcResult.getResponse().getContentAsString(); - Map map = mapper.readValue(content, Map.class); - Integer processId = Integer.valueOf(String.valueOf(map.get("processId"))); - - getClient(token).perform(delete("/api/system/processes/" + processId)); + AtomicReference idRef = new AtomicReference<>(); + try { + getClient(token) + .perform(fileUpload("/api/system/scripts/mock-script/processes").file(bitstreamFile) + .param("properties", + new Gson().toJson(list))) + .andExpect(status().isAccepted()) + .andExpect(jsonPath("$", is( + ProcessMatcher.matchProcess("mock-script", + String.valueOf(admin.getID()), + parameters, + acceptableProcessStatuses)))) + .andDo(result -> idRef + .set(read(result.getResponse().getContentAsString(), "$.processId"))); + } finally { + ProcessBuilder.deleteProcess(idRef.get()); + } } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/builder/ProcessBuilder.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/builder/ProcessBuilder.java index 9c1a500290..d7dd0493a9 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/builder/ProcessBuilder.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/builder/ProcessBuilder.java @@ -7,9 +7,11 @@ */ package org.dspace.app.rest.builder; +import java.io.IOException; import java.sql.SQLException; import java.util.List; +import org.dspace.authorize.AuthorizeException; import org.dspace.content.ProcessStatus; import org.dspace.core.Context; import org.dspace.eperson.EPerson; @@ -75,4 +77,20 @@ public class ProcessBuilder extends AbstractBuilder { getService().delete(c, dso); } } + + public static void deleteProcess(Integer integer) throws SQLException, IOException { + try (Context c = new Context()) { + c.turnOffAuthorisationSystem(); + Process process = processService.find(c, integer); + if (process != null) { + try { + processService.delete(c, process); + } catch (AuthorizeException e) { + // cannot occur, just wrap it to make the compiler happy + throw new RuntimeException(e); + } + } + c.complete(); + } + } } diff --git a/dspace/config/registries/dspace-types.xml b/dspace/config/registries/dspace-types.xml index 1c0d1f33f1..74e7092776 100644 --- a/dspace/config/registries/dspace-types.xml +++ b/dspace/config/registries/dspace-types.xml @@ -1,7 +1,7 @@ - DSpace Types + DSpace Internal Types Registry From e464ec0f8cfac7031dd0a15ff7b30ff2e50c8464 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Tue, 9 Jun 2020 15:06:39 +0200 Subject: [PATCH 100/125] [Task 71272] minor cleanup to the Scripts and Processes functionality --- .../test/java/org/dspace/app/bulkedit/MetadataImportTest.java | 2 -- 1 file changed, 2 deletions(-) diff --git a/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataImportTest.java b/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataImportTest.java index 01c189df25..c0eb2789bc 100644 --- a/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataImportTest.java +++ b/dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataImportTest.java @@ -41,8 +41,6 @@ public class MetadataImportTest extends AbstractIntegrationTest { context.restoreAuthSystemState(); String fileLocation = new File(testProps.get("test.importcsv").toString()).getAbsolutePath(); -// String fileLocation = configurationService.getProperty("dspace.dir") + testProps.get("test.importcsv") -// .toString(); String[] args = new String[] {"metadata-import", "-f", fileLocation, "-e", eperson.getEmail(), "-s"}; TestDSpaceRunnableHandler testDSpaceRunnableHandler = new TestDSpaceRunnableHandler(); From faef05258a60e04bfcdaed9d8e81a0ec266b4a29 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Wed, 10 Jun 2020 11:51:44 +0200 Subject: [PATCH 101/125] [Task 71335] removed unneeded PermissionEvaluatorPlugins and changed PreAuthorize annotations where necessary --- .../AuthorizationFeatureRestRepository.java | 6 +-- .../BitstreamFormatRestRepository.java | 1 + .../repository/EntityTypeRestRepository.java | 3 ++ .../TemplateItemRestRepository.java | 2 + ...onStatusRestPermissionEvaluatorPlugin.java | 31 -------------- .../AuthnRestPermissionEvaluatorPlugin.java | 31 -------------- ...nFeatureRestPermissionEvaluatorPlugin.java | 31 -------------- ...amFormatRestPermissionEvaluatorPlugin.java | 31 -------------- ...wseIndexRestPermissionEvaluatorPlugin.java | 31 -------------- ...ryResultRestPermissionEvaluatorPlugin.java | 31 -------------- ...tityTypeRestPermissionEvaluatorPlugin.java | 31 -------------- ...rceEntryRestPermissionEvaluatorPlugin.java | 31 -------------- ...alSourceRestPermissionEvaluatorPlugin.java | 31 -------------- ...gurationRestPermissionEvaluatorPlugin.java | 31 -------------- ...llectionRestPermissionEvaluatorPlugin.java | 31 -------------- ...MetadataRestPermissionEvaluatorPlugin.java | 31 -------------- ...ataFieldRestPermissionEvaluatorPlugin.java | 31 -------------- ...taSchemaRestPermissionEvaluatorPlugin.java | 31 -------------- ...tionshipRestPermissionEvaluatorPlugin.java | 31 -------------- ...shipTypeRestPermissionEvaluatorPlugin.java | 31 -------------- .../ScriptRestPermissionEvaluatorPlugin.java | 30 -------------- ...gurationRestPermissionEvaluatorPlugin.java | 31 -------------- ...rchEventRestPermissionEvaluatorPlugin.java | 31 -------------- ...hResultsRestPermissionEvaluatorPlugin.java | 31 -------------- ...hSupportRestPermissionEvaluatorPlugin.java | 31 -------------- .../SiteRestPermissionEvaluatorPlugin.java | 31 -------------- ...sSupportRestPermissionEvaluatorPlugin.java | 31 -------------- ...finitionRestPermissionEvaluatorPlugin.java | 31 -------------- ...sionFormRestPermissionEvaluatorPlugin.java | 31 -------------- ...onUploadRestPermissionEvaluatorPlugin.java | 31 -------------- ...nSectionRestPermissionEvaluatorPlugin.java | 31 -------------- ...lateItemRestPermissionEvaluatorPlugin.java | 31 -------------- ...iewEventRestPermissionEvaluatorPlugin.java | 31 -------------- ...owActionRestPermissionEvaluatorPlugin.java | 31 -------------- ...finitionRestPermissionEvaluatorPlugin.java | 31 -------------- ...flowStepRestPermissionEvaluatorPlugin.java | 31 -------------- .../AuthorizationFeatureRestRepositoryIT.java | 41 +++---------------- 37 files changed, 15 insertions(+), 1029 deletions(-) delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthenticationStatusRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthnRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationFeatureRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BitstreamFormatRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BrowseIndexRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/DiscoveryResultRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EntityTypeRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceEntryRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/FacetConfigurationRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvestedCollectionRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvesterMetadataRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataFieldRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataSchemaRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipTypeRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ScriptRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchConfigurationRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchEventRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchResultsRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchSupportRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SiteRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/StatisticsSupportRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionDefinitionRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionFormRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionUploadRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissonSectionRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/TemplateItemRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ViewEventRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowActionRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowDefinitionRestPermissionEvaluatorPlugin.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowStepRestPermissionEvaluatorPlugin.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorizationFeatureRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorizationFeatureRestRepository.java index 0048898e22..b5d102215c 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorizationFeatureRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorizationFeatureRestRepository.java @@ -42,13 +42,13 @@ public class AuthorizationFeatureRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { return converter.toRestPage(authorizationFeatureService.findAll(), pageable, utils.obtainProjection()); } - @PreAuthorize("hasAuthority('ADMIN')") + @PreAuthorize("permitAll()") @Override public AuthorizationFeatureRest findOne(Context context, String id) { AuthorizationFeature authzFeature = authorizationFeatureService.find(id); @@ -58,7 +58,7 @@ public class AuthorizationFeatureRestRepository extends DSpaceRestRepository findByResourceType(@Parameter(value = "type", required = true) String type, Pageable pageable) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamFormatRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamFormatRestRepository.java index 49585ee9db..e63069233e 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamFormatRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamFormatRestRepository.java @@ -57,6 +57,7 @@ public class BitstreamFormatRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { try { List bit = bitstreamFormatService.findAll(context); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EntityTypeRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EntityTypeRestRepository.java index e6c6fcea53..29db39d879 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EntityTypeRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EntityTypeRestRepository.java @@ -30,6 +30,7 @@ public class EntityTypeRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { try { List entityTypes = entityTypeService.findAll(context); @@ -52,6 +54,7 @@ public class EntityTypeRestRepository extends DSpaceRestRepository getDomainClass() { return EntityTypeRest.class; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/TemplateItemRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/TemplateItemRestRepository.java index 2e1436d4fb..ad80140481 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/TemplateItemRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/TemplateItemRestRepository.java @@ -28,6 +28,7 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.data.rest.webmvc.ResourceNotFoundException; +import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Component; /** @@ -49,6 +50,7 @@ public class TemplateItemRestRepository extends DSpaceRestRepository resourcePatch; @Override + @PreAuthorize("permitAll()") public TemplateItemRest findOne(Context context, UUID uuid) { Item item = null; try { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthenticationStatusRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthenticationStatusRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 220c75d893..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthenticationStatusRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.AuthenticationStatusRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to AuthenticationStatusRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class AuthenticationStatusRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(AuthenticationStatusRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthnRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthnRestPermissionEvaluatorPlugin.java deleted file mode 100644 index d310e781b4..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthnRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.AuthnRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to AuthnRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class AuthnRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(AuthnRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationFeatureRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationFeatureRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 2a2dec0655..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/AuthorizationFeatureRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.AuthorizationFeatureRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to AuthorizationRest endpoints. It will return true because access can be granted - * anytime it's linked from another resource. - */ -@Component -public class AuthorizationFeatureRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(AuthorizationFeatureRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BitstreamFormatRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BitstreamFormatRestPermissionEvaluatorPlugin.java deleted file mode 100644 index f5027a5f14..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BitstreamFormatRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.BitstreamFormatRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to BitstreamFormatRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class BitstreamFormatRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(BitstreamFormatRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BrowseIndexRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BrowseIndexRestPermissionEvaluatorPlugin.java deleted file mode 100644 index a4f57e1ea7..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BrowseIndexRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.BrowseIndexRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to BrowseIndexRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class BrowseIndexRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(BrowseIndexRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/DiscoveryResultRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/DiscoveryResultRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 04207e4a93..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/DiscoveryResultRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.DiscoveryResultsRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to DiscoveryResultsRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class DiscoveryResultRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(DiscoveryResultsRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EntityTypeRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EntityTypeRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 017e0c2b56..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EntityTypeRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.EntityTypeRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to EntityTypeRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class EntityTypeRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(EntityTypeRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceEntryRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceEntryRestPermissionEvaluatorPlugin.java deleted file mode 100644 index fc050b4d3e..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceEntryRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.ExternalSourceEntryRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to ExternalSourceEntryRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class ExternalSourceEntryRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(ExternalSourceEntryRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 5340251f0d..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ExternalSourceRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.ExternalSourceRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to ExternalSourceRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class ExternalSourceRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(ExternalSourceRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/FacetConfigurationRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/FacetConfigurationRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 5a9432d466..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/FacetConfigurationRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.FacetConfigurationRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to FacetConfigurationRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class FacetConfigurationRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(FacetConfigurationRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvestedCollectionRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvestedCollectionRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 9f78f5a043..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvestedCollectionRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.HarvestedCollectionRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to HarvestedCollectionRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class HarvestedCollectionRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(HarvestedCollectionRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvesterMetadataRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvesterMetadataRestPermissionEvaluatorPlugin.java deleted file mode 100644 index ec0e3e202b..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/HarvesterMetadataRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.HarvesterMetadataRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to HarvesterMetadataRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class HarvesterMetadataRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(HarvesterMetadataRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataFieldRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataFieldRestPermissionEvaluatorPlugin.java deleted file mode 100644 index c53fffe5d0..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataFieldRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.MetadataFieldRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to MetadataFieldRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class MetadataFieldRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(MetadataFieldRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataSchemaRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataSchemaRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 07da54a170..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/MetadataSchemaRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.MetadataSchemaRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to MetadataSchemaRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class MetadataSchemaRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(MetadataSchemaRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 690a8bde9f..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.RelationshipRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to RelationshipRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class RelationshipRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(RelationshipRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipTypeRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipTypeRestPermissionEvaluatorPlugin.java deleted file mode 100644 index b371c8a516..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/RelationshipTypeRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.RelationshipTypeRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to RelationshipTypeRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class RelationshipTypeRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(RelationshipTypeRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ScriptRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ScriptRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 3672ad47c4..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ScriptRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,30 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.ScriptRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle Permissions for the {@link ScriptRest} object and its calls - */ -@Component -public class ScriptRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(ScriptRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchConfigurationRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchConfigurationRestPermissionEvaluatorPlugin.java deleted file mode 100644 index b540b4d855..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchConfigurationRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.SearchConfigurationRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to SearchConfigurationRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class SearchConfigurationRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(SearchConfigurationRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchEventRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchEventRestPermissionEvaluatorPlugin.java deleted file mode 100644 index e7124b834e..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchEventRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.SearchEventRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to SearchEventRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class SearchEventRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(SearchEventRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchResultsRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchResultsRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 8e1ef2ada7..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchResultsRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.SearchResultsRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to SearchResultsRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class SearchResultsRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(SearchResultsRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchSupportRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchSupportRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 6ad65351c6..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SearchSupportRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.SearchSupportRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to SearchSupportRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class SearchSupportRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(SearchSupportRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SiteRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SiteRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 6385b2c751..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SiteRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.SiteRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to SiteRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class SiteRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(SiteRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/StatisticsSupportRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/StatisticsSupportRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 190afafe14..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/StatisticsSupportRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.StatisticsSupportRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to StatisticsSupportRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class StatisticsSupportRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(StatisticsSupportRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionDefinitionRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionDefinitionRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 7efb24a6ee..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionDefinitionRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.SubmissionDefinitionRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to SubmissionDefinitionRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class SubmissionDefinitionRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(SubmissionDefinitionRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionFormRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionFormRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 19db77ca57..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionFormRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.SubmissionFormRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to SubmissionFormRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class SubmissionFormRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(SubmissionFormRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionUploadRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionUploadRestPermissionEvaluatorPlugin.java deleted file mode 100644 index aa15522a1c..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissionUploadRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.SubmissionUploadRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to SubmissionUploadRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class SubmissionUploadRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(SubmissionUploadRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissonSectionRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissonSectionRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 7c998d48d0..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/SubmissonSectionRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.SubmissionSectionRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to SubmissionSectionRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class SubmissonSectionRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(SubmissionSectionRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/TemplateItemRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/TemplateItemRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 192bdf040b..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/TemplateItemRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.TemplateItemRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to TemplateItemRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class TemplateItemRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(TemplateItemRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ViewEventRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ViewEventRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 097bfc1e3a..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ViewEventRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.ViewEventRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to ViewEventRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class ViewEventRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(ViewEventRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowActionRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowActionRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 4f4180e960..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowActionRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.WorkflowActionRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to WorkflowActionRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class WorkflowActionRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(WorkflowActionRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowDefinitionRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowDefinitionRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 6168b3b370..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowDefinitionRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.WorkflowDefinitionRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to WorkflowDefinitionRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class WorkflowDefinitionRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(WorkflowDefinitionRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowStepRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowStepRestPermissionEvaluatorPlugin.java deleted file mode 100644 index 8c8216c412..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowStepRestPermissionEvaluatorPlugin.java +++ /dev/null @@ -1,31 +0,0 @@ -/** - * 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.rest.security; - -import java.io.Serializable; - -import org.apache.commons.lang3.StringUtils; -import org.dspace.app.rest.model.WorkflowStepRest; -import org.springframework.security.core.Authentication; -import org.springframework.stereotype.Component; - -/** - * This class will handle calls made to WorkflowStepRest endpoints. - * It will return true because access can be granted anytime it's linked from another resource - */ -@Component -public class WorkflowStepRestPermissionEvaluatorPlugin extends RestObjectPermissionEvaluatorPlugin { - @Override - public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, - DSpaceRestPermission restPermission) { - if (!StringUtils.equalsIgnoreCase(WorkflowStepRest.NAME, targetType)) { - return false; - } - return true; - } -} diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationFeatureRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationFeatureRestRepositoryIT.java index a3556ad503..bffcbcb54f 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationFeatureRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationFeatureRestRepositoryIT.java @@ -46,19 +46,12 @@ public class AuthorizationFeatureRestRepositoryIT extends AbstractControllerInte public void findAllTest() throws Exception { int featuresNum = authzFeatureService.findAll().size(); int expReturn = featuresNum > 20 ? 20 : featuresNum; - String adminToken = getAuthToken(admin.getEmail(), password); - // verify that only the admin can access the endpoint (see subsequent call in the method) - getClient(adminToken).perform(get("/api/authz/features")).andExpect(status().isOk()) + getClient().perform(get("/api/authz/features")).andExpect(status().isOk()) .andExpect(jsonPath("$._embedded.features", Matchers.hasSize(is(expReturn)))) .andExpect(jsonPath("$._links.self.href", Matchers.containsString("/api/authz/features"))) .andExpect(jsonPath("$.page.size", is(20))) .andExpect(jsonPath("$.page.totalElements", is(featuresNum))); - // verify that anonymous user cannot access - getClient().perform(get("/api/authz/features")).andExpect(status().isUnauthorized()); - // verify that normal user cannot access - String epersonAuthToken = getAuthToken(eperson.getEmail(), password); - getClient(epersonAuthToken).perform(get("/api/authz/features")).andExpect(status().isForbidden()); } @@ -108,30 +101,17 @@ public class AuthorizationFeatureRestRepositoryIT extends AbstractControllerInte * @throws Exception */ public void findOneTest() throws Exception { - String adminToken = getAuthToken(admin.getEmail(), password); - // verify that only the admin can access the endpoint (see subsequent call in the method) - getClient(adminToken).perform(get("/api/authz/features/withdrawItem")).andExpect(status().isOk()) + getClient().perform(get("/api/authz/features/withdrawItem")).andExpect(status().isOk()) .andExpect(jsonPath("$.id", is("withdrawItem"))) .andExpect(jsonPath("$.description", Matchers.any(String.class))) .andExpect(jsonPath("$.resourcetypes", Matchers.contains("core.item"))) .andExpect(jsonPath("$.type", is("feature"))); - // verify that anonymous user cannot access - getClient().perform(get("/api/authz/features/withdrawItem")).andExpect(status().isUnauthorized()); - // verify that normal user cannot access - String epersonAuthToken = getAuthToken(eperson.getEmail(), password); - getClient(epersonAuthToken).perform(get("/api/authz/features/withdrawItem")).andExpect(status().isForbidden()); } @Test public void findOneNotFoundTest() throws Exception { - String adminToken = getAuthToken(admin.getEmail(), password); - // verify that only the admin can access the endpoint and get the not found response code - // (see subsequent calls in the method for unauthorized and forbidden attempts) - getClient(adminToken).perform(get("/api/authz/features/not-existing-feature")).andExpect(status().isNotFound()); - // verify that anonymous user cannot access, without information disclosure - getClient().perform(get("/api/authz/features/not-existing-feature")).andExpect(status().isUnauthorized()); - // verify that normal user cannot access, without information disclosure - getClient(adminToken).perform(get("/api/authz/features/1")).andExpect(status().isNotFound()); + getClient().perform(get("/api/authz/features/not-existing-feature")).andExpect(status().isNotFound()); + getClient().perform(get("/api/authz/features/1")).andExpect(status().isNotFound()); } @Test @@ -142,10 +122,8 @@ public class AuthorizationFeatureRestRepositoryIT extends AbstractControllerInte */ public void findByResourceTypeTest() throws Exception { AuthorizationFeature alwaysTrueFeature = authzFeatureService.find(AlwaysTrueFeature.NAME); - String adminToken = getAuthToken(admin.getEmail(), password); for (String type : alwaysTrueFeature.getSupportedTypes()) { - // verify that only the admin can access the endpoint (see subsequent call in the method) - getClient(adminToken).perform(get("/api/authz/features/search/resourcetype").param("type", type)) + getClient().perform(get("/api/authz/features/search/resourcetype").param("type", type)) .andExpect(status().isOk()) .andExpect(jsonPath("$", JsonPathMatchers.hasJsonPath("$._embedded.features", @@ -158,15 +136,8 @@ public class AuthorizationFeatureRestRepositoryIT extends AbstractControllerInte Matchers.containsString("/api/authz/features/search/resourcetype"))); } // verify that the right response code is returned also for not existing types - getClient(adminToken).perform(get("/api/authz/features/search/resourcetype").param("type", "NOT-EXISTING")) + getClient().perform(get("/api/authz/features/search/resourcetype").param("type", "NOT-EXISTING")) .andExpect(status().isOk()).andExpect(jsonPath("$.page.totalElements", is(0))); - // verify that anonymous user cannot access, without information disclosure - getClient().perform(get("/api/authz/features/search/resourcetype").param("type", "core.item")) - .andExpect(status().isUnauthorized()); - // verify that normal user cannot access, without information disclosure - String epersonAuthToken = getAuthToken(eperson.getEmail(), password); - getClient(epersonAuthToken).perform(get("/api/authz/features/search/resourcetype").param("type", "core.item")) - .andExpect(status().isForbidden()); } From 56629fd34e82b9a29ada8b65a7b1a41557b99f7f Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Wed, 10 Jun 2020 11:53:24 +0200 Subject: [PATCH 102/125] [Task 71335] removed wrongly added preAuthorize on bitstreamFormatRestRepository#findAll --- .../app/rest/repository/BitstreamFormatRestRepository.java | 1 - 1 file changed, 1 deletion(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamFormatRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamFormatRestRepository.java index e63069233e..49585ee9db 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamFormatRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamFormatRestRepository.java @@ -57,7 +57,6 @@ public class BitstreamFormatRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { try { List bit = bitstreamFormatService.findAll(context); From 5f44fe11f7da5885f7f6f285fac23fd3a5c2605e Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Wed, 10 Jun 2020 13:50:17 +0200 Subject: [PATCH 103/125] Undo findall preauthorize annotation change on AuthorizationFeatureRestRepository --- .../AuthorizationFeatureRestRepository.java | 4 +- .../AuthorizationFeatureRestRepositoryIT.java | 95 +++++++++++-------- 2 files changed, 58 insertions(+), 41 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorizationFeatureRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorizationFeatureRestRepository.java index b5d102215c..62781fe8e8 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorizationFeatureRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorizationFeatureRestRepository.java @@ -42,7 +42,7 @@ public class AuthorizationFeatureRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { return converter.toRestPage(authorizationFeatureService.findAll(), pageable, utils.obtainProjection()); @@ -58,7 +58,7 @@ public class AuthorizationFeatureRestRepository extends DSpaceRestRepository findByResourceType(@Parameter(value = "type", required = true) String type, Pageable pageable) { diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationFeatureRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationFeatureRestRepositoryIT.java index bffcbcb54f..0aadff7a99 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationFeatureRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationFeatureRestRepositoryIT.java @@ -29,7 +29,7 @@ import org.springframework.beans.factory.annotation.Autowired; /** * Test suite for the Authorization Feature endpoint - * + * * @author Andrea Bollini (andrea.bollini at 4science.it) * */ @@ -46,12 +46,19 @@ public class AuthorizationFeatureRestRepositoryIT extends AbstractControllerInte public void findAllTest() throws Exception { int featuresNum = authzFeatureService.findAll().size(); int expReturn = featuresNum > 20 ? 20 : featuresNum; + String adminToken = getAuthToken(admin.getEmail(), password); - getClient().perform(get("/api/authz/features")).andExpect(status().isOk()) - .andExpect(jsonPath("$._embedded.features", Matchers.hasSize(is(expReturn)))) - .andExpect(jsonPath("$._links.self.href", Matchers.containsString("/api/authz/features"))) - .andExpect(jsonPath("$.page.size", is(20))) - .andExpect(jsonPath("$.page.totalElements", is(featuresNum))); + // verify that only the admin can access the endpoint (see subsequent call in the method) + getClient(adminToken).perform(get("/api/authz/features")).andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.features", Matchers.hasSize(is(expReturn)))) + .andExpect(jsonPath("$._links.self.href", Matchers.containsString("/api/authz/features"))) + .andExpect(jsonPath("$.page.size", is(20))) + .andExpect(jsonPath("$.page.totalElements", is(featuresNum))); + // verify that anonymous user cannot access + getClient().perform(get("/api/authz/features")).andExpect(status().isUnauthorized()); + // verify that normal user cannot access + String epersonAuthToken = getAuthToken(eperson.getEmail(), password); + getClient(epersonAuthToken).perform(get("/api/authz/features")).andExpect(status().isForbidden()); } @@ -71,21 +78,21 @@ public class AuthorizationFeatureRestRepositoryIT extends AbstractControllerInte AtomicReference idRef = new AtomicReference(); getClient(adminToken) - .perform(get("/api/authz/features").param("page", String.valueOf(page)).param("size", "1")) - .andExpect(status().isOk()).andExpect(jsonPath("$._embedded.features", Matchers.hasSize(is(1)))) - .andExpect(jsonPath("$._links.self.href", Matchers.containsString("/api/authz/features"))) - .andExpect( - (page == 0) ? jsonPath("$._links.prev.href").doesNotExist() - : jsonPath("$._links.prev.href", Matchers.containsString("/api/authz/features"))) - .andExpect((page == featuresNum - 1) - ? jsonPath("$._links.next.href").doesNotExist() - : jsonPath("$._links.next.href", Matchers.containsString("/api/authz/features"))) - .andExpect(jsonPath("$._links.first.href", Matchers.containsString("/api/authz/features"))) - .andExpect(jsonPath("$._links.last.href", Matchers.containsString("/api/authz/features"))) - .andExpect(jsonPath("$.page.size", is(1))) - .andExpect(jsonPath("$.page.totalElements", is(Integer.valueOf(featuresNum)))) - .andDo(result -> idRef - .set(read(result.getResponse().getContentAsString(), "$._embedded.features[0].id"))); + .perform(get("/api/authz/features").param("page", String.valueOf(page)).param("size", "1")) + .andExpect(status().isOk()).andExpect(jsonPath("$._embedded.features", Matchers.hasSize(is(1)))) + .andExpect(jsonPath("$._links.self.href", Matchers.containsString("/api/authz/features"))) + .andExpect( + (page == 0) ? jsonPath("$._links.prev.href").doesNotExist() + : jsonPath("$._links.prev.href", Matchers.containsString("/api/authz/features"))) + .andExpect((page == featuresNum - 1) + ? jsonPath("$._links.next.href").doesNotExist() + : jsonPath("$._links.next.href", Matchers.containsString("/api/authz/features"))) + .andExpect(jsonPath("$._links.first.href", Matchers.containsString("/api/authz/features"))) + .andExpect(jsonPath("$._links.last.href", Matchers.containsString("/api/authz/features"))) + .andExpect(jsonPath("$.page.size", is(1))) + .andExpect(jsonPath("$.page.totalElements", is(Integer.valueOf(featuresNum)))) + .andDo(result -> idRef + .set(read(result.getResponse().getContentAsString(), "$._embedded.features[0].id"))); if (idRef.get() == null || featureIDs.contains(idRef.get())) { fail("Duplicate feature " + idRef.get() + " returned at page " + page); @@ -102,16 +109,16 @@ public class AuthorizationFeatureRestRepositoryIT extends AbstractControllerInte */ public void findOneTest() throws Exception { getClient().perform(get("/api/authz/features/withdrawItem")).andExpect(status().isOk()) - .andExpect(jsonPath("$.id", is("withdrawItem"))) - .andExpect(jsonPath("$.description", Matchers.any(String.class))) - .andExpect(jsonPath("$.resourcetypes", Matchers.contains("core.item"))) - .andExpect(jsonPath("$.type", is("feature"))); + .andExpect(jsonPath("$.id", is("withdrawItem"))) + .andExpect(jsonPath("$.description", Matchers.any(String.class))) + .andExpect(jsonPath("$.resourcetypes", Matchers.contains("core.item"))) + .andExpect(jsonPath("$.type", is("feature"))); } @Test public void findOneNotFoundTest() throws Exception { getClient().perform(get("/api/authz/features/not-existing-feature")).andExpect(status().isNotFound()); - getClient().perform(get("/api/authz/features/1")).andExpect(status().isNotFound()); + } @Test @@ -122,22 +129,32 @@ public class AuthorizationFeatureRestRepositoryIT extends AbstractControllerInte */ public void findByResourceTypeTest() throws Exception { AuthorizationFeature alwaysTrueFeature = authzFeatureService.find(AlwaysTrueFeature.NAME); + String adminToken = getAuthToken(admin.getEmail(), password); for (String type : alwaysTrueFeature.getSupportedTypes()) { - getClient().perform(get("/api/authz/features/search/resourcetype").param("type", type)) - .andExpect(status().isOk()) - .andExpect(jsonPath("$", - JsonPathMatchers.hasJsonPath("$._embedded.features", - Matchers.everyItem( - JsonPathMatchers.hasJsonPath("$.resourcetypes", - Matchers.hasItem(is(type)))) - ))) - .andExpect( - jsonPath("$._links.self.href", - Matchers.containsString("/api/authz/features/search/resourcetype"))); + // verify that only the admin can access the endpoint (see subsequent call in the method) + getClient(adminToken).perform(get("/api/authz/features/search/resourcetype").param("type", type)) + .andExpect(status().isOk()) + .andExpect(jsonPath("$", + JsonPathMatchers.hasJsonPath("$._embedded.features", + Matchers.everyItem( + JsonPathMatchers.hasJsonPath( + "$.resourcetypes", + Matchers.hasItem(is(type)))) + ))) + .andExpect( + jsonPath("$._links.self.href", + Matchers.containsString("/api/authz/features/search/resourcetype"))); } // verify that the right response code is returned also for not existing types - getClient().perform(get("/api/authz/features/search/resourcetype").param("type", "NOT-EXISTING")) - .andExpect(status().isOk()).andExpect(jsonPath("$.page.totalElements", is(0))); + getClient(adminToken).perform(get("/api/authz/features/search/resourcetype").param("type", "NOT-EXISTING")) + .andExpect(status().isOk()).andExpect(jsonPath("$.page.totalElements", is(0))); + // verify that anonymous user cannot access, without information disclosure + getClient().perform(get("/api/authz/features/search/resourcetype").param("type", "core.item")) + .andExpect(status().isUnauthorized()); + // verify that normal user cannot access, without information disclosure + String epersonAuthToken = getAuthToken(eperson.getEmail(), password); + getClient(epersonAuthToken).perform(get("/api/authz/features/search/resourcetype").param("type", "core.item")) + .andExpect(status().isForbidden()); } From f5b7d5854bbbfd7ca7af85632a9eb6e3114bdf9d Mon Sep 17 00:00:00 2001 From: Mykhaylo Date: Thu, 11 Jun 2020 11:20:48 +0200 Subject: [PATCH 104/125] Implement community feedbacks --- .../src/main/java/org/dspace/eperson/GroupServiceImpl.java | 4 +++- .../rest/security/EPersonRestAuthenticationProvider.java | 6 +++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/eperson/GroupServiceImpl.java b/dspace-api/src/main/java/org/dspace/eperson/GroupServiceImpl.java index 449ddca973..4437516315 100644 --- a/dspace-api/src/main/java/org/dspace/eperson/GroupServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/eperson/GroupServiceImpl.java @@ -659,7 +659,9 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl implements } } } else { - if (AuthorizeConfiguration.canCollectionAdminManagePolicies()) { + if (AuthorizeConfiguration.canCollectionAdminManagePolicies() + || AuthorizeConfiguration.canCommunityAdminManagePolicies() + || AuthorizeConfiguration.canCommunityAdminManageCollectionWorkflows()) { List groups = new ArrayList(); groups.add(group); List policies = resourcePolicyService.find(context, null, groups, diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EPersonRestAuthenticationProvider.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EPersonRestAuthenticationProvider.java index 576c7e7e7d..9a5faf01ee 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EPersonRestAuthenticationProvider.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EPersonRestAuthenticationProvider.java @@ -144,11 +144,11 @@ public class EPersonRestAuthenticationProvider implements AuthenticationProvider if (eperson != null) { boolean isAdmin = false; boolean isCommunityAdmin = false; - boolean isColectionAdmin = false; + boolean isCollectionAdmin = false; try { isAdmin = authorizeService.isAdmin(context, eperson); isCommunityAdmin = authorizeService.isCommunityAdmin(context, eperson); - isColectionAdmin = authorizeService.isCollectionAdmin(context, eperson); + isCollectionAdmin = authorizeService.isCollectionAdmin(context, eperson); } catch (SQLException e) { log.error("SQL error while checking for admin rights", e); } @@ -156,7 +156,7 @@ public class EPersonRestAuthenticationProvider implements AuthenticationProvider if (isAdmin) { authorities.add(new SimpleGrantedAuthority(ADMIN_GRANT)); } else if ((isCommunityAdmin && AuthorizeUtil.canCommunityAdminManageAccounts()) - || (isColectionAdmin && AuthorizeUtil.canCollectionAdminManageAccounts())) { + || (isCollectionAdmin && AuthorizeUtil.canCollectionAdminManageAccounts())) { authorities.add(new SimpleGrantedAuthority(ACCOUNT_ADMIN_GRANT)); } From d9d698dcd1d11503742ef4f91e85eee71c73bc87 Mon Sep 17 00:00:00 2001 From: Mykhaylo Date: Thu, 11 Jun 2020 19:19:02 +0200 Subject: [PATCH 105/125] Implement community feedbacks --- .../dspace/content/CollectionServiceImpl.java | 22 +++++++-------- .../app/rest/CollectionRestRepositoryIT.java | 27 +++++++++++++++++++ .../dspace/app/rest/builder/GroupBuilder.java | 5 ++++ 3 files changed, 41 insertions(+), 13 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/content/CollectionServiceImpl.java b/dspace-api/src/main/java/org/dspace/content/CollectionServiceImpl.java index dbe34a2051..2809ca5bad 100644 --- a/dspace-api/src/main/java/org/dspace/content/CollectionServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/CollectionServiceImpl.java @@ -924,12 +924,11 @@ public class CollectionServiceImpl extends DSpaceObjectServiceImpl i int offset, int limit) throws SQLException, SearchServiceException { List collections = new ArrayList(); - StringBuilder query = new StringBuilder(); DiscoverQuery discoverQuery = new DiscoverQuery(); discoverQuery.setDSpaceObjectFilter(IndexableCollection.TYPE); discoverQuery.setStart(offset); discoverQuery.setMaxResults(limit); - DiscoverResult resp = resultSolrQuery(context, query, discoverQuery,community, q); + DiscoverResult resp = retrieveAuthorizedCollections(context, discoverQuery,community, q); for (IndexableObject solrCollections : resp.getIndexableObjects()) { Collection c = ((IndexableCollection) solrCollections).getIndexedObject(); collections.add(c); @@ -941,27 +940,24 @@ public class CollectionServiceImpl extends DSpaceObjectServiceImpl i public int countAuthorizedCollectionsInSOLR(String q, Context context, Community community) throws SQLException, SearchServiceException { - StringBuilder query = new StringBuilder(); DiscoverQuery discoverQuery = new DiscoverQuery(); + discoverQuery.setMaxResults(0); discoverQuery.setDSpaceObjectFilter(IndexableCollection.TYPE); - DiscoverResult resp = resultSolrQuery(context, query, discoverQuery,community,q); + DiscoverResult resp = retrieveAuthorizedCollections(context, discoverQuery,community,q); return (int)resp.getTotalSearchResults(); } - private DiscoverResult resultSolrQuery(Context context, StringBuilder query, DiscoverQuery discoverQuery, - Community community, String q) throws SQLException, SearchServiceException { + private DiscoverResult retrieveAuthorizedCollections(Context context, DiscoverQuery discoverQuery, + Community community, String q) throws SQLException, SearchServiceException { + StringBuilder query = new StringBuilder(); EPerson currentUser = context.getCurrentUser(); if (!authorizeService.isAdmin(context)) { - Group anonymousGroup = groupService.findByName(context, Group.ANONYMOUS); - String anonGroupId = ""; - if (anonymousGroup != null) { - anonGroupId = anonymousGroup.getID().toString(); - } - query.append("submit:(g").append(anonGroupId); + String userId = ""; if (currentUser != null) { - query.append(" OR e").append(currentUser.getID()); + userId = currentUser.getID().toString(); } + query.append("submit:(e").append(userId); Set groups = groupService.allMemberGroupsSet(context, currentUser); for (Group group : groups) { query.append(" OR g").append(group.getID()); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java index 10d3f7dc56..dac32f7e44 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java @@ -30,6 +30,7 @@ import com.fasterxml.jackson.databind.ObjectMapper; import org.dspace.app.rest.builder.CollectionBuilder; import org.dspace.app.rest.builder.CommunityBuilder; import org.dspace.app.rest.builder.EPersonBuilder; +import org.dspace.app.rest.builder.GroupBuilder; import org.dspace.app.rest.builder.ResourcePolicyBuilder; import org.dspace.app.rest.converter.CollectionConverter; import org.dspace.app.rest.matcher.CollectionMatcher; @@ -49,6 +50,8 @@ import org.dspace.content.Collection; import org.dspace.content.Community; import org.dspace.core.Constants; import org.dspace.eperson.EPerson; +import org.dspace.eperson.Group; +import org.dspace.eperson.service.GroupService; import org.hamcrest.Matchers; import org.junit.Test; import org.springframework.beans.factory.annotation.Autowired; @@ -65,6 +68,9 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes @Autowired ResourcePolicyService resoucePolicyService; + @Autowired + GroupService groupService; + @Test public void findAllTest() throws Exception { @@ -479,6 +485,11 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes public void findAuthorizedCollectionsTest() throws Exception { context.turnOffAuthorisationSystem(); + EPerson eperson2 = EPersonBuilder.createEPerson(context) + .withEmail("eperson2@example.com") + .withPassword(password) + .build(); + parentCommunity = CommunityBuilder.createCommunity(context) .withName("Parent Community") .build(); @@ -500,9 +511,17 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes .withSubmitterGroup(eperson) .build(); + Group ChildGroupOfSubmitterGroup = GroupBuilder.createGroup(context) + .withName("Child group of submitters") + .withParent(col1.getSubmitters()) + .addMember(eperson2) + .build(); + context.restoreAuthSystemState(); String tokenEPerson = getAuthToken(eperson.getEmail(), password); + String tokenEPerson2 = getAuthToken(eperson2.getEmail(), password); + getClient(tokenEPerson).perform(get("/api/core/collections/search/findAuthorized")) .andExpect(status().isOk()) .andExpect(content().contentType(contentType)) @@ -512,6 +531,14 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes ))) .andExpect(jsonPath("$.page.totalElements", is(2))); + getClient(tokenEPerson2).perform(get("/api/core/collections/search/findAuthorized")) + .andExpect(status().isOk()) + .andExpect(content().contentType(contentType)) + .andExpect(jsonPath("$._embedded.collections", Matchers.contains( + CollectionMatcher.matchProperties(col1.getName(), col1.getID(), col1.getHandle()) + ))) + .andExpect(jsonPath("$.page.totalElements", is(1))); + String tokenAdmin = getAuthToken(admin.getEmail(), password); getClient(tokenAdmin).perform(get("/api/core/collections/search/findAuthorized")) .andExpect(status().isOk()) diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/builder/GroupBuilder.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/builder/GroupBuilder.java index 8208198b6d..5319a67718 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/builder/GroupBuilder.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/builder/GroupBuilder.java @@ -67,6 +67,11 @@ public class GroupBuilder extends AbstractDSpaceObjectBuilder { @Override public Group build() { + try { + groupService.update(context, group); + } catch (Exception e) { + return handleException(e); + } return group; } From c3d043f2a39710eeb3b0cbaaef75869bb1f6811d Mon Sep 17 00:00:00 2001 From: Mykhaylo Date: Fri, 12 Jun 2020 11:13:59 +0200 Subject: [PATCH 106/125] renamed variable --- .../org/dspace/app/rest/repository/EPersonRestRepository.java | 2 +- .../org/dspace/app/rest/repository/GroupRestRepository.java | 2 +- .../app/rest/security/EPersonRestAuthenticationProvider.java | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonRestRepository.java index 020f8b6af0..e044346c2b 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/EPersonRestRepository.java @@ -155,7 +155,7 @@ public class EPersonRestRepository extends DSpaceObjectRestRepository findByMetadata(@Parameter(value = "query", required = true) String query, Pageable pageable) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupRestRepository.java index f150ec0f3c..b531c4fcb7 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupRestRepository.java @@ -131,7 +131,7 @@ public class GroupRestRepository extends DSpaceObjectRestRepository findByMetadata(@Parameter(value = "query", required = true) String query, Pageable pageable) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EPersonRestAuthenticationProvider.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EPersonRestAuthenticationProvider.java index 9a5faf01ee..a470515419 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EPersonRestAuthenticationProvider.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/EPersonRestAuthenticationProvider.java @@ -48,7 +48,7 @@ public class EPersonRestAuthenticationProvider implements AuthenticationProvider private static final Logger log = LoggerFactory.getLogger(EPersonRestAuthenticationProvider.class); - public static final String ACCOUNT_ADMIN_GRANT = "ACCOUNT_ADMIN"; + public static final String MANAGE_ACCESS_GROUP = "MANAGE_ACCESS_GROUP"; @Autowired private AuthenticationService authenticationService; @@ -157,7 +157,7 @@ public class EPersonRestAuthenticationProvider implements AuthenticationProvider authorities.add(new SimpleGrantedAuthority(ADMIN_GRANT)); } else if ((isCommunityAdmin && AuthorizeUtil.canCommunityAdminManageAccounts()) || (isCollectionAdmin && AuthorizeUtil.canCollectionAdminManageAccounts())) { - authorities.add(new SimpleGrantedAuthority(ACCOUNT_ADMIN_GRANT)); + authorities.add(new SimpleGrantedAuthority(MANAGE_ACCESS_GROUP)); } authorities.add(new SimpleGrantedAuthority(AUTHENTICATED_GRANT)); From 381fe08ad029322c84049c12affb2d287b47ecae Mon Sep 17 00:00:00 2001 From: Mykhaylo Date: Fri, 12 Jun 2020 11:15:56 +0200 Subject: [PATCH 107/125] added missing annotations --- .../main/java/org/dspace/authorize/AuthorizeServiceImpl.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/dspace-api/src/main/java/org/dspace/authorize/AuthorizeServiceImpl.java b/dspace-api/src/main/java/org/dspace/authorize/AuthorizeServiceImpl.java index 2ebecf2005..07a7ac70d3 100644 --- a/dspace-api/src/main/java/org/dspace/authorize/AuthorizeServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/authorize/AuthorizeServiceImpl.java @@ -433,6 +433,7 @@ public class AuthorizeServiceImpl implements AuthorizeService { return isCommunityAdmin(c, e); } + @Override public boolean isCommunityAdmin(Context c, EPerson e) throws SQLException { if (e != null) { List policies = resourcePolicyService.find(c, e, @@ -452,6 +453,7 @@ public class AuthorizeServiceImpl implements AuthorizeService { return isCollectionAdmin(c, e); } + @Override public boolean isCollectionAdmin(Context c, EPerson e) throws SQLException { if (e != null) { List policies = resourcePolicyService.find(c, e, From 25adabe0a4ad2c3402c68b5f6cf930bfff92fdd3 Mon Sep 17 00:00:00 2001 From: Mykhaylo Date: Fri, 12 Jun 2020 11:18:52 +0200 Subject: [PATCH 108/125] cleanup tests --- .../CommunityAdminGroupRestControllerIT.java | 52 +------------------ .../app/rest/GroupRestRepositoryIT.java | 22 +------- 2 files changed, 3 insertions(+), 71 deletions(-) diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityAdminGroupRestControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityAdminGroupRestControllerIT.java index bf606def8c..fb00219a4d 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityAdminGroupRestControllerIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CommunityAdminGroupRestControllerIT.java @@ -483,11 +483,6 @@ public class CommunityAdminGroupRestControllerIT extends AbstractControllerInteg .andExpect(jsonPath("$._embedded.epersons", Matchers.not(Matchers.hasItem( EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) )))); - - context.turnOffAuthorisationSystem(); - configurationService.setProperty("core.authorization.community-admin.admin-group", true); - context.restoreAuthSystemState(); - } @Test @@ -513,9 +508,8 @@ public class CommunityAdminGroupRestControllerIT extends AbstractControllerInteg .andExpect(jsonPath("$._embedded.epersons", Matchers.hasItem( EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) ))); - context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.admin-group", false); - context.restoreAuthSystemState(); getClient(token).perform(delete("/api/eperson/groups/" + adminGroup.getID() + "/epersons/" + ePerson.getID())) .andExpect(status().isForbidden()); @@ -526,11 +520,6 @@ public class CommunityAdminGroupRestControllerIT extends AbstractControllerInteg .andExpect(jsonPath("$._embedded.epersons", Matchers.hasItem( EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) ))); - - context.turnOffAuthorisationSystem(); - configurationService.setProperty("core.authorization.community-admin.admin-group", true); - context.restoreAuthSystemState(); - } @Test @@ -559,11 +548,6 @@ public class CommunityAdminGroupRestControllerIT extends AbstractControllerInteg .andExpect(jsonPath("$._embedded.subgroups", Matchers.not(Matchers.hasItem( GroupMatcher.matchGroupWithName(group.getName()) )))); - - context.turnOffAuthorisationSystem(); - configurationService.setProperty("core.authorization.community-admin.admin-group", true); - context.restoreAuthSystemState(); - } @Test @@ -590,9 +574,7 @@ public class CommunityAdminGroupRestControllerIT extends AbstractControllerInteg GroupMatcher.matchGroupWithName(group.getName()) ))); - context.turnOffAuthorisationSystem(); configurationService.setProperty("core.authorization.community-admin.admin-group", false); - context.restoreAuthSystemState(); getClient(token).perform(delete("/api/eperson/groups/" + adminGroup.getID() + "/subgroups/" + group.getID())) .andExpect(status().isForbidden()); @@ -603,10 +585,6 @@ public class CommunityAdminGroupRestControllerIT extends AbstractControllerInteg .andExpect(jsonPath("$._embedded.subgroups", Matchers.hasItem( GroupMatcher.matchGroupWithName(group.getName()) ))); - - context.turnOffAuthorisationSystem(); - configurationService.setProperty("core.authorization.community-admin.admin-group", true); - context.restoreAuthSystemState(); } @Test @@ -697,12 +675,6 @@ public class CommunityAdminGroupRestControllerIT extends AbstractControllerInteg .andExpect(jsonPath("$._embedded.epersons", Matchers.not(Matchers.hasItem( EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) )))); - - context.turnOffAuthorisationSystem(); - configurationService.setProperty("core.authorization.community-admin.collection.admin-group", true); - configurationService.setProperty("core.authorization.collection-admin.admin-group", true); - context.restoreAuthSystemState(); - } @Test @@ -728,10 +700,9 @@ public class CommunityAdminGroupRestControllerIT extends AbstractControllerInteg .andExpect(jsonPath("$._embedded.epersons", Matchers.hasItem( EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) ))); - context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", false); configurationService.setProperty("core.authorization.collection-admin.admin-group", false); - context.restoreAuthSystemState(); getClient(token).perform(delete("/api/eperson/groups/" + adminGroup.getID() + "/epersons/" + ePerson.getID())) .andExpect(status().isForbidden()); @@ -742,12 +713,6 @@ public class CommunityAdminGroupRestControllerIT extends AbstractControllerInteg .andExpect(jsonPath("$._embedded.epersons", Matchers.hasItem( EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) ))); - - context.turnOffAuthorisationSystem(); - configurationService.setProperty("core.authorization.community-admin.collection.admin-group", true); - configurationService.setProperty("core.authorization.collection-admin.admin-group", true); - context.restoreAuthSystemState(); - } @Test @@ -777,12 +742,6 @@ public class CommunityAdminGroupRestControllerIT extends AbstractControllerInteg .andExpect(jsonPath("$._embedded.subgroups", Matchers.not(Matchers.hasItem( GroupMatcher.matchGroupWithName(group.getName()) )))); - - context.turnOffAuthorisationSystem(); - configurationService.setProperty("core.authorization.community-admin.collection.admin-group", true); - configurationService.setProperty("core.authorization.collection-admin.admin-group", true); - context.restoreAuthSystemState(); - } @Test @@ -809,10 +768,8 @@ public class CommunityAdminGroupRestControllerIT extends AbstractControllerInteg GroupMatcher.matchGroupWithName(group.getName()) ))); - context.turnOffAuthorisationSystem(); configurationService.setProperty("core.authorization.community-admin.collection.admin-group", false); configurationService.setProperty("core.authorization.collection-admin.admin-group", false); - context.restoreAuthSystemState(); getClient(token).perform(delete("/api/eperson/groups/" + adminGroup.getID() + "/subgroups/" + group.getID())) .andExpect(status().isForbidden()); @@ -823,10 +780,5 @@ public class CommunityAdminGroupRestControllerIT extends AbstractControllerInteg .andExpect(jsonPath("$._embedded.subgroups", Matchers.hasItem( GroupMatcher.matchGroupWithName(group.getName()) ))); - - context.turnOffAuthorisationSystem(); - configurationService.setProperty("core.authorization.community-admin.collection.admin-group", true); - configurationService.setProperty("core.authorization.collection-admin.admin-group", true); - context.restoreAuthSystemState(); } } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java index ff5e69c396..868b5d271e 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/GroupRestRepositoryIT.java @@ -2819,10 +2819,9 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { .andExpect(jsonPath("$._embedded.epersons", Matchers.hasItem( EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) ))); - context.turnOffAuthorisationSystem(); + configurationService.setProperty("core.authorization.community-admin.collection.admin-group", false); configurationService.setProperty("core.authorization.collection-admin.admin-group", false); - context.restoreAuthSystemState(); getClient(token).perform(delete("/api/eperson/groups/" + adminGroup.getID() + "/epersons/" + ePerson.getID())) .andExpect(status().isForbidden()); @@ -2833,12 +2832,6 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { .andExpect(jsonPath("$._embedded.epersons", Matchers.hasItem( EPersonMatcher.matchEPersonOnEmail(ePerson.getEmail()) ))); - - context.turnOffAuthorisationSystem(); - configurationService.setProperty("core.authorization.community-admin.collection.admin-group", true); - configurationService.setProperty("core.authorization.collection-admin.admin-group", true); - context.restoreAuthSystemState(); - } @Test @@ -2868,12 +2861,6 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { .andExpect(jsonPath("$._embedded.subgroups", Matchers.not(Matchers.hasItem( GroupMatcher.matchGroupWithName(group.getName()) )))); - - context.turnOffAuthorisationSystem(); - configurationService.setProperty("core.authorization.community-admin.collection.admin-group", true); - configurationService.setProperty("core.authorization.collection-admin.admin-group", true); - context.restoreAuthSystemState(); - } @Test @@ -2900,10 +2887,8 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { GroupMatcher.matchGroupWithName(group.getName()) ))); - context.turnOffAuthorisationSystem(); configurationService.setProperty("core.authorization.community-admin.collection.admin-group", false); configurationService.setProperty("core.authorization.collection-admin.admin-group", false); - context.restoreAuthSystemState(); getClient(token).perform(delete("/api/eperson/groups/" + adminGroup.getID() + "/subgroups/" + group.getID())) .andExpect(status().isForbidden()); @@ -2914,11 +2899,6 @@ public class GroupRestRepositoryIT extends AbstractControllerIntegrationTest { .andExpect(jsonPath("$._embedded.subgroups", Matchers.hasItem( GroupMatcher.matchGroupWithName(group.getName()) ))); - - context.turnOffAuthorisationSystem(); - configurationService.setProperty("core.authorization.community-admin.collection.admin-group", true); - configurationService.setProperty("core.authorization.collection-admin.admin-group", true); - context.restoreAuthSystemState(); } } From a15570b5fbf0bfa34711383d1ae48ed95ea5e424 Mon Sep 17 00:00:00 2001 From: Marie Verdonck Date: Mon, 15 Jun 2020 12:59:03 +0200 Subject: [PATCH 109/125] 71356: Private bitstreams their metadata still accessible --- .../repository/BitstreamRestRepository.java | 2 +- ...MetadataReadPermissionEvaluatorPlugin.java | 38 +++++++++++ .../app/rest/BitstreamRestRepositoryIT.java | 63 +++++++++++++++++++ .../app/rest/matcher/BitstreamMatcher.java | 2 +- 4 files changed, 103 insertions(+), 2 deletions(-) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BitstreamMetadataReadPermissionEvaluatorPlugin.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamRestRepository.java index 2d29781c9b..5218250eee 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamRestRepository.java @@ -71,7 +71,7 @@ public class BitstreamRestRepository extends DSpaceObjectRestRepository matchProperties(Bitstream bitstream) { + public static Matcher matchProperties(Bitstream bitstream) { try { return allOf( hasJsonPath("$.uuid", is(bitstream.getID().toString())), From 344f66452169f9b4692327682394d712d907ca36 Mon Sep 17 00:00:00 2001 From: Marie Verdonck Date: Mon, 15 Jun 2020 14:01:36 +0200 Subject: [PATCH 110/125] license added --- .../BitstreamMetadataReadPermissionEvaluatorPlugin.java | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BitstreamMetadataReadPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BitstreamMetadataReadPermissionEvaluatorPlugin.java index 07058246d7..33ebb6c98b 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BitstreamMetadataReadPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/BitstreamMetadataReadPermissionEvaluatorPlugin.java @@ -1,3 +1,10 @@ +/** + * 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.rest.security; import java.io.Serializable; From b32c461006ecb8ae32222199891c0025e7b694ab Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Mon, 15 Jun 2020 14:58:11 +0200 Subject: [PATCH 111/125] [Task 71405] applied community feedback to the Scripts and Processes endpoints --- .../main/java/org/dspace/scripts/Process.java | 2 +- .../dspace/scripts/ProcessServiceImpl.java | 29 ++++-- .../scripts/service/ProcessService.java | 16 ++- .../app/rest/ProcessFilesRestController.java | 57 ----------- .../link/process/ProcessHalLinkFactory.java | 6 +- .../ProcessResourceHalLinkFactory.java | 6 +- .../ProcessFilesLinkRepository.java | 23 +++-- .../repository/ProcessRestRepository.java | 97 +++++-------------- dspace/config/registries/dspace-types.xml | 2 +- 9 files changed, 80 insertions(+), 158 deletions(-) delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessFilesRestController.java diff --git a/dspace-api/src/main/java/org/dspace/scripts/Process.java b/dspace-api/src/main/java/org/dspace/scripts/Process.java index 19ce03b7fa..2a84245fb4 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/Process.java +++ b/dspace-api/src/main/java/org/dspace/scripts/Process.java @@ -80,7 +80,7 @@ public class Process implements ReloadableEntity { @Temporal(TemporalType.TIMESTAMP) private Date creationTime; - public static final String BITSTREAM_TYPE_METADATAFIELD = "dspace.process.type"; + public static final String BITSTREAM_TYPE_METADATAFIELD = "dspace.process.filetype"; protected Process() { } diff --git a/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java b/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java index daa7181d37..fd36c4d766 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java @@ -23,10 +23,12 @@ import org.apache.logging.log4j.Logger; import org.dspace.authorize.AuthorizeException; import org.dspace.authorize.service.AuthorizeService; import org.dspace.content.Bitstream; +import org.dspace.content.MetadataField; import org.dspace.content.ProcessStatus; import org.dspace.content.dao.ProcessDAO; import org.dspace.content.service.BitstreamFormatService; import org.dspace.content.service.BitstreamService; +import org.dspace.content.service.MetadataFieldService; import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.core.LogManager; @@ -53,6 +55,9 @@ public class ProcessServiceImpl implements ProcessService { @Autowired private AuthorizeService authorizeService; + @Autowired + private MetadataFieldService metadataFieldService; + @Override public Process create(Context context, EPerson ePerson, String scriptName, List parameters) throws SQLException { @@ -134,9 +139,15 @@ public class ProcessServiceImpl implements ProcessService { public void appendFile(Context context, Process process, InputStream is, String type, String fileName) throws IOException, SQLException, AuthorizeException { Bitstream bitstream = bitstreamService.create(context, is); + if (getBitstream(context, process, type) != null) { + throw new IllegalArgumentException("Cannot create another file of type: " + type + " for this process" + + " with id: " + process.getID()); + } bitstream.setName(context, fileName); bitstreamService.setFormat(context, bitstream, bitstreamFormatService.guessFormat(context, bitstream)); - bitstreamService.addMetadata(context, bitstream, "dspace", "process", "type", null, type); + MetadataField dspaceProcessFileTypeField = metadataFieldService + .findByString(context, Process.BITSTREAM_TYPE_METADATAFIELD, '.'); + bitstreamService.addMetadata(context, bitstream, dspaceProcessFileTypeField, null, type); authorizeService.addPolicy(context, bitstream, Constants.READ, context.getCurrentUser()); authorizeService.addPolicy(context, bitstream, Constants.WRITE, context.getCurrentUser()); authorizeService.addPolicy(context, bitstream, Constants.DELETE, context.getCurrentUser()); @@ -179,7 +190,7 @@ public class ProcessServiceImpl implements ProcessService { @Override public Bitstream getBitstreamByName(Context context, Process process, String bitstreamName) { - for (Bitstream bitstream : getBitstreams(context, process, null)) { + for (Bitstream bitstream : getBitstreams(context, process)) { if (StringUtils.equals(bitstream.getName(), bitstreamName)) { return bitstream; } @@ -189,21 +200,25 @@ public class ProcessServiceImpl implements ProcessService { } @Override - public List getBitstreams(Context context, Process process, String type) { + public Bitstream getBitstream(Context context, Process process, String type) { List allBitstreams = process.getBitstreams(); if (type == null) { - return allBitstreams; + return null; } else { - List filteredBitstreams = new ArrayList<>(); for (Bitstream bitstream : allBitstreams) { if (StringUtils.equals(bitstreamService.getMetadata(bitstream, Process.BITSTREAM_TYPE_METADATAFIELD), type)) { - filteredBitstreams.add(bitstream); + return bitstream; } } - return filteredBitstreams; } + return null; + } + + @Override + public List getBitstreams(Context context, Process process) { + return process.getBitstreams(); } public int countTotal(Context context) throws SQLException { diff --git a/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java b/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java index 28f302f9e3..40f59cfcf8 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java +++ b/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java @@ -157,15 +157,21 @@ public interface ProcessService { public Bitstream getBitstreamByName(Context context, Process process, String bitstreamName); /** - * This method will return all the Bitstreams for a given process if the type is defined as null. If type is - * different than null, the bitstreams with metadata process.type equal to the given type from that process - * are returned + * This method will return the Bitstream for a given process with a given type * @param context The relevant DSpace context * @param process The process that holds the Bitstreams to be searched in * @param type The type that the Bitstream must have - * @return The list of Bitstreams of the given type for the given Process + * @return The Bitstream of the given type for the given Process */ - public List getBitstreams(Context context, Process process, String type); + public Bitstream getBitstream(Context context, Process process, String type); + + /** + * This method will return all the Bitstreams for a given process + * @param context The relevant DSpace context + * @param process The process that holds the Bitstreams to be searched in + * @return The list of Bitstreams + */ + public List getBitstreams(Context context, Process process); /** * Returns the total amount of Process objects in the dataase diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessFilesRestController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessFilesRestController.java deleted file mode 100644 index ae49af25ee..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ProcessFilesRestController.java +++ /dev/null @@ -1,57 +0,0 @@ -/** - * 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.rest; - -import java.sql.SQLException; - -import org.apache.logging.log4j.LogManager; -import org.apache.logging.log4j.Logger; -import org.dspace.app.rest.link.HalLinkService; -import org.dspace.app.rest.link.process.ProcessResourceHalLinkFactory; -import org.dspace.app.rest.model.BitstreamRest; -import org.dspace.app.rest.model.ProcessRest; -import org.dspace.app.rest.model.hateoas.BitstreamResource; -import org.dspace.app.rest.repository.ProcessRestRepository; -import org.dspace.app.rest.utils.Utils; -import org.dspace.authorize.AuthorizeException; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.security.access.prepost.PreAuthorize; -import org.springframework.web.bind.annotation.PathVariable; -import org.springframework.web.bind.annotation.RequestMapping; -import org.springframework.web.bind.annotation.RequestMethod; -import org.springframework.web.bind.annotation.RestController; - -@RestController -@RequestMapping("/api/" + ProcessRest.CATEGORY + "/" + ProcessRest.PLURAL_NAME + - "/{processId}/files/name/{fileName:.+}") -public class ProcessFilesRestController { - - private static final Logger log = LogManager.getLogger(); - - @Autowired - HalLinkService linkService; - - @Autowired - private ProcessRestRepository processRestRepository; - - @Autowired - private Utils utils; - - @Autowired - ProcessResourceHalLinkFactory processResourceHalLinkFactory; - - @RequestMapping(method = RequestMethod.GET) - @PreAuthorize("hasPermission(#processId, 'PROCESS', 'READ')") - public BitstreamResource getBitstreamByName(@PathVariable(name = "processId") Integer processId, - @PathVariable(name = "fileName") String fileName) - throws SQLException, AuthorizeException { - - BitstreamRest bitstreamRest = processRestRepository.getProcessBitstreamByName(processId, fileName); - return new BitstreamResource(bitstreamRest, utils); - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessHalLinkFactory.java index 1ef52f6b1c..519b89fe7a 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessHalLinkFactory.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessHalLinkFactory.java @@ -7,13 +7,13 @@ */ package org.dspace.app.rest.link.process; -import org.dspace.app.rest.ProcessFilesRestController; +import org.dspace.app.rest.RestResourceController; import org.dspace.app.rest.link.HalLinkFactory; /** - * This abstract class offers an easily extendable HalLinkFactory class to use methods on the ProcessRestController + * This abstract class offers an easily extendable HalLinkFactory class to use methods on the RestResourceController * and make it more easy to read or define which methods should be found in the getMethodOn methods when building links * @param This parameter should be of type {@link org.dspace.app.rest.model.hateoas.HALResource} */ -public abstract class ProcessHalLinkFactory extends HalLinkFactory { +public abstract class ProcessHalLinkFactory extends HalLinkFactory { } \ No newline at end of file diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java index 1dc8058ac7..a27e8acc46 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/ProcessResourceHalLinkFactory.java @@ -9,7 +9,7 @@ package org.dspace.app.rest.link.process; import java.util.LinkedList; -import org.dspace.app.rest.ProcessFilesRestController; +import org.dspace.app.rest.RestResourceController; import org.dspace.app.rest.model.hateoas.ProcessResource; import org.dspace.services.ConfigurationService; import org.springframework.beans.factory.annotation.Autowired; @@ -35,8 +35,8 @@ public class ProcessResourceHalLinkFactory extends ProcessHalLinkFactory getControllerClass() { - return ProcessFilesRestController.class; + protected Class getControllerClass() { + return RestResourceController.class; } @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java index a76019bad7..bc19faf145 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java @@ -8,7 +8,6 @@ package org.dspace.app.rest.repository; import java.sql.SQLException; -import java.util.List; import javax.annotation.Nullable; import javax.servlet.http.HttpServletRequest; @@ -20,7 +19,6 @@ import org.dspace.app.rest.model.ProcessRest; import org.dspace.app.rest.projection.Projection; import org.dspace.authorize.AuthorizeException; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Component; @@ -63,20 +61,25 @@ public class ProcessFilesLinkRepository extends AbstractDSpaceRestRepository imp return processFileWrapperRest; } + /** + * This method will retrieve a bitstream for the given processId for the given fileType + * @param request The current request + * @param processId The processId for the process to search in + * @param fileType The filetype that the bitstream has to be + * @param pageable Pageable if applicable + * @param projection The current projection + * @return The BitstreamRest object that corresponds with the Process and type + * @throws SQLException If something goes wrong + * @throws AuthorizeException If something goes wrong + */ @PreAuthorize("hasPermission(#processId, 'PROCESS', 'READ')") - public Page getResource(HttpServletRequest request, String processId, String fileType, + public BitstreamRest getFileFromProcessByType(HttpServletRequest request, String processId, String fileType, Pageable pageable, Projection projection) throws SQLException, AuthorizeException { if (log.isTraceEnabled()) { log.trace("Retrieving Files with type " + fileType + " from Process with ID: " + processId); } - List bitstreamRests = processRestRepository - .getProcessBitstreamsByType(Integer.parseInt(processId), fileType); - - Page page = utils.getPage(bitstreamRests, pageable); - - - return page; + return processRestRepository.getProcessBitstreamByType(Integer.parseInt(processId), fileType); } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java index f5fb6ab3ab..1a545ce5e0 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java @@ -9,7 +9,6 @@ package org.dspace.app.rest.repository; import java.io.IOException; import java.sql.SQLException; -import java.util.Collections; import java.util.List; import java.util.stream.Collectors; @@ -17,7 +16,6 @@ import org.apache.log4j.Logger; import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.exception.RepositoryMethodNotImplementedException; import org.dspace.app.rest.model.BitstreamRest; -import org.dspace.app.rest.model.ProcessFileWrapperRest; import org.dspace.app.rest.model.ProcessRest; import org.dspace.app.rest.projection.Projection; import org.dspace.authorize.AuthorizeException; @@ -81,92 +79,49 @@ public class ProcessRestRepository extends DSpaceRestRepository getProcessBitstreams(Integer processId) throws SQLException, AuthorizeException { - return getProcessBitstreamsByType(processId, null); + Context context = obtainContext(); + Process process = getProcess(processId, context); + List bitstreams = processService.getBitstreams(context, process); + return bitstreams.stream() + .map(bitstream -> (BitstreamRest) converterService.toRest(bitstream, Projection.DEFAULT)) + .collect(Collectors.toList()); + } + + private Process getProcess(Integer processId, Context context) throws SQLException, AuthorizeException { + Process process = processService.find(context, processId); + if (process == null) { + throw new ResourceNotFoundException("Process with id " + processId + " was not found"); + } + if ((context.getCurrentUser() == null) || (!context.getCurrentUser() + .equals(process.getEPerson()) && !authorizeService + .isAdmin(context))) { + throw new AuthorizeException("The current user is not eligible to view the process with id: " + processId); + } + return process; } /** - * Creates a ProcessFileWrapperRest object for the given ProcessId by setting the ProcessId on this object - * and getting the Bitstreams for this project and setting this on the REST object - * @param processId The given ProcessId - * @return The ProcessFileWrapperRest object with the ProcessId and the list of bitstreams filled in - * @throws SQLException If something goes wrong - * @throws AuthorizeException If something goes wrong - */ - public ProcessFileWrapperRest getProcessFileWrapperRest(Integer processId) throws SQLException, AuthorizeException { - ProcessFileWrapperRest processFileWrapperRest = new ProcessFileWrapperRest(); - processFileWrapperRest.setBitstreams(getProcessBitstreams(processId)); - processFileWrapperRest.setProcessId(processId); - - return processFileWrapperRest; - } - - /** - * Retrieves the Bitstreams in the given Process of a given type + * Retrieves the Bitstream in the given Process of a given type * @param processId The processId of the Process to be used * @param type The type of bitstreams to be returned, if null it'll return all the bitstreams - * @return The list of bitstreams for the given parameters + * @return The bitstream for the given parameters * @throws SQLException If something goes wrong * @throws AuthorizeException If something goes wrong */ - public List getProcessBitstreamsByType(Integer processId, String type) + public BitstreamRest getProcessBitstreamByType(Integer processId, String type) throws SQLException, AuthorizeException { Context context = obtainContext(); - Process process = processService.find(context, processId); - if (process == null) { - throw new ResourceNotFoundException("Process with id " + processId + " was not found"); - } - if ((context.getCurrentUser() == null) || (!context.getCurrentUser() - .equals(process.getEPerson()) && !authorizeService - .isAdmin(context))) { - throw new AuthorizeException("The current user is not eligible to view the process with id: " + processId); - } - List bitstreams = processService.getBitstreams(context, process, type); + Process process = getProcess(processId, context); + Bitstream bitstream = processService.getBitstream(context, process, type); - if (bitstreams == null) { - return Collections.emptyList(); - } - - return bitstreams.stream() - .map(bitstream -> (BitstreamRest) converterService.toRest(bitstream, Projection.DEFAULT)) - .collect(Collectors.toList()); - - } - - /** - * Retrieves the Bitstream from a Process with the given ProcessId that has the given name - * @param processId The processId of the Process that we'll search its Bitstreams for the name - * @param name The name that the bitstream needs to have to be returned - * @return The bitstream that's linked to the given Process with the given name - * @throws SQLException If something goes wrong - * @throws AuthorizeException If something goes wrong - */ - public BitstreamRest getProcessBitstreamByName(Integer processId, String name) - throws SQLException, AuthorizeException { - Context context = obtainContext(); - Process process = processService.find(context, processId); - if (process == null) { - throw new ResourceNotFoundException("Process with id " + processId + " was not found"); - } - if ((context.getCurrentUser() == null) || (!context.getCurrentUser() - .equals(process.getEPerson()) && !authorizeService - .isAdmin(context))) { - throw new AuthorizeException("The current user is not eligible to view the process with id: " + processId); - } - Bitstream bitstream = processService.getBitstreamByName(context, process, name); - - if (bitstream == null) { - throw new ResourceNotFoundException( - "Bitstream with name " + name + " and process id " + processId + " was not found"); - } - - return converterService.toRest(bitstream, Projection.DEFAULT); + return converterService.toRest(bitstream, utils.obtainProjection()); } @Override diff --git a/dspace/config/registries/dspace-types.xml b/dspace/config/registries/dspace-types.xml index 74e7092776..56985373f0 100644 --- a/dspace/config/registries/dspace-types.xml +++ b/dspace/config/registries/dspace-types.xml @@ -12,7 +12,7 @@ dspace process - type + filetype From 31c87c2ba1d6771def879dd7d15eb03f59310984 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Tue, 16 Jun 2020 09:46:01 +0200 Subject: [PATCH 112/125] [Task 71405] fixed the Process Files endpoints and added two tests for them --- .../main/java/org/dspace/scripts/Process.java | 4 ++ .../dspace/scripts/ProcessServiceImpl.java | 10 ++-- .../ProcessFilesLinkRepository.java | 2 +- .../app/rest/ProcessRestRepositoryIT.java | 54 +++++++++++++++---- .../app/rest/builder/ProcessBuilder.java | 1 + 5 files changed, 56 insertions(+), 15 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/scripts/Process.java b/dspace-api/src/main/java/org/dspace/scripts/Process.java index 2a84245fb4..c58669e6d9 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/Process.java +++ b/dspace-api/src/main/java/org/dspace/scripts/Process.java @@ -8,6 +8,7 @@ package org.dspace.scripts; import java.util.Date; +import java.util.LinkedList; import java.util.List; import javax.persistence.Column; import javax.persistence.Entity; @@ -176,6 +177,9 @@ public class Process implements ReloadableEntity { * @return The Bitstreams that are used or created by the process */ public List getBitstreams() { + if (bitstreams == null) { + bitstreams = new LinkedList<>(); + } return bitstreams; } diff --git a/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java b/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java index fd36c4d766..00f5f66b4c 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java @@ -206,10 +206,12 @@ public class ProcessServiceImpl implements ProcessService { if (type == null) { return null; } else { - for (Bitstream bitstream : allBitstreams) { - if (StringUtils.equals(bitstreamService.getMetadata(bitstream, Process.BITSTREAM_TYPE_METADATAFIELD), - type)) { - return bitstream; + if (allBitstreams != null) { + for (Bitstream bitstream : allBitstreams) { + if (StringUtils.equals(bitstreamService.getMetadata(bitstream, + Process.BITSTREAM_TYPE_METADATAFIELD), type)) { + return bitstream; + } } } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java index bc19faf145..fc6be33a14 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java @@ -73,7 +73,7 @@ public class ProcessFilesLinkRepository extends AbstractDSpaceRestRepository imp * @throws AuthorizeException If something goes wrong */ @PreAuthorize("hasPermission(#processId, 'PROCESS', 'READ')") - public BitstreamRest getFileFromProcessByType(HttpServletRequest request, String processId, String fileType, + public BitstreamRest getResource(HttpServletRequest request, String processId, String fileType, Pageable pageable, Projection projection) throws SQLException, AuthorizeException { if (log.isTraceEnabled()) { diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ProcessRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ProcessRestRepositoryIT.java index c90ad14b19..978f4e498f 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ProcessRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ProcessRestRepositoryIT.java @@ -13,16 +13,17 @@ import static org.springframework.test.web.servlet.request.MockMvcRequestBuilder import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; -import java.io.IOException; +import java.io.InputStream; import java.sql.SQLException; import java.util.LinkedList; -import org.apache.commons.collections4.CollectionUtils; +import org.apache.commons.codec.CharEncoding; +import org.apache.commons.io.IOUtils; import org.dspace.app.rest.builder.ProcessBuilder; import org.dspace.app.rest.matcher.PageMatcher; import org.dspace.app.rest.matcher.ProcessMatcher; import org.dspace.app.rest.test.AbstractControllerIntegrationTest; -import org.dspace.authorize.AuthorizeException; +import org.dspace.content.Bitstream; import org.dspace.content.ProcessStatus; import org.dspace.scripts.DSpaceCommandLineParameter; import org.dspace.scripts.Process; @@ -203,15 +204,48 @@ public class ProcessRestRepositoryIT extends AbstractControllerIntegrationTest { .andExpect(status().isForbidden()); } + @Test + public void getProcessFiles() throws Exception { + Process newProcess = ProcessBuilder.createProcess(context, eperson, "mock-script", new LinkedList<>()).build(); + + try (InputStream is = IOUtils.toInputStream("Test File For Process", CharEncoding.UTF_8)) { + processService.appendFile(context, process, is, "inputfile", "test.csv"); + } + Bitstream bitstream = processService.getBitstream(context, process, "inputfile"); + + String token = getAuthToken(admin.getEmail(), password); + + getClient(token).perform(get("/api/system/processes/" + process.getID() + "/files")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.inputfile[0].name", is("test.csv"))) + .andExpect(jsonPath("$._embedded.inputfile[0].uuid", is(bitstream.getID().toString()))) + .andExpect(jsonPath("$._embedded.inputfile[0].metadata['dspace.process.filetype']" + + "[0].value", is("inputfile"))); + + } + + @Test + public void getProcessFilesByFileType() throws Exception { + Process newProcess = ProcessBuilder.createProcess(context, eperson, "mock-script", new LinkedList<>()).build(); + + try (InputStream is = IOUtils.toInputStream("Test File For Process", CharEncoding.UTF_8)) { + processService.appendFile(context, process, is, "inputfile", "test.csv"); + } + Bitstream bitstream = processService.getBitstream(context, process, "inputfile"); + + String token = getAuthToken(admin.getEmail(), password); + + getClient(token).perform(get("/api/system/processes/" + process.getID() + "/files/inputfile")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$._embedded.bitstreams[0].name", is("test.csv"))) + .andExpect(jsonPath("$._embedded.bitstreams[0].uuid", is(bitstream.getID().toString()))) + .andExpect(jsonPath("$._embedded.bitstreams[0].metadata['dspace.process.filetype']" + + "[0].value", is("inputfile"))); + + } + @After public void destroy() throws Exception { - CollectionUtils.emptyIfNull(processService.findAll(context)).stream().forEach(process -> { - try { - processService.delete(context, process); - } catch (SQLException | IOException | AuthorizeException e) { - throw new RuntimeException(e); - } - }); super.destroy(); } } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/builder/ProcessBuilder.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/builder/ProcessBuilder.java index d7dd0493a9..5749a44b79 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/builder/ProcessBuilder.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/builder/ProcessBuilder.java @@ -43,6 +43,7 @@ public class ProcessBuilder extends AbstractBuilder { return this; } + @Override public void cleanup() throws Exception { try (Context c = new Context()) { c.turnOffAuthorisationSystem(); From eef6868a2f158ec927c49234dc22892b9b7fb9c8 Mon Sep 17 00:00:00 2001 From: Mykhaylo Date: Tue, 16 Jun 2020 11:09:32 +0200 Subject: [PATCH 113/125] renamed methods --- .../dspace/content/CollectionServiceImpl.java | 25 ++++++++--- .../content/service/CollectionService.java | 12 +++++- .../repository/CollectionRestRepository.java | 16 +++---- .../app/rest/CollectionRestRepositoryIT.java | 42 +++++++++---------- 4 files changed, 59 insertions(+), 36 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/content/CollectionServiceImpl.java b/dspace-api/src/main/java/org/dspace/content/CollectionServiceImpl.java index 2809ca5bad..34bf4f5fc1 100644 --- a/dspace-api/src/main/java/org/dspace/content/CollectionServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/CollectionServiceImpl.java @@ -920,7 +920,7 @@ public class CollectionServiceImpl extends DSpaceObjectServiceImpl i } @Override - public List findAuthorizedCollectionsInSOLR(String q, Context context, Community community, + public List findCollectionsWithSubmit(String q, Context context, Community community, int offset, int limit) throws SQLException, SearchServiceException { List collections = new ArrayList(); @@ -928,7 +928,7 @@ public class CollectionServiceImpl extends DSpaceObjectServiceImpl i discoverQuery.setDSpaceObjectFilter(IndexableCollection.TYPE); discoverQuery.setStart(offset); discoverQuery.setMaxResults(limit); - DiscoverResult resp = retrieveAuthorizedCollections(context, discoverQuery,community, q); + DiscoverResult resp = retrieveCollectionsWithSubmit(context, discoverQuery,community, q); for (IndexableObject solrCollections : resp.getIndexableObjects()) { Collection c = ((IndexableCollection) solrCollections).getIndexedObject(); collections.add(c); @@ -937,17 +937,32 @@ public class CollectionServiceImpl extends DSpaceObjectServiceImpl i } @Override - public int countAuthorizedCollectionsInSOLR(String q, Context context, Community community) + public int countCollectionsWithSubmit(String q, Context context, Community community) throws SQLException, SearchServiceException { DiscoverQuery discoverQuery = new DiscoverQuery(); discoverQuery.setMaxResults(0); discoverQuery.setDSpaceObjectFilter(IndexableCollection.TYPE); - DiscoverResult resp = retrieveAuthorizedCollections(context, discoverQuery,community,q); + DiscoverResult resp = retrieveCollectionsWithSubmit(context, discoverQuery,community,q); return (int)resp.getTotalSearchResults(); } - private DiscoverResult retrieveAuthorizedCollections(Context context, DiscoverQuery discoverQuery, + /** + * Finds all Indexed Collections where the current user has submit rights. If the user is an Admin, + * this is all Indexed Collections. Otherwise, it includes those collections where + * an indexed "submit" policy lists either the eperson or one of the eperson's groups + * + * @param context DSpace context + * @param discoverQuery + * @param community parent community, could be null + * @param q limit the returned collection to those with metadata values matching the query + * terms. The terms are used to make also a prefix query on SOLR + * so it can be used to implement an autosuggest feature over the collection name + * @return discovery search result objects + * @throws SQLException if something goes wrong + * @throws SearchServiceException if search error + */ + private DiscoverResult retrieveCollectionsWithSubmit(Context context, DiscoverQuery discoverQuery, Community community, String q) throws SQLException, SearchServiceException { StringBuilder query = new StringBuilder(); diff --git a/dspace-api/src/main/java/org/dspace/content/service/CollectionService.java b/dspace-api/src/main/java/org/dspace/content/service/CollectionService.java index 1194ac70b0..8637b61703 100644 --- a/dspace-api/src/main/java/org/dspace/content/service/CollectionService.java +++ b/dspace-api/src/main/java/org/dspace/content/service/CollectionService.java @@ -358,6 +358,10 @@ public interface CollectionService throws SQLException, AuthorizeException; /** + * Returns Collections for which the current user has 'submit' privileges. + * NOTE: for better performance, this method retrieves its results from an + * index (cache) and does not query the database directly. + * This means that results may be stale or outdated until DS-4524 is resolved" * * @param q limit the returned collection to those with metadata values matching the query terms. * The terms are used to make also a prefix query on SOLR so it can be used to implement @@ -370,10 +374,14 @@ public interface CollectionService * @throws SQLException if something goes wrong * @throws SearchServiceException if search error */ - public List findAuthorizedCollectionsInSOLR(String q, Context context, Community community, + public List findCollectionsWithSubmit(String q, Context context, Community community, int offset, int limit) throws SQLException, SearchServiceException; /** + * Counts the number of Collection for which the current user has 'submit' privileges. + * NOTE: for better performance, this method retrieves its results from an index (cache) + * and does not query the database directly. + * This means that results may be stale or outdated until DS-4524 is resolved." * * @param q limit the returned collection to those with metadata values matching the query terms. * The terms are used to make also a prefix query on SOLR so it can be used to implement @@ -384,6 +392,6 @@ public interface CollectionService * @throws SQLException if something goes wrong * @throws SearchServiceException if search error */ - public int countAuthorizedCollectionsInSOLR(String q, Context context, Community community) + public int countCollectionsWithSubmit(String q, Context context, Community community) throws SQLException, SearchServiceException; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java index 47b66c7933..f273d6434e 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java @@ -163,8 +163,8 @@ public class CollectionRestRepository extends DSpaceObjectRestRepository findAuthorizedByCommunity( + @SearchRestMethod(name = "findSubmitAuthorizedByCommunity") + public Page findSubmitAuthorizedByCommunity( @Parameter(value = "uuid", required = true) UUID communityUuid, Pageable pageable, @Parameter(value = "query") String q) { try { @@ -175,25 +175,25 @@ public class CollectionRestRepository extends DSpaceObjectRestRepository collections = cs.findAuthorizedCollectionsInSOLR(q, context, com, + List collections = cs.findCollectionsWithSubmit(q, context, com, Math.toIntExact(pageable.getOffset()), Math.toIntExact(pageable.getOffset() + pageable.getPageSize())); - int tot = cs.countAuthorizedCollectionsInSOLR(q, context, com); + int tot = cs.countCollectionsWithSubmit(q, context, com); return converter.toRestPage(collections, pageable, tot , utils.obtainProjection()); } catch (SQLException | SearchServiceException e) { throw new RuntimeException(e.getMessage(), e); } } - @SearchRestMethod(name = "findAuthorized") - public Page findAuthorized(@Parameter(value = "query") String q, + @SearchRestMethod(name = "findSubmitAuthorized") + public Page findSubmitAuthorized(@Parameter(value = "query") String q, Pageable pageable) throws SearchServiceException { try { Context context = obtainContext(); - List collections = cs.findAuthorizedCollectionsInSOLR(q, context, null, + List collections = cs.findCollectionsWithSubmit(q, context, null, Math.toIntExact(pageable.getOffset()), Math.toIntExact(pageable.getOffset() + pageable.getPageSize())); - int tot = cs.countAuthorizedCollectionsInSOLR(q, context, null); + int tot = cs.countCollectionsWithSubmit(q, context, null); return converter.toRestPage(collections, pageable, tot, utils.obtainProjection()); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java index dac32f7e44..62dc114c6e 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CollectionRestRepositoryIT.java @@ -472,7 +472,7 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes context.restoreAuthSystemState(); - getClient().perform(get("/api/core/collections/search/findAuthorized")) + getClient().perform(get("/api/core/collections/search/findSubmitAuthorized")) .andExpect(status().isOk()) .andExpect(content().contentType(contentType)) .andExpect(jsonPath("$.page.totalElements", is(0))) @@ -522,7 +522,7 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes String tokenEPerson = getAuthToken(eperson.getEmail(), password); String tokenEPerson2 = getAuthToken(eperson2.getEmail(), password); - getClient(tokenEPerson).perform(get("/api/core/collections/search/findAuthorized")) + getClient(tokenEPerson).perform(get("/api/core/collections/search/findSubmitAuthorized")) .andExpect(status().isOk()) .andExpect(content().contentType(contentType)) .andExpect(jsonPath("$._embedded.collections", Matchers.containsInAnyOrder( @@ -531,7 +531,7 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes ))) .andExpect(jsonPath("$.page.totalElements", is(2))); - getClient(tokenEPerson2).perform(get("/api/core/collections/search/findAuthorized")) + getClient(tokenEPerson2).perform(get("/api/core/collections/search/findSubmitAuthorized")) .andExpect(status().isOk()) .andExpect(content().contentType(contentType)) .andExpect(jsonPath("$._embedded.collections", Matchers.contains( @@ -540,7 +540,7 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes .andExpect(jsonPath("$.page.totalElements", is(1))); String tokenAdmin = getAuthToken(admin.getEmail(), password); - getClient(tokenAdmin).perform(get("/api/core/collections/search/findAuthorized")) + getClient(tokenAdmin).perform(get("/api/core/collections/search/findSubmitAuthorized")) .andExpect(status().isOk()) .andExpect(content().contentType(contentType)) .andExpect(jsonPath("$._embedded.collections", Matchers.containsInAnyOrder( @@ -588,7 +588,7 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes context.restoreAuthSystemState(); String tokenEPerson = getAuthToken(eperson.getEmail(), password); - getClient(tokenEPerson).perform(get("/api/core/collections/search/findAuthorized") + getClient(tokenEPerson).perform(get("/api/core/collections/search/findSubmitAuthorized") .param("query", "collection")) .andExpect(status().isOk()) .andExpect(jsonPath("$._embedded.collections", Matchers.containsInAnyOrder( @@ -597,7 +597,7 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes ))) .andExpect(jsonPath("$.page.totalElements", is(2))); - getClient(tokenEPerson).perform(get("/api/core/collections/search/findAuthorized") + getClient(tokenEPerson).perform(get("/api/core/collections/search/findSubmitAuthorized") .param("query", "COLLECTION")) .andExpect(status().isOk()) .andExpect(jsonPath("$._embedded.collections", Matchers.containsInAnyOrder( @@ -606,18 +606,18 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes ))) .andExpect(jsonPath("$.page.totalElements", is(2))); - getClient(tokenEPerson).perform(get("/api/core/collections/search/findAuthorized") + getClient(tokenEPerson).perform(get("/api/core/collections/search/findSubmitAuthorized") .param("query", "test")) .andExpect(status().isOk()) .andExpect(jsonPath("$.page.totalElements", is(0))); - getClient(tokenEPerson).perform(get("/api/core/collections/search/findAuthorized") + getClient(tokenEPerson).perform(get("/api/core/collections/search/findSubmitAuthorized") .param("query", "auto")) .andExpect(status().isOk()) .andExpect(jsonPath("$.page.totalElements", is(0))); String tokenEPerson2 = getAuthToken(eperson2.getEmail(), password); - getClient(tokenEPerson2).perform(get("/api/core/collections/search/findAuthorized") + getClient(tokenEPerson2).perform(get("/api/core/collections/search/findSubmitAuthorized") .param("query", "auto")) .andExpect(status().isOk()) .andExpect(jsonPath("$._embedded.collections", Matchers.contains( @@ -625,13 +625,13 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes ))) .andExpect(jsonPath("$.page.totalElements", is(1))); - getClient(tokenEPerson2).perform(get("/api/core/collections/search/findAuthorized") + getClient(tokenEPerson2).perform(get("/api/core/collections/search/findSubmitAuthorized") .param("query", "testing auto")) .andExpect(status().isOk()) .andExpect(jsonPath("$.page.totalElements", is(0))); String tokenAdmin = getAuthToken(admin.getEmail(), password); - getClient(tokenAdmin).perform(get("/api/core/collections/search/findAuthorized") + getClient(tokenAdmin).perform(get("/api/core/collections/search/findSubmitAuthorized") .param("query", "sample")) .andExpect(status().isOk()) .andExpect(jsonPath("$._embedded.collections", Matchers.containsInAnyOrder( @@ -640,7 +640,7 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes ))) .andExpect(jsonPath("$.page.totalElements", is(2))); - getClient(tokenAdmin).perform(get("/api/core/collections/search/findAuthorized") + getClient(tokenAdmin).perform(get("/api/core/collections/search/findSubmitAuthorized") .param("query", "items sample")) .andExpect(status().isOk()) .andExpect(jsonPath("$._embedded.collections", Matchers.contains( @@ -648,7 +648,7 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes ))) .andExpect(jsonPath("$.page.totalElements", is(1))); - getClient(tokenAdmin).perform(get("/api/core/collections/search/findAuthorized") + getClient(tokenAdmin).perform(get("/api/core/collections/search/findSubmitAuthorized") .param("query", "test")) .andExpect(status().isOk()) .andExpect(jsonPath("$._embedded.collections", Matchers.containsInAnyOrder( @@ -689,7 +689,7 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes context.restoreAuthSystemState(); String tokenAdminParentCom = getAuthToken(eperson.getEmail(), password); - getClient(tokenAdminParentCom).perform(get("/api/core/collections/search/findAuthorizedByCommunity") + getClient(tokenAdminParentCom).perform(get("/api/core/collections/search/findSubmitAuthorizedByCommunity") .param("uuid", parentCommunity.getID().toString()) .param("query", "sample")) .andExpect(status().isOk()) @@ -700,7 +700,7 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes ))) .andExpect(jsonPath("$.page.totalElements", is(2))); - getClient(tokenAdminParentCom).perform(get("/api/core/collections/search/findAuthorizedByCommunity") + getClient(tokenAdminParentCom).perform(get("/api/core/collections/search/findSubmitAuthorizedByCommunity") .param("uuid", child2.getID().toString()) .param("query", "sample")) .andExpect(status().isOk()) @@ -732,7 +732,7 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes context.restoreAuthSystemState(); - getClient().perform(get("/api/core/collections/search/findAuthorizedByCommunity") + getClient().perform(get("/api/core/collections/search/findSubmitAuthorizedByCommunity") .param("uuid", parentCommunity.getID().toString())) .andExpect(status().isOk()) .andExpect(content().contentType(contentType)) @@ -763,7 +763,7 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes context.restoreAuthSystemState(); String tokenAdminParentCom = getAuthToken(adminParentCom.getEmail(), password); - getClient(tokenAdminParentCom).perform(get("/api/core/collections/search/findAuthorizedByCommunity") + getClient(tokenAdminParentCom).perform(get("/api/core/collections/search/findSubmitAuthorizedByCommunity") .param("uuid", parentCommunity.getID().toString())) .andExpect(status().isOk()) .andExpect(content().contentType(contentType)) @@ -774,7 +774,7 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes ))) .andExpect(jsonPath("$.page.totalElements", is(3))); - getClient(tokenAdminParentCom).perform(get("/api/core/collections/search/findAuthorizedByCommunity") + getClient(tokenAdminParentCom).perform(get("/api/core/collections/search/findSubmitAuthorizedByCommunity") .param("uuid", child1.getID().toString())) .andExpect(status().isOk()) .andExpect(content().contentType(contentType)) @@ -784,7 +784,7 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes .andExpect(jsonPath("$.page.totalElements", is(1))); String tokenAdmin = getAuthToken(admin.getEmail(), password); - getClient(tokenAdmin).perform(get("/api/core/collections/search/findAuthorizedByCommunity") + getClient(tokenAdmin).perform(get("/api/core/collections/search/findSubmitAuthorizedByCommunity") .param("uuid", parentCommunity.getID().toString())) .andExpect(status().isOk()) .andExpect(content().contentType(contentType)) @@ -798,13 +798,13 @@ public class CollectionRestRepositoryIT extends AbstractControllerIntegrationTes @Test public void findAuthorizedByCommunityWithoutUUIDTest() throws Exception { - getClient().perform(get("/api/core/collections/search/findAuthorizedByCommunity")) + getClient().perform(get("/api/core/collections/search/findSubmitAuthorizedByCommunity")) .andExpect(status().isBadRequest()); } @Test public void findAuthorizedByCommunityWithUnexistentUUIDTest() throws Exception { - getClient().perform(get("/api/core/collections/search/findAuthorizedByCommunity") + getClient().perform(get("/api/core/collections/search/findSubmitAuthorizedByCommunity") .param("uuid", UUID.randomUUID().toString())) .andExpect(status().isNotFound()); } From c4df4f2ed74f6614109b98d1247c715943d3a647 Mon Sep 17 00:00:00 2001 From: Marie Verdonck Date: Tue, 16 Jun 2020 16:37:02 +0200 Subject: [PATCH 114/125] 71362: permissions for bitstream metadata READ + tests --- .../repository/BitstreamRestRepository.java | 2 +- ...MetadataReadPermissionEvaluatorPlugin.java | 58 +++- .../app/rest/BitstreamRestRepositoryIT.java | 304 +++++++++++++++++- 3 files changed, 353 insertions(+), 11 deletions(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamRestRepository.java index 5218250eee..2f5bdfe77b 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamRestRepository.java @@ -71,7 +71,7 @@ public class BitstreamRestRepository extends DSpaceObjectRestRepository Date: Thu, 18 Jun 2020 12:49:43 +0200 Subject: [PATCH 115/125] [Task 71441] altered the processFiles endpoint and added the process filetypes endpoint with tests --- .../dspace/scripts/ProcessServiceImpl.java | 18 +++++ .../scripts/service/ProcessService.java | 2 + .../app/rest/model/ProcessFileTypesRest.java | 60 +++++++++++++++ .../rest/model/ProcessFileWrapperRest.java | 52 ------------- .../dspace/app/rest/model/ProcessRest.java | 5 ++ .../hateoas/ProcessFileTypesResource.java | 19 +++++ .../hateoas/ProcessFileWrapperResource.java | 53 ------------- .../ProcessFileTypesLinkRepository.java | 54 +++++++++++++ .../ProcessFilesLinkRepository.java | 33 ++++---- .../app/rest/ProcessRestRepositoryIT.java | 76 ++++++++++++++++++- .../rest/matcher/ProcessFileTypesMatcher.java | 35 +++++++++ 11 files changed, 281 insertions(+), 126 deletions(-) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileTypesRest.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileWrapperRest.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileTypesResource.java delete mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileWrapperResource.java create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFileTypesLinkRepository.java create mode 100644 dspace-server-webapp/src/test/java/org/dspace/app/rest/matcher/ProcessFileTypesMatcher.java diff --git a/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java b/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java index 00f5f66b4c..1cdf3505db 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java @@ -14,7 +14,9 @@ import java.util.ArrayList; import java.util.Collections; import java.util.Comparator; import java.util.Date; +import java.util.HashSet; import java.util.List; +import java.util.Set; import java.util.regex.Pattern; import org.apache.commons.collections4.ListUtils; @@ -23,7 +25,9 @@ import org.apache.logging.log4j.Logger; import org.dspace.authorize.AuthorizeException; import org.dspace.authorize.service.AuthorizeService; import org.dspace.content.Bitstream; +import org.dspace.content.Item; import org.dspace.content.MetadataField; +import org.dspace.content.MetadataValue; import org.dspace.content.ProcessStatus; import org.dspace.content.dao.ProcessDAO; import org.dspace.content.service.BitstreamFormatService; @@ -227,4 +231,18 @@ public class ProcessServiceImpl implements ProcessService { return processDAO.countRows(context); } + @Override + public List getFileTypesForProcessBitstreams(Context context, Process process) { + List list = getBitstreams(context, process); + Set fileTypesSet = new HashSet<>(); + for (Bitstream bitstream : list) { + List metadata = bitstreamService.getMetadata(bitstream, + Process.BITSTREAM_TYPE_METADATAFIELD, Item.ANY); + if (metadata != null && !metadata.isEmpty()) { + fileTypesSet.add(metadata.get(0).getValue()); + } + } + return new ArrayList<>(fileTypesSet); + } + } diff --git a/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java b/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java index 40f59cfcf8..23d5db415d 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java +++ b/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java @@ -181,4 +181,6 @@ public interface ProcessService { */ int countTotal(Context context) throws SQLException; + public List getFileTypesForProcessBitstreams(Context context, Process process); + } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileTypesRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileTypesRest.java new file mode 100644 index 0000000000..69eb5f27da --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileTypesRest.java @@ -0,0 +1,60 @@ +/** + * 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.rest.model; + +import java.util.LinkedList; +import java.util.List; + +import org.dspace.app.rest.RestResourceController; + +public class ProcessFileTypesRest extends BaseObjectRest { + + public static final String NAME = "filetypes"; + public static final String PLURAL_NAME = "filetypes"; + public static final String CATEGORY = RestAddressableModel.SYSTEM; + + private List values; + + /** + * Generic getter for the values + * @return the values value of this ProcessFileTypesRest + */ + public List getValues() { + return values; + } + + /** + * Generic setter for the values + * @param values The values to be set on this ProcessFileTypesRest + */ + public void setValues(List values) { + this.values = values; + } + + public void addValue(String value) { + if (values == null) { + values = new LinkedList<>(); + } + values.add(value); + } + + @Override + public String getCategory() { + return CATEGORY; + } + + @Override + public Class getController() { + return RestResourceController.class; + } + + @Override + public String getType() { + return NAME; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileWrapperRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileWrapperRest.java deleted file mode 100644 index a120ec6208..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileWrapperRest.java +++ /dev/null @@ -1,52 +0,0 @@ -/** - * 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.rest.model; - -import java.util.List; - -import com.fasterxml.jackson.annotation.JsonIgnore; - - -/** - * The ProcessFileWrapper REST Resource - * This class will provide a way to show the processId alongside a list of embedded Bitstreams for that process - * if that Projection should be chosen - * - */ -public class ProcessFileWrapperRest implements RestModel { - private Integer processId; - - @JsonIgnore - private List bitstreams; - - public Integer getProcessId() { - return processId; - } - - public void setProcessId(Integer processId) { - this.processId = processId; - } - - public void setBitstreams(List bistreams) { - this.bitstreams = bistreams; - } - - public List getBitstreams() { - return bitstreams; - } - - @Override - public String getType() { - return "processfilewrapper"; - } - - @Override - public String getTypePlural() { - return "processfilewrappers"; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessRest.java index a5206c72b2..399d880f3b 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessRest.java @@ -25,6 +25,10 @@ import org.dspace.scripts.Process; name = ProcessRest.FILES, method = "getFilesFromProcess" ), + @LinkRest( + name = ProcessRest.FILE_TYPES, + method = "getFileTypesFromProcess" + ) }) public class ProcessRest extends BaseObjectRest { public static final String NAME = "process"; @@ -32,6 +36,7 @@ public class ProcessRest extends BaseObjectRest { public static final String CATEGORY = RestAddressableModel.SYSTEM; public static final String FILES = "files"; + public static final String FILE_TYPES = "filetypes"; public String getCategory() { return CATEGORY; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileTypesResource.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileTypesResource.java new file mode 100644 index 0000000000..d6e6f460b1 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileTypesResource.java @@ -0,0 +1,19 @@ +/** + * 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.rest.model.hateoas; + +import org.dspace.app.rest.model.ProcessFileTypesRest; +import org.dspace.app.rest.model.hateoas.annotations.RelNameDSpaceResource; + +@RelNameDSpaceResource(ProcessFileTypesRest.NAME) +public class ProcessFileTypesResource extends HALResource { + + public ProcessFileTypesResource(ProcessFileTypesRest content) { + super(content); + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileWrapperResource.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileWrapperResource.java deleted file mode 100644 index 8429dc4aef..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileWrapperResource.java +++ /dev/null @@ -1,53 +0,0 @@ -/** - * 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.rest.model.hateoas; - -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import org.dspace.app.rest.model.BitstreamRest; -import org.dspace.app.rest.model.MetadataValueRest; -import org.dspace.app.rest.model.ProcessFileWrapperRest; -import org.dspace.app.rest.utils.Utils; -import org.dspace.scripts.Process; - -/** - * This is the Resource object for the {@link ProcessFileWrapperRest} - * It'll create a Resource object to return and include the associated bitstreams in an embed that's properly - * made for the type of file that that particular bitstream is - */ -public class ProcessFileWrapperResource extends HALResource { - - /** - * Constructor for this object. Calls on super and creates separate embedded lists - * @param content The {@link ProcessFileWrapperRest} object associated with this resource - * @param utils Utils class - */ - public ProcessFileWrapperResource(ProcessFileWrapperRest content, Utils utils) { - super(content); - - if (content != null) { - HashMap> bitstreamResourceMap = new HashMap<>(); - for (BitstreamRest bitstreamRest : content.getBitstreams()) { - List fileType = bitstreamRest.getMetadata().getMap() - .get(Process.BITSTREAM_TYPE_METADATAFIELD); - if (fileType != null && !fileType.isEmpty()) { - bitstreamResourceMap - .computeIfAbsent(fileType.get(0).getValue(), k -> new ArrayList<>()) - .add(new BitstreamResource(bitstreamRest, utils)); - } - } - - for (Map.Entry> entry : bitstreamResourceMap.entrySet()) { - embedResource(entry.getKey(), entry.getValue()); - } - } - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFileTypesLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFileTypesLinkRepository.java new file mode 100644 index 0000000000..66a44f5473 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFileTypesLinkRepository.java @@ -0,0 +1,54 @@ +/** + * 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.rest.repository; + +import java.sql.SQLException; +import java.util.List; +import javax.annotation.Nullable; +import javax.servlet.http.HttpServletRequest; + +import org.dspace.app.rest.model.ProcessFileTypesRest; +import org.dspace.app.rest.model.ProcessRest; +import org.dspace.app.rest.projection.Projection; +import org.dspace.authorize.AuthorizeException; +import org.dspace.core.Context; +import org.dspace.scripts.Process; +import org.dspace.scripts.service.ProcessService; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.data.domain.Pageable; +import org.springframework.data.rest.webmvc.ResourceNotFoundException; +import org.springframework.security.access.prepost.PreAuthorize; +import org.springframework.stereotype.Component; + +@Component(ProcessRest.CATEGORY + "." + ProcessRest.NAME + "." + ProcessRest.FILE_TYPES) +public class ProcessFileTypesLinkRepository extends AbstractDSpaceRestRepository implements LinkRestRepository { + + @Autowired + private ProcessService processService; + + @Autowired + private ProcessRestRepository processRestRepository; + + @PreAuthorize("hasAuthority('ADMIN')") + public ProcessFileTypesRest getFileTypesFromProcess(@Nullable HttpServletRequest request, + Integer processId, + @Nullable Pageable optionalPageable, + Projection projection) throws SQLException, AuthorizeException { + + Context context = obtainContext(); + Process process = processService.find(context, processId); + if (process == null) { + throw new ResourceNotFoundException("Process with id " + processId + " was not found"); + } + List fileTypes = processService.getFileTypesForProcessBitstreams(context, process); + ProcessFileTypesRest processFileTypesRest = new ProcessFileTypesRest(); + processFileTypesRest.setId("filetypes-" + processId); + processFileTypesRest.setValues(fileTypes); + return processFileTypesRest; + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java index fc6be33a14..42fcef0d62 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFilesLinkRepository.java @@ -8,24 +8,25 @@ package org.dspace.app.rest.repository; import java.sql.SQLException; +import java.util.List; import javax.annotation.Nullable; import javax.servlet.http.HttpServletRequest; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; import org.dspace.app.rest.model.BitstreamRest; -import org.dspace.app.rest.model.ProcessFileWrapperRest; import org.dspace.app.rest.model.ProcessRest; import org.dspace.app.rest.projection.Projection; import org.dspace.authorize.AuthorizeException; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Component; /** - * This is the {@link LinkRestRepository} implementation that takes care of retrieving the - * {@link ProcessFileWrapperRest} for the Process endpoints + * This is the {@link LinkRestRepository} implementation that takes care of retrieving the list of + * {@link org.dspace.content.Bitstream} objects for the Process endpoints * */ @Component(ProcessRest.CATEGORY + "." + ProcessRest.NAME + "." + ProcessRest.FILES) @@ -37,28 +38,24 @@ public class ProcessFilesLinkRepository extends AbstractDSpaceRestRepository imp private ProcessRestRepository processRestRepository; /** - * This method will retrieve all the files from the process and wrap them into a {@link ProcessFileWrapperRest} - * object to return + * This method will retrieve all the files from the process * @param request The current request * @param processId The processId for the Process to use * @param optionalPageable Pageable if applicable * @param projection Projection if applicable - * @return A {@link ProcessFileWrapperRest} object filled with the bitstreams from the process + * @return A list of {@link BitstreamRest} objects filled * @throws SQLException If something goes wrong * @throws AuthorizeException If something goes wrong */ @PreAuthorize("hasAuthority('ADMIN')") - public ProcessFileWrapperRest getFilesFromProcess(@Nullable HttpServletRequest request, - Integer processId, - @Nullable Pageable optionalPageable, - Projection projection) throws SQLException, AuthorizeException { + public Page getFilesFromProcess(@Nullable HttpServletRequest request, + Integer processId, + @Nullable Pageable optionalPageable, + Projection projection) throws SQLException, AuthorizeException { - - ProcessFileWrapperRest processFileWrapperRest = new ProcessFileWrapperRest(); - processFileWrapperRest.setBitstreams(processRestRepository.getProcessBitstreams(processId)); - processFileWrapperRest.setProcessId(processId); - - return processFileWrapperRest; + List list = processRestRepository.getProcessBitstreams(processId); + Pageable pageable = utils.getPageable(optionalPageable); + return utils.getPage(list, pageable); } /** @@ -68,13 +65,13 @@ public class ProcessFilesLinkRepository extends AbstractDSpaceRestRepository imp * @param fileType The filetype that the bitstream has to be * @param pageable Pageable if applicable * @param projection The current projection - * @return The BitstreamRest object that corresponds with the Process and type + * @return The BitstreamRest object that corresponds with the Process and type * @throws SQLException If something goes wrong * @throws AuthorizeException If something goes wrong */ @PreAuthorize("hasPermission(#processId, 'PROCESS', 'READ')") public BitstreamRest getResource(HttpServletRequest request, String processId, String fileType, - Pageable pageable, Projection projection) + Pageable pageable, Projection projection) throws SQLException, AuthorizeException { if (log.isTraceEnabled()) { log.trace("Retrieving Files with type " + fileType + " from Process with ID: " + processId); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ProcessRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ProcessRestRepositoryIT.java index 978f4e498f..fe9e10197a 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ProcessRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ProcessRestRepositoryIT.java @@ -16,11 +16,14 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers. import java.io.InputStream; import java.sql.SQLException; import java.util.LinkedList; +import java.util.List; +import java.util.Random; import org.apache.commons.codec.CharEncoding; import org.apache.commons.io.IOUtils; import org.dspace.app.rest.builder.ProcessBuilder; import org.dspace.app.rest.matcher.PageMatcher; +import org.dspace.app.rest.matcher.ProcessFileTypesMatcher; import org.dspace.app.rest.matcher.ProcessMatcher; import org.dspace.app.rest.test.AbstractControllerIntegrationTest; import org.dspace.content.Bitstream; @@ -217,9 +220,9 @@ public class ProcessRestRepositoryIT extends AbstractControllerIntegrationTest { getClient(token).perform(get("/api/system/processes/" + process.getID() + "/files")) .andExpect(status().isOk()) - .andExpect(jsonPath("$._embedded.inputfile[0].name", is("test.csv"))) - .andExpect(jsonPath("$._embedded.inputfile[0].uuid", is(bitstream.getID().toString()))) - .andExpect(jsonPath("$._embedded.inputfile[0].metadata['dspace.process.filetype']" + + .andExpect(jsonPath("$._embedded.files[0].name", is("test.csv"))) + .andExpect(jsonPath("$._embedded.files[0].uuid", is(bitstream.getID().toString()))) + .andExpect(jsonPath("$._embedded.files[0].metadata['dspace.process.filetype']" + "[0].value", is("inputfile"))); } @@ -244,6 +247,73 @@ public class ProcessRestRepositoryIT extends AbstractControllerIntegrationTest { } + @Test + public void getProcessFilesTypes() throws Exception { + try (InputStream is = IOUtils.toInputStream("Test File For Process", CharEncoding.UTF_8)) { + processService.appendFile(context, process, is, "inputfile", "test.csv"); + } + + List fileTypesToCheck = new LinkedList<>(); + fileTypesToCheck.add("inputfile"); + + String token = getAuthToken(admin.getEmail(), password); + + getClient(token).perform(get("/api/system/processes/" + process.getID() + "/filetypes")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$", ProcessFileTypesMatcher + .matchProcessFileTypes("filetypes-" + process.getID(), fileTypesToCheck))); + + + } + + @Test + public void getProcessFilesTypesForbidden() throws Exception { + try (InputStream is = IOUtils.toInputStream("Test File For Process", CharEncoding.UTF_8)) { + processService.appendFile(context, process, is, "inputfile", "test.csv"); + } + + List fileTypesToCheck = new LinkedList<>(); + fileTypesToCheck.add("inputfile"); + + String token = getAuthToken(eperson.getEmail(), password); + + getClient(token).perform(get("/api/system/processes/" + process.getID() + "/filetypes")) + .andExpect(status().isForbidden()); + + + } + + @Test + public void getProcessFilesTypesUnAuthorized() throws Exception { + try (InputStream is = IOUtils.toInputStream("Test File For Process", CharEncoding.UTF_8)) { + processService.appendFile(context, process, is, "inputfile", "test.csv"); + } + + List fileTypesToCheck = new LinkedList<>(); + fileTypesToCheck.add("inputfile"); + + getClient().perform(get("/api/system/processes/" + process.getID() + "/filetypes")) + .andExpect(status().isUnauthorized()); + + } + + @Test + public void getProcessFilesTypesRandomProcessId() throws Exception { + try (InputStream is = IOUtils.toInputStream("Test File For Process", CharEncoding.UTF_8)) { + processService.appendFile(context, process, is, "inputfile", "test.csv"); + } + + List fileTypesToCheck = new LinkedList<>(); + fileTypesToCheck.add("inputfile"); + + String token = getAuthToken(admin.getEmail(), password); + + getClient(token).perform(get("/api/system/processes/" + new Random() + "/filetypes")) + .andExpect(status().isNotFound()); + + + } + @After public void destroy() throws Exception { super.destroy(); diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/matcher/ProcessFileTypesMatcher.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/matcher/ProcessFileTypesMatcher.java new file mode 100644 index 0000000000..cc34a0479f --- /dev/null +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/matcher/ProcessFileTypesMatcher.java @@ -0,0 +1,35 @@ +/** + * 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.rest.matcher; + +import static com.jayway.jsonpath.matchers.JsonPathMatchers.hasJsonPath; +import static org.hamcrest.Matchers.allOf; +import static org.hamcrest.Matchers.is; + +import java.util.List; +import java.util.stream.Collectors; + +import org.hamcrest.Matcher; +import org.hamcrest.Matchers; + +public class ProcessFileTypesMatcher { + + private ProcessFileTypesMatcher() { + } + + public static Matcher matchProcessFileTypes(String id, List filetypes) { + return allOf( + hasJsonPath("$.id", is(id)), + hasJsonPath("$.values", Matchers.containsInAnyOrder( + filetypes.stream().map(Matchers::containsString) + .collect(Collectors.toList()) + )) + ); + + } +} From 57d63c211eb53dd9c28fad1597c54b92516b3d63 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Thu, 18 Jun 2020 12:58:23 +0200 Subject: [PATCH 116/125] [Task 71441] added javadoc and minor cleanup --- .../scripts/service/ProcessService.java | 6 ++++++ .../app/rest/model/ProcessFileTypesRest.java | 8 ++++++++ .../hateoas/ProcessFileTypesResource.java | 3 +++ .../ProcessFileTypesLinkRepository.java | 19 ++++++++++++++++--- 4 files changed, 33 insertions(+), 3 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java b/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java index 23d5db415d..80a6ec932b 100644 --- a/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java +++ b/dspace-api/src/main/java/org/dspace/scripts/service/ProcessService.java @@ -181,6 +181,12 @@ public interface ProcessService { */ int countTotal(Context context) throws SQLException; + /** + * This will return a list of Strings where each String represents the type of a Bitstream in the Process given + * @param context The DSpace context + * @param process The Process object that we'll use to find the bitstreams + * @return A list of Strings where each String represents a fileType that is in the Process + */ public List getFileTypesForProcessBitstreams(Context context, Process process); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileTypesRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileTypesRest.java index 69eb5f27da..ecceea107e 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileTypesRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ProcessFileTypesRest.java @@ -12,6 +12,10 @@ import java.util.List; import org.dspace.app.rest.RestResourceController; +/** + * This class provides a way to list the filetypes present in a given Process by showing them as a list of Strings + * It'll be used by {@link org.dspace.app.rest.repository.ProcessFileTypesLinkRepository} + */ public class ProcessFileTypesRest extends BaseObjectRest { public static final String NAME = "filetypes"; @@ -36,6 +40,10 @@ public class ProcessFileTypesRest extends BaseObjectRest { this.values = values; } + /** + * Adds a value to the list of FileType Strings + * @param value The value to be added + */ public void addValue(String value) { if (values == null) { values = new LinkedList<>(); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileTypesResource.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileTypesResource.java index d6e6f460b1..75c26b95f5 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileTypesResource.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/ProcessFileTypesResource.java @@ -10,6 +10,9 @@ package org.dspace.app.rest.model.hateoas; import org.dspace.app.rest.model.ProcessFileTypesRest; import org.dspace.app.rest.model.hateoas.annotations.RelNameDSpaceResource; +/** + * Resource object for {@link ProcessFileTypesRest} + */ @RelNameDSpaceResource(ProcessFileTypesRest.NAME) public class ProcessFileTypesResource extends HALResource { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFileTypesLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFileTypesLinkRepository.java index 66a44f5473..8eb8d7ef65 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFileTypesLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessFileTypesLinkRepository.java @@ -25,15 +25,28 @@ import org.springframework.data.rest.webmvc.ResourceNotFoundException; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Component; +/** + * This LinkRepository will deal with calls to the /filetypes endpoint of a given Process. + * It'll retrieve all the bitstreams for the given Process and return a {@link ProcessFileTypesRest} object that holds + * a list of Strings where each String represents a unique fileType of the Bitstreams for that Process + */ @Component(ProcessRest.CATEGORY + "." + ProcessRest.NAME + "." + ProcessRest.FILE_TYPES) public class ProcessFileTypesLinkRepository extends AbstractDSpaceRestRepository implements LinkRestRepository { @Autowired private ProcessService processService; - @Autowired - private ProcessRestRepository processRestRepository; - + /** + * This will be the admin only endpoint that returns the {@link ProcessFileTypesRest} constructed with the values + * found in the Bitstreams of the Process with the given ProcessId + * @param request The relevant request + * @param processId The processId of the Process to be used + * @param optionalPageable Paging if applicable + * @param projection The current projection + * @return The {@link ProcessFileTypesRest} created from the Bitstreams of the given Process + * @throws SQLException If something goes wrong + * @throws AuthorizeException If something goes wrong + */ @PreAuthorize("hasAuthority('ADMIN')") public ProcessFileTypesRest getFileTypesFromProcess(@Nullable HttpServletRequest request, Integer processId, From 8172dd5fb0688ef2539af96b5a470b6187a4f937 Mon Sep 17 00:00:00 2001 From: benbosman Date: Thu, 18 Jun 2020 17:05:31 +0200 Subject: [PATCH 117/125] Re-enable findByObjectAndFeatureTest The findByObjectAndFeatureTest can be used again thanks to https://github.com/DSpace/DSpace/pull/2778/files#diff-311a7e07c257d9c869f4de1347f5f761R51 --- .../org/dspace/app/rest/AuthorizationRestRepositoryIT.java | 5 ----- 1 file changed, 5 deletions(-) diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationRestRepositoryIT.java index 22188a36af..7092bb62d7 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationRestRepositoryIT.java @@ -805,11 +805,6 @@ public class AuthorizationRestRepositoryIT extends AbstractControllerIntegration * * @throws Exception */ - // This test currently doesn't work as expected since the AuthorizationFeatureRestRepository#findOne method - // is only exposed to admins. Currently we're performing checks on the individual REST objects with its findOne - // Permission constraints, which is ADMIN in this case. Seeing as we're trying to retrieve it with a normal - // EPerson token in the second test, this will fail. - @Ignore public void findByObjectAndFeatureTest() throws Exception { context.turnOffAuthorisationSystem(); Community com = CommunityBuilder.createCommunity(context).withName("A test community").build(); From 559001cf431a987ee03563c392003195f141baf8 Mon Sep 17 00:00:00 2001 From: benbosman Date: Thu, 18 Jun 2020 17:16:56 +0200 Subject: [PATCH 118/125] Removing unused import --- .../java/org/dspace/app/rest/AuthorizationRestRepositoryIT.java | 1 - 1 file changed, 1 deletion(-) diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationRestRepositoryIT.java index 7092bb62d7..05631790e3 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/AuthorizationRestRepositoryIT.java @@ -52,7 +52,6 @@ import org.dspace.eperson.Group; import org.dspace.services.ConfigurationService; import org.hamcrest.Matchers; import org.junit.Before; -import org.junit.Ignore; import org.junit.Test; import org.springframework.beans.factory.annotation.Autowired; From 08abaf8b039a5c9a152ae296b1e1961a2af6d983 Mon Sep 17 00:00:00 2001 From: Yana De Pauw Date: Fri, 19 Jun 2020 14:05:14 +0200 Subject: [PATCH 119/125] 71440: Implement feedback --- ... => SubmissionCCLicenseUrlRepository.java} | 53 +++++++++++++------ ...ionCCLicenseUrlResourceHalLinkFactory.java | 22 +++++--- .../model/SubmissionCCLicenseUrlRest.java | 9 ++-- .../impl/CCLicenseRemovePatchOperation.java | 11 +++- .../rest/CCLicenseRemovePatchOperationIT.java | 3 +- ...> SubmissionCCLicenseUrlRepositoryIT.java} | 22 ++++---- 6 files changed, 79 insertions(+), 41 deletions(-) rename dspace-server-webapp/src/main/java/org/dspace/app/rest/{SubmissionCCLicenseSearchController.java => SubmissionCCLicenseUrlRepository.java} (65%) rename dspace-server-webapp/src/test/java/org/dspace/app/rest/{SubmissionCCLicenseSearchControllerIT.java => SubmissionCCLicenseUrlRepositoryIT.java} (77%) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java similarity index 65% rename from dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java rename to dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java index 76ed1021d3..ff76183506 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseSearchController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java @@ -14,28 +14,28 @@ import javax.servlet.ServletRequest; import org.apache.commons.lang3.StringUtils; import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.exception.DSpaceBadRequestException; -import org.dspace.app.rest.model.SubmissionCCLicenseRest; +import org.dspace.app.rest.exception.RepositoryMethodNotImplementedException; import org.dspace.app.rest.model.SubmissionCCLicenseUrlRest; -import org.dspace.app.rest.model.hateoas.SubmissionCCLicenseUrlResource; +import org.dspace.app.rest.repository.DSpaceRestRepository; import org.dspace.app.rest.utils.Utils; +import org.dspace.core.Context; import org.dspace.license.service.CreativeCommonsService; import org.dspace.services.RequestService; import org.dspace.utils.DSpace; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; import org.springframework.data.rest.webmvc.ResourceNotFoundException; import org.springframework.security.access.prepost.PreAuthorize; -import org.springframework.web.bind.annotation.RequestMapping; -import org.springframework.web.bind.annotation.RequestMethod; -import org.springframework.web.bind.annotation.RestController; +import org.springframework.stereotype.Component; /** - * This controller is responsible for searching the CC License URI + * This Repository is responsible for handling the CC License URIs. + * It only supports a search method */ -@RestController -@RequestMapping("/api/" + SubmissionCCLicenseRest.CATEGORY + "/" + SubmissionCCLicenseRest.PLURAL + "/search" + - "/rightsByQuestions") -@PreAuthorize("hasAuthority('AUTHENTICATED')") -public class SubmissionCCLicenseSearchController { + +@Component(SubmissionCCLicenseUrlRest.CATEGORY + "." + SubmissionCCLicenseUrlRest.NAME) +public class SubmissionCCLicenseUrlRepository extends DSpaceRestRepository { @Autowired protected Utils utils; @@ -52,10 +52,11 @@ public class SubmissionCCLicenseSearchController { * Retrieves the CC License URI based on the license ID and answers in the field questions, provided as parameters * to this request * - * @return the CC License URI as a SubmissionCCLicenseUrlResource + * @return the CC License URI as a SubmissionCCLicenseUrlRest */ - @RequestMapping(method = RequestMethod.GET) - public SubmissionCCLicenseUrlResource findByRightsByQuestions() { + @PreAuthorize("hasAuthority('AUTHENTICATED')") + @SearchRestMethod(name = "rightsByQuestions") + public SubmissionCCLicenseUrlRest findByRightsByQuestions() { ServletRequest servletRequest = requestService.getCurrentRequest() .getServletRequest(); Map requestParameterMap = servletRequest @@ -66,6 +67,9 @@ public class SubmissionCCLicenseSearchController { throw new DSpaceBadRequestException( "A \"license\" parameter needs to be provided."); } + + // Loop through parameters to find answer parameters, adding them to the parameterMap. Zero or more answers + // may exist, as some CC licenses do not require answers for (String parameter : requestParameterMap.keySet()) { if (StringUtils.startsWith(parameter, "answer_")) { String field = StringUtils.substringAfter(parameter, "answer_"); @@ -93,8 +97,25 @@ public class SubmissionCCLicenseSearchController { throw new ResourceNotFoundException("No CC License URI could be found for ID: " + licenseId); } - SubmissionCCLicenseUrlRest submissionCCLicenseUrlRest = converter.toRest(licenseUri, utils.obtainProjection()); - return converter.toResource(submissionCCLicenseUrlRest); + return converter.toRest(licenseUri, utils.obtainProjection()); } + + /** + * The findOne method is not supported in this repository + */ + public SubmissionCCLicenseUrlRest findOne(final Context context, final String s) { + throw new RepositoryMethodNotImplementedException(SubmissionCCLicenseUrlRest.NAME, "findOne"); + } + + /** + * The findAll method is not supported in this repository + */ + public Page findAll(final Context context, final Pageable pageable) { + throw new RepositoryMethodNotImplementedException(SubmissionCCLicenseUrlRest.NAME, "findAll"); + } + + public Class getDomainClass() { + return SubmissionCCLicenseUrlRest.class; + } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/SubmissionCCLicenseUrlResourceHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/SubmissionCCLicenseUrlResourceHalLinkFactory.java index cb44d68e73..07d5e46c61 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/SubmissionCCLicenseUrlResourceHalLinkFactory.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/process/SubmissionCCLicenseUrlResourceHalLinkFactory.java @@ -10,14 +10,16 @@ package org.dspace.app.rest.link.process; import java.util.LinkedList; import java.util.Map; -import org.dspace.app.rest.SubmissionCCLicenseSearchController; +import org.dspace.app.rest.RestResourceController; import org.dspace.app.rest.link.HalLinkFactory; +import org.dspace.app.rest.model.SubmissionCCLicenseUrlRest; import org.dspace.app.rest.model.hateoas.SubmissionCCLicenseUrlResource; import org.dspace.services.RequestService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.domain.Pageable; import org.springframework.hateoas.Link; import org.springframework.stereotype.Component; +import org.springframework.util.LinkedMultiValueMap; import org.springframework.web.util.UriComponentsBuilder; /** @@ -25,16 +27,17 @@ import org.springframework.web.util.UriComponentsBuilder; */ @Component public class SubmissionCCLicenseUrlResourceHalLinkFactory - extends HalLinkFactory { + extends HalLinkFactory { @Autowired RequestService requestService; /** * Add a self link based on the search parameters - * @param halResource - The halResource - * @param pageable - The page information - * @param list - The list of present links + * + * @param halResource - The halResource + * @param pageable - The page information + * @param list - The list of present links * @throws Exception */ @Override @@ -46,7 +49,10 @@ public class SubmissionCCLicenseUrlResourceHalLinkFactory Map parameterMap = requestService.getCurrentRequest().getHttpServletRequest() .getParameterMap(); - UriComponentsBuilder uriComponentsBuilder = uriBuilder(getMethodOn().findByRightsByQuestions()); + + UriComponentsBuilder uriComponentsBuilder = uriBuilder(getMethodOn().executeSearchMethods( + SubmissionCCLicenseUrlRest.CATEGORY, SubmissionCCLicenseUrlRest.PLURAL, "rightsByQuestions", null, null, + null, null, new LinkedMultiValueMap<>())); for (String key : parameterMap.keySet()) { uriComponentsBuilder.queryParam(key, parameterMap.get(key)); } @@ -56,8 +62,8 @@ public class SubmissionCCLicenseUrlResourceHalLinkFactory @Override - protected Class getControllerClass() { - return SubmissionCCLicenseSearchController.class; + protected Class getControllerClass() { + return RestResourceController.class; } @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseUrlRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseUrlRest.java index 46aa9bc705..77263ba317 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseUrlRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/SubmissionCCLicenseUrlRest.java @@ -9,7 +9,7 @@ package org.dspace.app.rest.model; import com.fasterxml.jackson.annotation.JsonIgnore; import com.fasterxml.jackson.annotation.JsonProperty; -import org.dspace.app.rest.SubmissionCCLicenseSearchController; +import org.dspace.app.rest.RestResourceController; /** * This class is the REST representation of the CCLicense URL String object and acts as a data object @@ -17,6 +17,9 @@ import org.dspace.app.rest.SubmissionCCLicenseSearchController; */ public class SubmissionCCLicenseUrlRest extends BaseObjectRest { public static final String NAME = "submissioncclicenseUrl"; + public static final String PLURAL = "submissioncclicenseUrls"; + public static final String CATEGORY = RestAddressableModel.CONFIGURATION; + private String url; @@ -46,12 +49,12 @@ public class SubmissionCCLicenseUrlRest extends BaseObjectRest { @Override public String getCategory() { - return SubmissionCCLicenseRest.CATEGORY; + return SubmissionCCLicenseUrlRest.CATEGORY; } @Override @JsonIgnore public Class getController() { - return SubmissionCCLicenseSearchController.class; + return RestResourceController.class; } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/factory/impl/CCLicenseRemovePatchOperation.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/factory/impl/CCLicenseRemovePatchOperation.java index 19229a4f72..add819b7a4 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/factory/impl/CCLicenseRemovePatchOperation.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/factory/impl/CCLicenseRemovePatchOperation.java @@ -7,6 +7,7 @@ */ package org.dspace.app.rest.submit.factory.impl; +import org.apache.commons.lang3.StringUtils; import org.dspace.content.InProgressSubmission; import org.dspace.content.Item; import org.dspace.core.Context; @@ -44,7 +45,15 @@ public class CCLicenseRemovePatchOperation extends RemovePatchOperation void remove(Context context, Request currentRequest, InProgressSubmission source, String path, Object value) throws Exception { Item item = source.getItem(); - creativeCommonsService.removeLicense(context, item); + + + if (StringUtils.isNotBlank(creativeCommonsService.getLicenseName(item))) { + creativeCommonsService.removeLicense(context, item); + } else { + throw new IllegalArgumentException("No CC license can be removed since none is present on submission: " + + source.getID()); + } + } } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java index 40828a7667..3b05621f08 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java @@ -130,7 +130,6 @@ public class CCLicenseRemovePatchOperationIT extends AbstractControllerIntegrati getClient(epersonToken).perform(patch("/api/submission/workspaceitems/" + workspaceItem.getID()) .content(removePatch) .contentType(MediaType.APPLICATION_JSON_PATCH_JSON)) - .andExpect(status().isOk()) - .andExpect(jsonPath("$.sections", not(hasJsonPath("cclicense")))); + .andExpect(status().isInternalServerError()); } } diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepositoryIT.java similarity index 77% rename from dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java rename to dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepositoryIT.java index 8a93e18a8e..84fe06ce19 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseSearchControllerIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepositoryIT.java @@ -17,14 +17,14 @@ import org.dspace.app.rest.test.AbstractControllerIntegrationTest; import org.junit.Test; /** - * Class to the methods from the SubmissionCCLicenseSearchController + * Class to the methods from the SubmissionCCLicenseUrlRepository * Since the CC Licenses and the corresponding URIs are obtained from the CC License API, a mock service has been * implemented. * This mock service will return a fixed set of CC Licenses using a similar structure to the ones obtained from the * CC License API. * Refer to {@link org.dspace.license.MockCCLicenseConnectorServiceImpl} for more information */ -public class SubmissionCCLicenseSearchControllerIT extends AbstractControllerIntegrationTest { +public class SubmissionCCLicenseUrlRepositoryIT extends AbstractControllerIntegrationTest { @Test @@ -32,28 +32,28 @@ public class SubmissionCCLicenseSearchControllerIT extends AbstractControllerInt String epersonToken = getAuthToken(eperson.getEmail(), password); getClient(epersonToken).perform(get( - "/api/config/submissioncclicenses/search/rightsByQuestions?license=license2&answer_license2-field0" + + "/api/config/submissioncclicenseUrls/search/rightsByQuestions?license=license2&answer_license2-field0" + "=license2-field0-enum1")) .andExpect(status().isOk()) .andExpect(jsonPath("$.url", is("mock-license-uri"))) .andExpect(jsonPath("$.type", is("submissioncclicenseUrl"))) .andExpect(jsonPath("$._links.self.href", - is("http://localhost/api/config/submissioncclicenses/search/rightsByQuestions" + + is("http://localhost/api/config/submissioncclicenseUrls/search/rightsByQuestions" + "?license=license2" + "&answer_license2-field0=license2-field0-enum1"))); } @Test - public void searchRightsByQuestionsTestLicenseWithoutFields() throws Exception { + public void searchRightsByQuestionsTestLicenseForLicenseWithoutQuestions() throws Exception { String epersonToken = getAuthToken(eperson.getEmail(), password); getClient(epersonToken) - .perform(get("/api/config/submissioncclicenses/search/rightsByQuestions?license=license3")) + .perform(get("/api/config/submissioncclicenseUrls/search/rightsByQuestions?license=license3")) .andExpect(status().isOk()) .andExpect(jsonPath("$.url", is("mock-license-uri"))) .andExpect(jsonPath("$.type", is("submissioncclicenseUrl"))) .andExpect(jsonPath("$._links.self.href", - is("http://localhost/api/config/submissioncclicenses/search/rightsByQuestions" + + is("http://localhost/api/config/submissioncclicenseUrls/search/rightsByQuestions" + "?license=license3"))); } @@ -62,7 +62,7 @@ public class SubmissionCCLicenseSearchControllerIT extends AbstractControllerInt String epersonToken = getAuthToken(eperson.getEmail(), password); getClient(epersonToken).perform(get( - "/api/config/submissioncclicenses/search/rightsByQuestions?license=nonexisting-license" + + "/api/config/submissioncclicenseUrls/search/rightsByQuestions?license=nonexisting-license" + "&answer_license2-field0=license2-field0-enum1")) .andExpect(status().isNotFound()); } @@ -72,7 +72,7 @@ public class SubmissionCCLicenseSearchControllerIT extends AbstractControllerInt String epersonToken = getAuthToken(eperson.getEmail(), password); getClient(epersonToken).perform(get( - "/api/config/submissioncclicenses/search/rightsByQuestions?license=license1&answer_license1field0" + + "/api/config/submissioncclicenseUrls/search/rightsByQuestions?license=license1&answer_license1field0" + "=license1field0enum1")) .andExpect(status().isBadRequest()); } @@ -82,7 +82,7 @@ public class SubmissionCCLicenseSearchControllerIT extends AbstractControllerInt String epersonToken = getAuthToken(eperson.getEmail(), password); getClient(epersonToken).perform(get( - "/api/config/submissioncclicenses/search/rightsByQuestions?license=license2" + + "/api/config/submissioncclicenseUrls/search/rightsByQuestions?license=license2" + "&answer_license2field0=license2field0enum1&answer_nonexisting=test")) .andExpect(status().isBadRequest()); } @@ -91,7 +91,7 @@ public class SubmissionCCLicenseSearchControllerIT extends AbstractControllerInt public void searchRightsByQuestionsAdditionalUnAuthorized() throws Exception { getClient().perform(get( - "/api/config/submissioncclicenses/search/rightsByQuestions?license=license2&answer_license2-field0" + + "/api/config/submissioncclicenseUrls/search/rightsByQuestions?license=license2&answer_license2-field0" + "=license2-field0-enum1")) .andExpect(status().isUnauthorized()); From 52ee4ec4fbfa3eb31db6c8c2abd7194f52f68dd2 Mon Sep 17 00:00:00 2001 From: Tim Donohue Date: Mon, 22 Jun 2020 13:07:21 -0500 Subject: [PATCH 120/125] Missing import in IT --- .../test/java/org/dspace/app/rest/ProcessRestRepositoryIT.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ProcessRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ProcessRestRepositoryIT.java index 0ed3de06e0..fdca31d07b 100644 --- a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ProcessRestRepositoryIT.java +++ b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ProcessRestRepositoryIT.java @@ -20,6 +20,7 @@ import java.util.List; import java.util.Random; import org.apache.commons.codec.CharEncoding; +import org.apache.commons.collections4.CollectionUtils; import org.apache.commons.io.IOUtils; import org.dspace.app.rest.builder.ProcessBuilder; import org.dspace.app.rest.matcher.PageMatcher; @@ -52,7 +53,7 @@ public class ProcessRestRepositoryIT extends AbstractControllerIntegrationTest { CollectionUtils.emptyIfNull(processService.findAll(context)).stream().forEach(process -> { try { processService.delete(context, process); - } catch (SQLException e) { + } catch (Exception e) { throw new RuntimeException(e); } }); From 95110d2b5a202aadba7395e2f598be7bbceb82db Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Tue, 23 Jun 2020 14:23:50 +0200 Subject: [PATCH 121/125] [Task 71440] changed the ModelObject for SubmissionCCLicenseUrlRest from String to SubmissionCCLicenseUrl --- .../SubmissionCCLicenseUrlRepository.java | 4 +- .../SubmissionCCLicenseUrlConverter.java | 15 +++--- .../model/wrapper/SubmissionCCLicenseUrl.java | 51 +++++++++++++++++++ 3 files changed, 62 insertions(+), 8 deletions(-) create mode 100644 dspace-server-webapp/src/main/java/org/dspace/app/rest/model/wrapper/SubmissionCCLicenseUrl.java diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java index ff76183506..62cd48d56e 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java @@ -16,6 +16,7 @@ import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.exception.DSpaceBadRequestException; import org.dspace.app.rest.exception.RepositoryMethodNotImplementedException; import org.dspace.app.rest.model.SubmissionCCLicenseUrlRest; +import org.dspace.app.rest.model.wrapper.SubmissionCCLicenseUrl; import org.dspace.app.rest.repository.DSpaceRestRepository; import org.dspace.app.rest.utils.Utils; import org.dspace.core.Context; @@ -93,11 +94,12 @@ public class SubmissionCCLicenseUrlRepository extends DSpaceRestRepository { +public class SubmissionCCLicenseUrlConverter implements DSpaceConverter { /** * Convert a Submission CC License Url String to its REST representation - * @param modelObject - the CC License Url String to convert + * @param modelObject - the CC License Url object to convert * @param projection - the projection * @return the corresponding SubmissionCCLicenseUrlRest object */ @Override - public SubmissionCCLicenseUrlRest convert(final String modelObject, final Projection projection) { + public SubmissionCCLicenseUrlRest convert(SubmissionCCLicenseUrl modelObject, Projection projection) { SubmissionCCLicenseUrlRest submissionCCLicenseUrlRest = new SubmissionCCLicenseUrlRest(); - submissionCCLicenseUrlRest.setUrl(modelObject); - submissionCCLicenseUrlRest.setId(modelObject); + submissionCCLicenseUrlRest.setUrl(modelObject.getUrl()); + submissionCCLicenseUrlRest.setId(modelObject.getId()); return submissionCCLicenseUrlRest; } @Override - public Class getModelClass() { - return String.class; + public Class getModelClass() { + return SubmissionCCLicenseUrl.class; } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/wrapper/SubmissionCCLicenseUrl.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/wrapper/SubmissionCCLicenseUrl.java new file mode 100644 index 0000000000..4178e67c49 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/wrapper/SubmissionCCLicenseUrl.java @@ -0,0 +1,51 @@ +/** + * 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.rest.model.wrapper; + +public class SubmissionCCLicenseUrl { + + private String url; + private String id; + + public SubmissionCCLicenseUrl(String url, String id) { + this.url = url; + this.id = id; + } + + /** + * Generic getter for the url + * @return the url value of this SubmissionCCLicenseUrl + */ + public String getUrl() { + return url; + } + + /** + * Generic setter for the url + * @param url The url to be set on this SubmissionCCLicenseUrl + */ + public void setUrl(String url) { + this.url = url; + } + + /** + * Generic getter for the id + * @return the id value of this SubmissionCCLicenseUrl + */ + public String getId() { + return id; + } + + /** + * Generic setter for the id + * @param id The id to be set on this SubmissionCCLicenseUrl + */ + public void setId(String id) { + this.id = id; + } +} From 9f9fe26549fc8d0dd17059b4f6d84bff6451badf Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Tue, 23 Jun 2020 15:09:45 +0200 Subject: [PATCH 122/125] [Task 71440] fixed checkstyle and added preAuthorize to the SubmissionCCLicenseUrlRepository --- .../org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java | 1 + .../app/rest/converter/SubmissionCCLicenseUrlConverter.java | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java index 62cd48d56e..26703f320d 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java @@ -106,6 +106,7 @@ public class SubmissionCCLicenseUrlRepository extends DSpaceRestRepository { +public class SubmissionCCLicenseUrlConverter + implements DSpaceConverter { /** * Convert a Submission CC License Url String to its REST representation From 2b6f19f6beb1f54b727b1a3d83c69b7179a55972 Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Wed, 24 Jun 2020 11:14:40 +0200 Subject: [PATCH 123/125] [Task 71440] added javadocs to SubmissionCCLicenseUrl --- .../model/wrapper/SubmissionCCLicenseUrl.java | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/wrapper/SubmissionCCLicenseUrl.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/wrapper/SubmissionCCLicenseUrl.java index 4178e67c49..68ff1166b4 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/wrapper/SubmissionCCLicenseUrl.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/wrapper/SubmissionCCLicenseUrl.java @@ -7,11 +7,28 @@ */ package org.dspace.app.rest.model.wrapper; +/** + * This class represents a model implementation for {@link org.dspace.app.rest.model.SubmissionCCLicenseUrlRest} + * This will simply store a url and an id. it'll be used to create an object with these variables out of information + * that came from the back-end. This object will then be used in the + * {@link org.dspace.app.rest.converter.SubmissionCCLicenseUrlConverter} to turn it into its REST object + */ public class SubmissionCCLicenseUrl { + /** + * The url for ths object + */ private String url; + /** + * The id for this object + */ private String id; + /** + * Default constructor with two parameters, url and id + * @param url The url of this object + * @param id The id of this object + */ public SubmissionCCLicenseUrl(String url, String id) { this.url = url; this.id = id; From 8ca6064c88af564865e837aaf40970aaa4048a77 Mon Sep 17 00:00:00 2001 From: Kevin Van de Velde Date: Thu, 25 Jun 2020 10:16:46 +0200 Subject: [PATCH 124/125] [CC License] Adding search link to HAL output --- .../rest/SubmissionCCLicenseUrlRepository.java | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java index 26703f320d..cbfbd347b2 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java @@ -7,6 +7,7 @@ */ package org.dspace.app.rest; +import java.util.Arrays; import java.util.HashMap; import java.util.Map; import javax.servlet.ServletRequest; @@ -23,10 +24,12 @@ import org.dspace.core.Context; import org.dspace.license.service.CreativeCommonsService; import org.dspace.services.RequestService; import org.dspace.utils.DSpace; +import org.springframework.beans.factory.InitializingBean; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.data.rest.webmvc.ResourceNotFoundException; +import org.springframework.hateoas.Link; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Component; @@ -36,7 +39,8 @@ import org.springframework.stereotype.Component; */ @Component(SubmissionCCLicenseUrlRest.CATEGORY + "." + SubmissionCCLicenseUrlRest.NAME) -public class SubmissionCCLicenseUrlRepository extends DSpaceRestRepository { +public class SubmissionCCLicenseUrlRepository extends DSpaceRestRepository + implements InitializingBean { @Autowired protected Utils utils; @@ -49,6 +53,9 @@ public class SubmissionCCLicenseUrlRepository extends DSpaceRestRepository getDomainClass() { return SubmissionCCLicenseUrlRest.class; } + + @Override + public void afterPropertiesSet() { + discoverableEndpointsService.register(this, Arrays.asList( + new Link("/api/" + SubmissionCCLicenseUrlRest.CATEGORY + "/" + SubmissionCCLicenseUrlRest.NAME + "/search", + SubmissionCCLicenseUrlRest.NAME + "-search"))); + } + } From 8cadd105468132611f42c23f94b813ad1b22e90c Mon Sep 17 00:00:00 2001 From: Kevin Van de Velde Date: Thu, 25 Jun 2020 10:56:20 +0200 Subject: [PATCH 125/125] [CC License] Fixing checkstyle issues --- .../org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java index cbfbd347b2..957484319c 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/SubmissionCCLicenseUrlRepository.java @@ -132,7 +132,8 @@ public class SubmissionCCLicenseUrlRepository extends DSpaceRestRepository