Triggers - Revision history

Drn@ecs.soton.ac.uk: /* EP_TRIGGER_END */

2024-07-26T15:39:46Z

EP_TRIGGER_END

← Older revision		Revision as of 15:39, 26 July 2024
Line 104:		Line 104:

	===EP_TRIGGER_END===		===EP_TRIGGER_END===
	Just before an <code>EPrints::Repository</code> object is destroyed. (<font style="color: red;">Not currently implemented</font>).		Just before an <code>EPrints::Repository</code> object is destroyed. (<font style="color: red;">Not currently implemented</font>. Use <code>$c->{session_close}</code>).

	===EP_TRIGGER_DOC_URL_REWRITE===		===EP_TRIGGER_DOC_URL_REWRITE===

Drn@ecs.soton.ac.uk: /* EP_TRIGGER_BEGIN */

2024-07-26T15:39:20Z

EP_TRIGGER_BEGIN

← Older revision		Revision as of 15:39, 26 July 2024
Line 95:		Line 95:

	===EP_TRIGGER_BEGIN===		===EP_TRIGGER_BEGIN===
	When an <code>EPrints::Repository</code> object is created. (<font style="color: red;">Not currently implemented</font>).		When an <code>EPrints::Repository</code> object is created. (<font style="color: red;">Not currently implemented</font>. Use <code>$c->{session_init}</code>).

	===EP_TRIGGER_BEGIN_REQUEST===		===EP_TRIGGER_BEGIN_REQUEST===

Drn@ecs.soton.ac.uk: /* EP_TRIGGER_WARNINGS */ not currently implemented.

2024-07-25T17:22:21Z

EP_TRIGGER_WARNINGS: not currently implemented.

← Older revision		Revision as of 17:22, 25 July 2024
Line 519:		Line 519:

	=== EP_TRIGGER_WARNINGS ===		=== EP_TRIGGER_WARNINGS ===
	When a data objects is generating warnings about its state (e.g. missing or inappropriate metadata field values).		When a data objects is generating warnings about its state (e.g. missing or inappropriate metadata field values). (<font style="color: red;">Not currently implemented</font>. use <code>$c->{<DATASET>_warnings}</code> setting, e.g. <code>$c->{eprint_warnings}</code> in [[eprint_warnings.pl]]).

	=== EP_TRIGGER_FILES_MODIFIED ===		=== EP_TRIGGER_FILES_MODIFIED ===

Drn@ecs.soton.ac.uk: /* EP_TRIGGER_VALIDATE */ Not yet implemented

2024-07-25T17:17:57Z

EP_TRIGGER_VALIDATE: Not yet implemented

