Funder identifier issue fix

.gitignore

@@ -1,2 +1,2 @@
-
+*.sw[po]
 DataCiteDoi.epm

DataCiteDoi.epmi

@@ -1,61 +1,101 @@
 <?xml version='1.0' encoding='utf-8'?>
-<epm xmlns='http://eprints.org/ep2/data/2.0' id='http://eprints/id/epm/DataCiteDoi'>
+<epm xmlns='http://eprints.org/ep2/data/2.0' id='http://192.168.23.142/id/epm/DataCiteDoi'>
   <epmid>DataCiteDoi</epmid>
-  <uri>http://eprints/id/epm/DataCiteDoi</uri>
+  <uri>http://192.168.23.142/id/epm/DataCiteDoi</uri>
   <documents>
     <document>
       <files>
         <file>
-          <filename>epm/DataCiteDoi/cfg/cfg.d/z_datacitedoi.pl</filename>
-          <mime_type>text/plain</mime_type>
-          <hash>fcb3176e88cf0bccb6c8e000bd1ac0da</hash>
+          <datasetid>document</datasetid>
+          <filename>lang/en/phrases/coinDOI.xml</filename>
+          <mime_type>application/xml</mime_type>
+          <hash>0df177ef1ffd08206156f49996b70c92</hash>
+          <hash_type>MD5</hash_type>
+          <filesize>13340</filesize>
+        </file>
+        <file>
+          <datasetid>document</datasetid>
+          <filename>static/images/epm/datacitedoi.png</filename>
+          <mime_type>image/png</mime_type>
+          <hash>5c277fb358fe95e059b0f2aed2b49ce8</hash>
           <hash_type>MD5</hash_type>
-          <filesize>1070</filesize>
+          <filesize>21105</filesize>
         </file>
         <file>
+          <datasetid>document</datasetid>
+          <filename>plugins/EPrints/Plugin/Event/DataCiteEvent.pm</filename>
+          <mime_type>text/x-java</mime_type>
+          <hash>6a29de65f6268314881d1197cb70b74e</hash>
+          <hash_type>MD5</hash_type>
+          <filesize>7606</filesize>
+        </file>
+        <file>
+          <datasetid>document</datasetid>
           <filename>plugins/EPrints/Plugin/Export/DataCiteXML.pm</filename>
-          <mime_type>application/x-symlink</mime_type>
-          <hash>84f4180876ff95bdde9f78a6a4c300e6</hash>
+          <mime_type>text/plain</mime_type>
+          <hash>c2cd69eac69b3008b343d916688b95f4</hash>
           <hash_type>MD5</hash_type>
-          <filesize>3898</filesize>
+          <filesize>2948</filesize>
         </file>
         <file>
-          <filename>static/images/epm/datacitedoi.png</filename>
-          <mime_type>application/x-symlink</mime_type>
-          <hash>14e9e2be0a73f452533488634aaea66e</hash>
+          <datasetid>document</datasetid>
+          <filename>plugins/EPrints/Plugin/Screen/EPrint/Staff/CoinDOI.pm</filename>
+          <mime_type>text/plain</mime_type>
+          <hash>9be56b73b331a5a012466899d8c644f0</hash>
+          <hash_type>MD5</hash_type>
+          <filesize>3894</filesize>
+        </file>
+        <file>
+          <datasetid>document</datasetid>
+          <filename>cfg.d/z_datacite_mapping.pl</filename>
+          <mime_type>text/plain</mime_type>
+          <hash>259bcefdcf55f87cabc2d0b002023987</hash>
           <hash_type>MD5</hash_type>
-          <filesize>101504</filesize>
+          <filesize>20371</filesize>
+        </file>
+        <file>
+          <datasetid>document</datasetid>
+          <filename>epm/DataCiteDoi/cfg/cfg.d/z_datacitedoi.pl</filename>
+          <mime_type>text/plain</mime_type>
+          <hash>98b5a0b2203a9b6a180ae1b996823d20</hash>
+          <hash_type>MD5</hash_type>
+          <filesize>6522</filesize>
         </file>
       </files>
-      <mime_type>application/x-symlink</mime_type>
-      <format>other</format>
-      <main>static/images/epm/datacitedoi.png</main>
+      <mime_type>text/plain</mime_type>
+      <format>text</format>
+      <main>epm/DataCiteDoi/cfg/cfg.d/z_datacitedoi.pl</main>
       <content>install</content>
     </document>
     <document>
       <files>
         <file>
+          <datasetid>document</datasetid>
           <filename>static/images/epm/datacitedoi.png</filename>
-          <mime_type>application/x-symlink</mime_type>
-          <hash>14e9e2be0a73f452533488634aaea66e</hash>
+          <mime_type>image/png</mime_type>
+          <hash>5c277fb358fe95e059b0f2aed2b49ce8</hash>
           <hash_type>MD5</hash_type>
