Skip to content
Permalink
master
Switch branches/tags

orcid_support_advance/cfg/cfg.d/z_orcid_support_advance.pl

Go to file
 
 
Cannot retrieve contributors at this time
426 lines (375 sloc) 15.6 KB
Raw Blame
###General ORCID Support Advance config###
$c->{orcid_support_advance}->{disable_input} = 1;
$c->{ORCID_contact_email} = $c->{adminemail};
$c->{orcid_support_advance}->{client_id} = "XXXX";
$c->{orcid_support_advance}->{client_secret} = "YYYY";
$c->{orcid_support_advance}->{orcid_apiv2} = "https://api.sandbox.orcid.org/v2.0/";
$c->{orcid_support_advance}->{orcid_org_auth_uri} = "https://sandbox.orcid.org/oauth/authorize";
$c->{orcid_support_advance}->{orcid_org_exch_uri} = "https://sandbox.orcid.org/oauth/token";
$c->{orcid_support_advance}->{orcid_org_revoke_uri} = "https://sandbox.orcid.org/oauth/revoke";
$c->{orcid_support_advance}->{redirect_uri} = $c->{"perl_url"} . "/orcid/authenticate";
# Decide if the pre-commit trigger should keep (0) or delete (1) non authenticated orcid ids,
# for example manual entries from using the "ORCID support" plugin.
# Set to 1 if (and only if!) repository user profiles (connected to orcid.org) are the sole source of ORCID data.
$c->{orcid_support_advance}->{destructive_trigger} = 0;
###Enable Screens###
$c->{"plugins"}->{"Screen::AuthenticateOrcid"}->{"params"}->{"disable"} = 0;
$c->{"plugins"}->{"Screen::ManageOrcid"}->{"params"}->{"disable"} = 0;
$c->{"plugins"}->{"Screen::ImportFromOrcid"}->{"params"}->{"disable"} = 0;
$c->{"plugins"}->{"Screen::ExportToOrcid"}->{"params"}->{"disable"} = 0;
###Enable Event Plugins###
$c->{"plugins"}->{"Event::OrcidSync"}->{"params"}->{"disable"} = 0;
$c->{"plugins"}->{"Event::CheckOrcidName"}->{"params"}->{"disable"} = 0;
$c->{"plugins"}->{"Event::UpdateCreatorOrcid"}->{"params"}->{"disable"} = 0;
####Enable Report Plugins###
$c->{plugins}{"Screen::Report::Orcid::CheckName"}{params}{disable} = 0;
$c->{plugin_alias_map}->{"Screen::Report::Orcid::UserOrcid"} = "Screen::Report::Orcid::UserPermsOrcid";
$c->{plugin_alias_map}->{"Screen::Report::Orcid::UserPermsOrcid"} = undef;
###Override DOI Import plugin###
$c->{plugin_alias_map}->{"Import::DOI"} = "Import::OrcidDOI";
$c->{plugin_alias_map}->{"Import::OrcidDOI"} = undef;
#Details of the organization for affiliation inclusion - the easiest way to obtain the RINGGOLD id is to add it to your ORCID user record manually, then pull the orcid-profile via the API and the identifier will be on the record returned.
$c->{"plugins"}->{"Event::OrcidSync"}->{"params"}->{"affiliation"} = {
"organization" => {
"name" => "My University Name", #name of organization - REQUIRED
"address" => {
"city" => "My Town", # name of the town / city for the organization - REQUIRED if address included
# "region" => "Countyshire", # region e.g. county / state / province - OPTIONAL
"country" => "GB", # 2 letter country code - AU, GB, IE, NZ, US, etc. - REQUIRED if address included
},
"disambiguated-organization" => {
"disambiguated-organization-identifier" => "ZZZZ", # replace ZZZZ with Institutional identifier from the recognised source
"disambiguation-source" => "RINGGOLD", # Source for institutional identifier should be RINGGOLD or ISNI
}
}
};
###Education User Types###
##If the user type matches any of the following defined fields, update user's education affiliations rather than employment affiliations
$c->{orcid_support_advance}->{education_user_types} = [];
###User Roles###
push @{$c->{user_roles}->{admin}}, qw{
+orcid_admin
};
###User fields###
$c->add_dataset_field('user',
{
name => 'orcid_access_token',
type => 'text',
show_in_html => 0,
export_as_xml => 0,
import => 0,
},
reuse => 1
);
$c->add_dataset_field('user',
{
name => 'orcid_granted_permissions',
type => 'text',
show_in_html => 0,
export_as_xml => 0,
import => 0,
},
reuse => 1
);
$c->add_dataset_field('user',
{
name => 'orcid_token_expires',
type => 'time',
render_res => 'minute',
render_style => 'long',
export_as_xml => 0,
import => 0,
},
reuse => 1
);
$c->add_dataset_field('user',
{
name => 'orcid_read_record',
type => 'boolean',
show_in_html => 0,
export_as_xml => 0,
import => 0,
},
reuse => 1
);
$c->add_dataset_field('user',
{
name => 'orcid_update_works',
type => 'boolean',
show_in_html => 0,
export_as_xml => 0,
import => 0,
},
reuse => 1
);
$c->add_dataset_field('user',
{
name => 'orcid_update_profile',
type => 'boolean',
show_in_html => 0,
export_as_xml => 0,
import => 0,
},
reuse => 1
);
$c->add_dataset_field('user',
{
name => 'orcid_name',
type => 'name',
show_in_html => 0,
export_as_xml => 0,
import => 0,
},
reuse => 1
);
###EPrint Fields###
#add put-code as a subfield to appropriate eprint fields
my $putcode_present = 0;
foreach my $field( @{$c->{fields}->{eprint}} )
{
if( grep { $field->{name} eq $_ } @{$c->{orcid}->{eprint_fields}}) #$c->{orcid}->{eprint_fields} defined in z_orcid_support.pl
{
#check if field already has a putcode subfield
$putcode_present = 0;
for(@{$field->{fields}})
{
if( EPrints::Utils::is_set( $_->{name} ) && $_->{name} eq "putcode" )
{
$putcode_present = 1;
last;
}
}
if( !$putcode_present )
{
@{$field->{fields}} = (@{$field->{fields}}, (
{
sub_name => 'putcode',
type => 'text',
allow_null => 1,
show_in_html => 0, #we don't need this field to appear in the workflow
export_as_xml => 0, #nor do we want it appearing in exports
can_clone => 0, #don't copy when using item as a template
}
));
# Possible to do: If that was successful, find and save putcodes of all items that have been exported in previous versions of this plugin.
}
}
}
#each permission defined below with some default behaviour (basic permission description commented by each item)
##default - 1 or 0 = this item selected or not selected on screen by default
##display - 1 or 0 = show or show not the option for this item on the screen at all
##admin-edit - 1 or 0 = admins can or can not change this option once users have obtained ORCID authorisation token
##user-edit - 1 or 0 = user can or can not change this option prior to obtaining ORCID authorisation token
##use-value = take the value for this option from the option of another permission e.g. include create if we get update
## **************** AVOID CIRCULAR REFERENCES IN THIS !!!! *******************
## Full Access is granted by the options not commented out below
$c->{ORCID_requestable_permissions} = [
{
"permission" => "/authenticate", #basic link to ORCID ID
"default" => 1,
"display" => 1,
"admin_edit" => 0,
"user_edit" => 0,
"use_value" => "self",
"field" => undef,
},
{
"permission" => "/activities/update", #update research activities created by this client_id (implies create)
"default" => 1,
"display" => 1,
"admin_edit" => 1,
"user_edit" => 1,
"use_value" => "self",
"field" => "orcid_update_works",
},
{
"permission" => "/read-limited", #read information from ORCID profile which the user has set to trusted parties only
"default" => 1,
"display" => 1,
"admin_edit" => 1,
"user_edit" => 1,
"use_value" => "self",
"field" => "orcid_read_record",
},
];
# work types mapping from EPrints to ORCID
# defined separately from the called function to enable easy overriding.
$c->{"plugins"}->{"Screen::ExportToOrcid"}->{"params"}->{"work_type"} = {
"article" => "JOURNAL_ARTICLE",
"book_section" => "BOOK_CHAPTER",
"monograph" => "BOOK",
"conference_item" => "CONFERENCE_PAPER",
"book" => "BOOK",
"thesis" => "DISSERTATION",
"patent" => "PATENT",
"artefact" => "OTHER",
"exhibition" => "OTHER",
"composition" => "OTHER",
"performance" => "ARTISTIC_PERFORMANCE",
"image" => "OTHER",
"video" => "OTHER",
"audio" => "OTHER",
"dataset" => "DATA_SET",
"experiment" => "OTHER",
"teaching_resource" => "OTHER",
"other" => "OTHER",
};
$c->{"plugins"}->{"Screen::ExportToOrcid"}->{"work_type"} = sub {
#return the ORCID work-type based on the EPrints item type.
##default EPrints item types mapped in $c->{"plugins"}{"Event::OrcidSync"}{"params"}{"work_type"} above.
##ORCID acceptable item types listed here: https://members.orcid.org/api/supported-work-types
##Defined as a function in case there you need to replace it for more complicated processing
##based on other-types or conference_item sub-fields
my ( $eprint ) = @_;
my %work_types = %{$c->{"plugins"}{"Screen::ExportToOrcid"}{"params"}{"work_type"}};
if( defined( $eprint ) && $eprint->exists_and_set( "type" ))
{
my $ret_val = $work_types{ $eprint->get_value( "type" ) };
if( defined ( $ret_val ) )
{
return $ret_val;
}
}
#if no mapping found, call it 'other'
return "OTHER";
};
$c->{"plugins"}->{"Screen::ImportFromOrcid"}->{"work_type"} = sub {
my ( $type ) = @_;
my %work_types = reverse %{$c->{"plugins"}{"Screen::ExportToOrcid"}{"params"}{"work_type"}};
if( defined( $type ) )
{
my $ret_val = $work_types{ $type };
if( defined ( $ret_val ) )
{
return $ret_val;
}
}
#if no mapping found, call it 'other'
return "other";
};
# contributor types mapping from EPrints to ORCID - used in Screen::ExportToOrcid to add contributor details to orcid-works and when importing works to eprints
$c->{orcid_support_advance}->{contributor_map} = {
#eprint field name => ORCID contributor type,
"creators" => "AUTHOR",
"editors" => "EDITOR",
};
# map orcids work: citation-type to available import plugins
$c->{orcid_support_advance}->{import_citation_type_map} = {
BIBTEX => "BibTeX",
};
#trigger for acquiring a user's name from their orcid.org profile
$c->add_dataset_trigger( "user", EPrints::Const::EP_TRIGGER_BEFORE_COMMIT, sub {
my( %params ) = @_;
my $repo = $params{repository};
my $user = $params{dataobj};
if( $user->is_set( "orcid" ) && $user->exists_and_set( "orcid_access_token" ) )
{
$repo->dataset( "event_queue" )->create_dataobj({
pluginid => "Event::CheckOrcidName",
action => "check_name",
params => ["/id/user/".$user->get_value( "userid" )],
});
}
} );
#automatic update of eprint creator field - orcid should be set to user's orcid value
$c->add_dataset_trigger( 'eprint', EPrints::Const::EP_TRIGGER_BEFORE_COMMIT, sub
{
my( %args ) = @_;
my( $repo, $eprint, $changed ) = @args{qw( repository dataobj changed )};
#$c->{orcid}->{eprint_fields} defined in z_orcid_support.pl
#should normally contain "creators" and "editors"
foreach my $role (@{$c->{orcid}->{eprint_fields}})
{
# Set some variables
my $contributors_orcid = "$role" . "_orcid";
my $contributors_id = "$role" . "_id";
return unless $eprint->dataset->has_field( $contributors_orcid );
if( !$eprint->{orcid_update} ) #this update hasn't come from orcid, therefore we want to check the orcids and put-codes
{
my $contributors = $eprint->get_value("$role");
my @new_contributors;
my $old_eprint = $eprint->dataset->dataobj( $eprint->id );
my $old_contributors = $old_eprint->get_value( "$role" ) if defined $old_eprint;
my $prev_ids = $changed->{"$contributors_id"};
#loop through the existing creators/editors and update them
foreach my $c (@{$contributors})
{
my $new_c = $c;
#try to set orcid via user profile, keep/delete old orcid (depending on config)
$new_c->{orcid} = undef if $repo->config( "orcid_support_advance", "destructive_trigger" );
#get id and user profile
my $email = $c->{id};
$email = lc($email) if defined $email;
my $user = EPrints::DataObj::User::user_with_email($eprint->repository, $email);
if( $user )
{
if( EPrints::Utils::is_set( $user->value( 'orcid' ) ) ) #user has an orcid
{
#set the orcid
$new_c->{orcid} = $user->value( 'orcid' );
}
}
#need to update any put-codes associated with creators/editors
if( defined($old_contributors) && @{$old_contributors} )
{
#first delete any put-code we've carried over, but keep a record of an existing put-code
$new_c->{putcode} = undef;
if( defined $new_c->{orcid} )
{
#we have an orcid, so see if this orcid had a put code attached previously
foreach my $old_c ( @{$old_contributors} )
{
if( defined $old_c->{putcode} && $old_c->{orcid} eq $new_c->{orcid} )
{
$new_c->{putcode} = $old_c->{putcode};
}
}
}
}
# Drop creator/editor without name or id.
# Effectively removes manually deleted entries where the orcid couldn't be removed since it's read-only
push( @new_contributors, $new_c ) unless !$new_c->{id} && !$new_c->{name}->{family} && !$new_c->{name}->{given};
}
#now we have a list of new and old creators/editors, see if any put-codes have been removed and if so, remove those records from ORCID
foreach my $old_c ( @{$old_contributors} )
{
my $seen = 0;
foreach my $new_c( @new_contributors )
{
if( defined $old_c->{putcode} && defined $new_c->{putcode} && $old_c->{putcode} eq $new_c->{putcode} )
{
$seen = 1;
last;
}
}
if( !$seen )
{
#this record has been removed
#To Do: Think about deleting item in orcid record
}
}
$eprint->set_value("$role", \@new_contributors);
}
}
}, priority => 60 );
# Update EPrint ORCID metadata when a user connects/disconnects their user account with orcid.org
$c->add_dataset_trigger( 'user', EPrints::Const::EP_TRIGGER_AFTER_COMMIT, sub
{
my( %args ) = @_;
my( $repo, $user, $changed ) = @args{qw( repository dataobj changed )};
if( exists $changed->{orcid} && $user->is_set( "email" ) )
{
my $email = $user->value( "email" );
my $ds = $repo->get_repository->get_dataset( "eprint" );
my $search_exp = $ds->prepare_search();
$search_exp->add_field(
fields => [ $ds->field( 'creators_id' ) ],
value => $email,
);
my $list = $search_exp->perform_search;
$list->map( sub{
my( $session, $dataset, $eprint ) = @_;
$eprint->commit( 1 );
} );
}
}, priority => 50 );