Custom handlers - Revision history

Drn@ecs.soton.ac.uk at 18:02, 22 January 2022

2022-01-22T18:02:11Z

Drn@ecs.soton.ac.uk at 18:01, 22 January 2022

2022-01-22T18:01:56Z

Th.lauke@arcor.de: typos&formatting corrected

2020-08-12T13:21:49Z

typos&formatting corrected

Drn@ecs.soton.ac.uk at 19:23, 23 July 2020

2020-07-23T19:23:38Z

Drn@ecs.soton.ac.uk at 19:21, 23 July 2020

2020-07-23T19:21:28Z

Drn@ecs.soton.ac.uk: Added category

2020-07-23T19:21:09Z

Added category

Drn@ecs.soton.ac.uk: Add page about custom handlers

2020-07-23T19:18:02Z

Add page about custom handlers

New page

It has been more common to integrate EPrints with third-party applications such as [https://www.elsevier.com/en-gb/solutions/pure Pure]. In the past there has been two ways to incorporate custom handlers for such integration.

One method requires addoing a Location block to the webserver configuration and a rewrite exception to the the rewrite_exceptions configuration array. This has been seen to cause a [https://www.mail-archive.com/modperl@apache.org/msg32317.html race condition with mod_perl], in particular when intergating Pure's PDA handler.

The other option has been to hack ''perl_lib/EPrints/Apache/Rewrite.pm'' to include a block of code for your custom handler. Since EPrints 3.4.2 specifying custom handlers is now possible as part of the EPrints configuration. Below is the configuration you should use if you want to integrate Pure's PDS handler:

$c->{custom_handlers}->{pda}->{regex} = '^URLPATH/pda';
$c->{custom_handlers}->{pda}->{function} = sub
{
my ( $r ) = @_;

$r->handler( 'perl-script' );
$r->set_handlers( PerlResponseHandler => [ 'PDA::PDAHandler' ] );
return EPrints::Const::OK;
};

''URLPATH'' is used as a macro for the path that the EPrints repository is hosted on. Typically this will be empty unless EPrints is run under some sub path (e.g. http://eprints.example.org/some_path/). If you custom handler configuration like this, there is no need to edit your webserver configuration, add a rewrite_exception to your configuration or hack ''perl_lib/EPrints/Apache/Rewrite.pm'''.

← Older revision		Revision as of 18:02, 22 January 2022
Line 19:		Line 19:
	<code>URLPATH</code> is used as a macro for the path that the EPrints repository is hosted on. Typically this will be empty unless EPrints is run under some ''sub'' path (e.g. <nowiki>http://eprints.example.org/</nowiki>''some_sub_path''/). If you add custom handler configuration like this to your archive's <code>cfg/cfg.d/</code> directory, there is no need to edit your webserver configuration, add a rewrite_exception to your configuration or hack <code>perl_lib/EPrints/Apache/Rewrite.pm</code>.		<code>URLPATH</code> is used as a macro for the path that the EPrints repository is hosted on. Typically this will be empty unless EPrints is run under some ''sub'' path (e.g. <nowiki>http://eprints.example.org/</nowiki>''some_sub_path''/). If you add custom handler configuration like this to your archive's <code>cfg/cfg.d/</code> directory, there is no need to edit your webserver configuration, add a rewrite_exception to your configuration or hack <code>perl_lib/EPrints/Apache/Rewrite.pm</code>.

−	[[Category:Manual]] [[Category::Howto]]	+	[[Category:Manual]] [[Category:Howto]]

← Older revision		Revision as of 18:01, 22 January 2022
Line 19:		Line 19:
	<code>URLPATH</code> is used as a macro for the path that the EPrints repository is hosted on. Typically this will be empty unless EPrints is run under some ''sub'' path (e.g. <nowiki>http://eprints.example.org/</nowiki>''some_sub_path''/). If you add custom handler configuration like this to your archive's <code>cfg/cfg.d/</code> directory, there is no need to edit your webserver configuration, add a rewrite_exception to your configuration or hack <code>perl_lib/EPrints/Apache/Rewrite.pm</code>.		<code>URLPATH</code> is used as a macro for the path that the EPrints repository is hosted on. Typically this will be empty unless EPrints is run under some ''sub'' path (e.g. <nowiki>http://eprints.example.org/</nowiki>''some_sub_path''/). If you add custom handler configuration like this to your archive's <code>cfg/cfg.d/</code> directory, there is no need to edit your webserver configuration, add a rewrite_exception to your configuration or hack <code>perl_lib/EPrints/Apache/Rewrite.pm</code>.

−	[[Category:Manual]]	+	[[Category:Manual]] [[Category::Howto]]

@@ Line 1: / Line 1: @@
 It has been more common to integrate EPrints with third-party applications such as [https://www.elsevier.com/en-gb/solutions/pure Pure].  In the past there has been two ways to incorporate custom handlers for such integration.
-One method requires addoing a Location block to the webserver configuration and a rewrite exception to the the rewrite_exceptions configuration array.  This has been seen to cause a [https://www.mail-archive.com/modperl@apache.org/msg32317.html race condition with mod_perl], in particular when intergating Pure's PDA handler.
+One method requires adding a Location block to the webserver configuration and a ''rewrite exception'' to the rewrite_exceptions configuration array.  This has been seen to cause a [https://www.mail-archive.com/modperl@apache.org/msg32317.html race condition with mod_perl], in particular when integrating Pure's PDA handler.
-The other option has been to hack ''perl_lib/EPrints/Apache/Rewrite.pm'' to include a block of code for your custom handler.  Since EPrints 3.4.2 specifying custom handlers is now possible as part of the EPrints configuration.  Below is the configuration you should use if you want to integrate Pure's PDA handler:
+The other option has been to hack <code>perl_lib/EPrints/Apache/Rewrite.pm</code> to include a block of code for your custom handler.  Since [[EPrints_3.4.2 | EPrints 3.4.2]] specifying custom handlers is now possible as part of the EPrints configuration.
   $c->{custom_handlers}->{pda}->{regex} = '^URLPATH/pda';
@@ Line 15: / Line 17: @@
   };
-''URLPATH'' is used as a macro for the path that the EPrints repository is hosted on.  Typically this will be empty unless EPrints is run under some sub path (e.g. http://eprints.example.org/some_path/).  If you add custom handler configuration like this, to your archive's ''cfg/cfg.d/'' directory, there is no need to edit your webserver configuration, add a rewrite_exception to your configuration or hack ''perl_lib/EPrints/Apache/Rewrite.pm'''.
+<code>URLPATH</code> is used as a macro for the path that the EPrints repository is hosted on.  Typically this will be empty unless EPrints is run under some ''sub'' path (e.g. <nowiki>http://eprints.example.org/</nowiki>''some_sub_path''/).  If you add custom handler configuration like this to your archive's <code>cfg/cfg.d/</code> directory, there is no need to edit your webserver configuration, add a rewrite_exception to your configuration or hack <code>perl_lib/EPrints/Apache/Rewrite.pm</code>.
 [[Category:Manual]]

← Older revision		Revision as of 19:21, 23 July 2020
Line 17:		Line 17:
	''URLPATH'' is used as a macro for the path that the EPrints repository is hosted on. Typically this will be empty unless EPrints is run under some sub path (e.g. http://eprints.example.org/some_path/). If you add custom handler configuration like this, to your archive's ''cfg/cfg.d/'' directory, there is no need to edit your webserver configuration, add a rewrite_exception to your configuration or hack ''perl_lib/EPrints/Apache/Rewrite.pm'''.		''URLPATH'' is used as a macro for the path that the EPrints repository is hosted on. Typically this will be empty unless EPrints is run under some sub path (e.g. http://eprints.example.org/some_path/). If you add custom handler configuration like this, to your archive's ''cfg/cfg.d/'' directory, there is no need to edit your webserver configuration, add a rewrite_exception to your configuration or hack ''perl_lib/EPrints/Apache/Rewrite.pm'''.

−	[[Category::Manual]]	+	[[Category:Manual]]

← Older revision		Revision as of 19:21, 23 July 2020
Line 15:		Line 15:
	};		};

−	''URLPATH'' is used as a macro for the path that the EPrints repository is hosted on. Typically this will be empty unless EPrints is run under some sub path (e.g. http://eprints.example.org/some_path/). If you custom handler configuration like this, there is no need to edit your webserver configuration, add a rewrite_exception to your configuration or hack ''perl_lib/EPrints/Apache/Rewrite.pm'''.	+	''URLPATH'' is used as a macro for the path that the EPrints repository is hosted on. Typically this will be empty unless EPrints is run under some sub path (e.g. http://eprints.example.org/some_path/). If you add custom handler configuration like this, to your archive's ''cfg/cfg.d/'' directory, there is no need to edit your webserver configuration, add a rewrite_exception to your configuration or hack ''perl_lib/EPrints/Apache/Rewrite.pm'''.
		+
		+	[[Category::Manual]]