-          <filesize>101504</filesize>
+          <filesize>21105</filesize>
         </file>
       </files>
       <format>image</format>
       <main>static/images/epm/datacitedoi.png</main>
       <content>coverimage</content>
     </document>
   </documents>
-  <version>0.9.0</version>
+  <version>2.1.0</version>
   <creators>
     <item>
       <name>
-        <family>Milsted</family>
-        <given>Andrew</given>
+        <family>McNicholl</family>
+        <given>Rory</given>
       </name>
+      <id>repositories@ulcc.ac.uk</id>
     </item>
   </creators>
-  <title>Data Cite DOI Registration</title>
+  <datestamp>2018-12-18 20:07:23</datestamp>
+  <title>DataCiteDoi - DataCite DOIs for EPrints</title>
+  <description>Integrate minting and registering DataCite DOIs in to EPrints</description>
+  <home_page>https://github.com/eprintsug/DataCiteDoi</home_page>
   <icon>images/epm/datacitedoi.png</icon>
 </epm>

README.md

@@ -4,20 +4,31 @@ DateCiteDoi - A plugin to mint DataCite DOIs to eprints
 Requirements
 -------------
 
-In order to use the DataCite API the plugin requires the following perl libraries on to of EPrints requirements.
+In order to use the DataCite API the plugin requires the following perl libraries on top of EPrints requirements.
 
 ```
 use LWP;
-use Crypt::SSLeay;
+use LWP::Protocol::https;
 ```
 