← Older revision		Revision as of 17:17, 25 July 2024
Line 516:		Line 516:

	=== EP_TRIGGER_VALIDATE ===		=== EP_TRIGGER_VALIDATE ===
	When the data object fields are being checked for their validity. (<font style="color: red;">Not currently implemented.</font> Either use [[#EP_TRIGGER_VALIDATE_FIELD\|EP_TRIGGER_VALIDATE_FIELD]] or ...).		When the data object fields are being checked for their validity. (<font style="color: red;">Not currently implemented.</font> Either use [[#EP_TRIGGER_VALIDATE_FIELD\|EP_TRIGGER_VALIDATE_FIELD]] or <code>$c->{set_<DATASET>_automatic_fields}</code> setting in [[document_fields_automatic.pl]], [[eprint_fields_automatic.pl]] or [[user_fields_automatic.pl]]).

	=== EP_TRIGGER_WARNINGS ===		=== EP_TRIGGER_WARNINGS ===

Drn@ecs.soton.ac.uk: /* EP_TRIGGER_VALIDATE */

2024-07-25T17:15:54Z

EP_TRIGGER_VALIDATE

← Older revision		Revision as of 17:15, 25 July 2024
Line 516:		Line 516:

	=== EP_TRIGGER_VALIDATE ===		=== EP_TRIGGER_VALIDATE ===
	When the data object fields are being checked for their validity.		When the data object fields are being checked for their validity. (<font style="color: red;">Not currently implemented.</font> Either use [[#EP_TRIGGER_VALIDATE_FIELD\|EP_TRIGGER_VALIDATE_FIELD]] or ...).

	=== EP_TRIGGER_WARNINGS ===		=== EP_TRIGGER_WARNINGS ===

Drn@ecs.soton.ac.uk: /* Example */

2024-07-25T17:13:04Z

Example

← Older revision		Revision as of 17:13, 25 July 2024
Line 305:		Line 305:

	==== Example ====		==== Example ====
	~~If the field name (for any field in~~ a ~~data object) is~~ <code>~~web_observatory_export~~</code>~~., Then run~~ the ~~data object's~~ <code>~~validate_web_observatory_meta~~</code> ~~function~~ to ~~perform further validation~~.		Validates that if a <code>password</code> field is submitted that it is no longer that the maximum length specified in <code>$c->{password_maxlength}</code> to protect against a Denial-of-Service attack, as password hashing is very expensive if the input is excessively long.
	$c->add_trigger(EP_TRIGGER_VALIDATE_FIELD, sub		$c->add_trigger( EPrints::Const::EP_TRIGGER_VALIDATE_FIELD, sub
	{		{
	my %~~params~~ = @_;		my( %args ) = @_;
	my $~~field =~~ $~~params{~~field};		my( $repo, $field, $user, $value, $problems ) = @args{qw( repository field dataobj value problems )};
	my $~~dataobj = $params{dataobj};~~
	my $value ~~= $params{value};~~
	my $problems = ~~$params~~{problems};

	if ($field->~~name~~ eq ~~'web_observatory_export'~~)		return unless defined $user && $user->isa( "EPrints::DataObj::User" ) && $field->type eq "secret";

			my $password;
			foreach my $key ( keys %{ $repo->{query}->{param} } )
	{		{
	my $~~wo_status~~ = $~~dataobj~~->~~validate_web_observatory_meta~~;		my $fieldname = $field->name;
			if ( $key =~ m/$fieldname$/ )
	if (!$~~wo_status->{valid}~~)
	{		{
	~~push @{~~$~~problems},~~ $~~dataobj~~->~~repository~~->~~xml~~->~~create_text_node("Web Observatory Export Issue: " .~~ $~~wo_status~~->~~{msg})~~;		$password = $repo->{query}->{param}->{$key}->[0];
			last;
	}		}
	}		}
	~~return EP_TRIGGER_DONE~~;
	});		if ( defined $password && defined $repo->config( "password_maxlength" ) && length( $password ) > $repo->config( "password_maxlength" ) )
			{
			my $fieldname = $repo->xml->create_element( "span", class=>"ep_problem_field:".$field->get_name );
			$fieldname->appendChild( $field->render_name( $repo ) );
			my $maxlength_el = $repo->make_text( $repo->config( "password_maxlength" ) );
			push @$problems, $repo->html_phrase( "validate:password_too_long",
			fieldname => $fieldname,
			maxlength => $maxlength_el,
			);
			}
			}, priority => 1000 );

	===EP_TRIGGER_LOCAL_SITEMAP_URLS===		===EP_TRIGGER_LOCAL_SITEMAP_URLS===

Drn@ecs.soton.ac.uk: /* EP_TRIGGER_VALIDATE_FIELD */ Added example

2024-07-25T17:06:53Z

EP_TRIGGER_VALIDATE_FIELD: Added example

@@ Line 303: / Line 303: @@
 === EP_TRIGGER_VALIDATE_FIELD ===
 When a metadata field is being validated.
 ===EP_TRIGGER_LOCAL_SITEMAP_URLS===

Drn@ecs.soton.ac.uk: /* EP_TRIGGER_INDEX_REMOVED */ Added example

2024-07-25T17:00:53Z

EP_TRIGGER_INDEX_REMOVED: Added example

@@ Line 239: / Line 239: @@
 ===EP_TRIGGER_INDEX_REMOVED===
 When fields are being removed from the index.
 === EP_TRIGGER_URL_REWRITE===

Drn@ecs.soton.ac.uk: /* EP_TRIGGER_BEGIN */

2024-07-25T16:58:04Z

EP_TRIGGER_BEGIN

← Older revision		Revision as of 16:58, 25 July 2024
Line 95:		Line 95:

	===EP_TRIGGER_BEGIN===		===EP_TRIGGER_BEGIN===
	When an <code>EPrints::Repository</code> object is created. (<font style="color: red;">Not currently implemented.</font>).		When an <code>EPrints::Repository</code> object is created. (<font style="color: red;">Not currently implemented</font>).

	===EP_TRIGGER_BEGIN_REQUEST===		===EP_TRIGGER_BEGIN_REQUEST===

Drn@ecs.soton.ac.uk: /* EP_TRIGGER_END */

2024-07-25T16:57:55Z

EP_TRIGGER_END

← Older revision		Revision as of 16:57, 25 July 2024
Line 104:		Line 104:

	===EP_TRIGGER_END===		===EP_TRIGGER_END===
	Just before an <code>EPrints::Repository</code> object is destroyed.		Just before an <code>EPrints::Repository</code> object is destroyed. (<font style="color: red;">Not currently implemented</font>).

	===EP_TRIGGER_DOC_URL_REWRITE===		===EP_TRIGGER_DOC_URL_REWRITE===