+For systems who's
+[LWP::Protocol::https](https://metacpan.org/release/LWP-Protocol-https) is
+older than 6.0.7 and where connections will be made to SNI enabled servers
+WWW::Curl should be used instead.
+
+```
+use WWW::Curl;
+```
+
+If using WWW::Curl ensure configuration item `$c->{datacitedoi}{use_curl}` is defined.
+
+
 Installation
 -------------
 
 Install the plugin from the bazaar and edit the following config files.
 
 ```
-z_datacite_core.pl
 z_datacitedoi.pl
 ```
 
@@ -33,90 +44,176 @@ This config file contains all the configurable settings for the plugin, see comm
 $c->{plugins}{"Export::DataCiteXML"}{params}{disable} = 0;
 $c->{plugins}{"Event::DataCiteEvent"}{params}{disable} = 0;
 
-#which field do use for the doi
+# Regex to match pre production servers
+# $c->{datacitedoi}{test_host_regex} = 'dev|test|preprod';
+
+# which field to use for the doi
 $c->{datacitedoi}{eprintdoifield} = "id_number";
 
+#for xml:lang attributes in XML
+$c->{datacitedoi}{defaultlangtag} = "en-GB";
+
 #When should you register/update doi info.
 $c->{datacitedoi}{eprintstatus} = {inbox=>0,buffer=>1,archive=>1,deletion=>0};
 
+# Choose which EPrint types are allowed (or denied) the ability to coin DOIs. Keys must be lower case and be eprints *types* not *type_names*.
+# Entries here can be explicitly skipped by setting 0; however those not listed with a 1 are not given a Coin DOI button by default.
+# To include the 'Coin DOI' button on all types leave this undefined.
+# $c->{datacitedoi}{typesallowed} = {
+# 				'article'=>0,                   # Article
+# 				'thesis'=>1,                    # Thesis
+# 				'creative_works' => 1,          # Creative Works
+# 				'dataset' => 1,                 # Dataset
+#                                 };
+
 #set these (you will get the from data site)
 # doi = {prefix}/{repoid}/{eprintid}
 $c->{datacitedoi}{prefix} = "10.5072";
 $c->{datacitedoi}{repoid} = $c->{host};
-$c->{datacitedoi}{apiurl} = "https://test.datacite.org/mds/";
+$c->{datacitedoi}{apiurl} = "https://mds.test.datacite.org/";
 $c->{datacitedoi}{user} = "USER";
 $c->{datacitedoi}{pass} = "PASS";
 
-# datacite requires a Publisher 
-# The name of the entity that holds, archives, publishes, 
-# prints, distributes, releases, issues, or produces the 
-# resource. This property will be used to formulate the 
-# citation, so consider the prominence of the role.
-# eg World Data Center for Climate (WDCC);   
-$c->{datacitedoi}{publisher} = "Eprints Repo";
+# Backend library used for connecting to API; defaults to LWP (configuration item unset) but can also be Curl (configuration item set).
+# $c->{datacitedoi}{use_curl} = "yes";
+
+# Priviledge required to be able to mint DOIs
+# See https://wiki.eprints.org/w/User_roles.pl for role and privilege configuration
+$c->{datacitedoi}{minters} = "eprint/edit:editor";
 
-# need to map eprint type (article, dataset etc) to ResourceType
-# Controled list http://schema.datacite.org/meta/kernel-2.2/doc/DataCite-MetadataKernel_v2.2.pdf
+# DataCite requires a Publisher
+# The name of the entity that holds, archives, publishes,
+# prints, distributes, releases, issues, or produces the
+# resource. This property will be used to formulate the
+# citation, so consider the prominence of the role.
+# eg World Data Center for Climate (WDCC);
+$c->{datacitedoi}{publisher} = "EPrints Repo";
+
+# Namespace and location for DataCite XML schema
+# feel free to update, though no guarantees it'll be accepted if you do
+$c->{datacitedoi}{xmlns} = "http://datacite.org/schema/kernel-4";
+# Try this instead:
+# $c->{datacitedoi}{schemaLocation} = $c->{datacitedoi}{xmlns}." ".$c->{datacitedoi}{xmlns}."/metadata.xsd";
+$c->{datacitedoi}{schemaLocation} = $c->{datacitedoi}{xmlns}." http://schema.datacite.org/meta/kernel-4/metadata.xsd";
+
+# Need to map eprint type (article, dataset etc) to DOI ResourceType
+# Controlled list http://schema.datacite.org/meta/kernel-4.1/doc/DataCite-MetadataKernel_v4.1.pdf
 # where v is the ResourceType and a is the resourceTypeGeneral
+#$c->{datacitedoi}{typemap}{book_section} = {v=>'BookSection',a=>'Text'};
 $c->{datacitedoi}{typemap}{article} = {v=>'Article',a=>'Text'};
-$c->{datacitedoi}{typemap}{book_section} = {v=>'BookSection',a=>'Text'};
 $c->{datacitedoi}{typemap}{monograph} = {v=>'Monograph',a=>'Text'};
 $c->{datacitedoi}{typemap}{thesis} = {v=>'Thesis',a=>'Text'};
 $c->{datacitedoi}{typemap}{book} = {v=>'Book',a=>'Text'};
 $c->{datacitedoi}{typemap}{patent} = {v=>'Patent',a=>'Text'};
 $c->{datacitedoi}{typemap}{artefact} = {v=>'Artefact',a=>'PhysicalObject'};
-$c->{datacitedoi}{typemap}{performance} = {v=>'Performance',a=>'Event'};
+$c->{datacitedoi}{typemap}{exhibition} = {v=>'Exhibition',a=>'InteractiveResource'};
 $c->{datacitedoi}{typemap}{composition} = {v=>'Composition',a=>'Sound'};
+$c->{datacitedoi}{typemap}{performance} = {v=>'Performance',a=>'Event'};
 $c->{datacitedoi}{typemap}{image} = {v=>'Image',a=>'Image'};
+$c->{datacitedoi}{typemap}{video} = {v=>'Video',a=>'AudioVisual'};
+$c->{datacitedoi}{typemap}{audio} = {v=>'Audio',a=>'Sound'};
+$c->{datacitedoi}{typemap}{dataset} = {v=>'Dataset',a=>'Dataset'};
 $c->{datacitedoi}{typemap}{experiment} = {v=>'Experiment',a=>'Text'};
 $c->{datacitedoi}{typemap}{teaching_resource} = {v=>'TeachingResourse',a=>'InteractiveResource'};
 $c->{datacitedoi}{typemap}{other} = {v=>'Misc',a=>'Collection'};
-$c->{datacitedoi}{typemap}{dataset} = {v=>'Dataset',a=>'Dataset'};
-$c->{datacitedoi}{typemap}{audio} = {v=>'Audio',a=>'Sound'};
-$c->{datacitedoi}{typemap}{video} = {v=>'Video',a=>'Film'};
-```
+#For use with recollect
+$c->{datacitedoi}{typemap}{data_collection} = {v=>'Dataset',a=>'Dataset'};
+$c->{datacitedoi}{typemap}{collection} = {v=>'Collection',a=>'Collection'};
 
-z_datacite_core.pl
 
-Adds the minting plugin, by default it the plugin will run when ever the status (draft,review,deposit,delete) changes.
-The plugin will then run asynchronously after the change using the eprints queue so the datacite registration wont affect the users view.
+###########################
+#### DOI syntax config ####
+###########################
 
-```perl
-# Adds the minting plugin to the EP_TRIGGER_STATUS_CHANGE
-$c->add_dataset_trigger( "eprint", EP_TRIGGER_STATUS_CHANGE , sub {
+# Set config of DOI delimiters
+# Feel free to change, but they must conform to DOI syntax
+# If not set will default to prefix/repoid/id the example below gives prefix/repoid.id
+$c->{datacitedoi}{delimiters} = ["/","."];
+
+# If set, plugin will attempt to register what is found in the EP DOI field ($c->{datacitedoi}{eprintdoifield})
+# Will only work if what is found adheres to DOI syntax rules (obviously)
+$c->{datacitedoi}{allow_custom_doi} = 0;
+
+#Datacite recommend digits of length 8-10 set this param to pad the id to required length
+$c->{datacitedoi}{zero_padding} = 8;
+
+##########################################
+### Override which URL gets registered ###
+##########################################
+
+#Only useful for testing from "wrong" domain (eg an unregistered test server) should be undef for normal operation
+$c->{datacitedoi}{override_url} = undef;
+
+##########################
+##### When to coin ? #####
+##########################
+
+#If auto_coin is set DOIs will be minted on Status change (provided all else is well)
+$c->{datacitedoi}{auto_coin} = 0;
+#If action_coin is set then a button will be displayed under action tab (for staff) to mint DOIs on an adhoc basis
+$c->{datacitedoi}{action_coin} = 1;
+
+# NB setting auto_coin renders action coin redundant as only published items can be registered
+
+####### Formerly in cfg.d/datacite_core.pl #########
+
+# Including datacite_core.pl below as we can make some useful decisions based on the above config.
+
+## Adds the minting plugin to the EP_TRIGGER_STATUS_CHANGE
+if($c->{datacitedoi}{auto_coin}){
+	$c->add_dataset_trigger( "eprint", EP_TRIGGER_STATUS_CHANGE , sub {
        my ( %params ) = @_;
-
-       my $repository = %params->{repository};
-
-       return undef if (!defined $repository);
 
-       if (defined %params->{dataobj}) {
-               my $dataobj = %params->{dataobj};
-               my $eprint_id = $dataobj->id;
+       my $repository = $params{repository};
+
+       return undef if (!defined $repository);
 
+		if (defined $params{dataobj}) {
+			my $dataobj = $params{dataobj};
+			my $eprint_id = $dataobj->id;
 			$repository->dataset( "event_queue" )->create_dataobj({
-						                       pluginid => "Event::DataCiteEvent",
-						                       action => "datacite_doi",
-						                       params => [$dataobj->internal_uri],
-						               });
-		               });
-     }
-
-});
+				pluginid => "Event::DataCiteEvent",
+				action => "datacite_doi",
+				params => [$dataobj->internal_uri],
+			});
+     	}
+
+	});
+}
+
+# Activate an action button, the plugin for which is at
+# /plugins/EPrints/Plugin/Screen/EPrint/Staff/CoinDOI.pm
+if($c->{datacitedoi}{action_coin}){
+ 	$c->{plugins}{"Screen::EPrint::Staff::CoinDOI"}{params}{disable} = 0;
+}
+
+```
+
+
+If using a custom licence you must have phrases for your licences URI and typename (phrases for common licences are supplied in ``lib/lang/en/phrases/coinDOI.xml``). For example in ``archives/REPOID/cfg/lang/en/phrases/copyright.xml`` you might have these entries
+
 ```
-Who it works
+<epp:phrase id="licenses_uri_cc_exampleorg">https://example.org/eprints/about/legal/</epp:phrase>
+<epp:phrase id="licenses_typename_cc_exampleor">University of Example important licence</epp:phrase>
+
+```
+
+See [EPrints wiki](https://wiki.eprints.org/w/Phrase_Format) for the full phrase file format and note that variables (like ``{$config{http_url}}``) do not appear to be supported in licenses_uri_*.
+
+
+How it works
 -------------
 
-/lib/plugins/EPrints/Plugin/Event/DataCiteEvent.pm
-This is added to the queue and actually mints the doi.
+``lib/plugins/EPrints/Plugin/Event/DataCiteEvent.pm`` is added to the queue and actually mints the doi.
+
+``lib/plugins/EPrints/Plugin/Sreen/EPrint/Staff/CoinDOI.pm`` adds a button to enable staff to choose when to coin the DOI and request registration.
 
-/lib/plugins/EPrints/Plugin/Export/DataCiteXML.pm
-This exports the metadata xml required for minting, this can be used independently and through the user interface. 
+``lib/plugins/EPrints/Plugin/Export/DataCiteXML.pm`` exports the metadata xml required for minting, this can be used independently and through the user interface. 
 
-By default the plugin uses the following mapping:
+By default the plugin produces the following mapping:
 ```xml
 <?xml version="1.0"?>
-<resource xmlns="http://datacite.org/schema/kernel-2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://datacite.org/schema/kernel-2.2 http://schema.datacite.org/meta/kernel-2.2/metadata.xsd">
+<resource xmlns="http://datacite.org/schema/kernel-4" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://datacite.org/schema/kernel-4 http://schema.datacite.org/meta/kernel-4/metadata.xsd">
 	<identifier identifierType="DOI">[[From Config: $c->{datacitedoi}{prefix}/$c->{datacitedoi}{repoid]]/{{Eprintid}}</identifier>
 	<creators>
 		<creator>