Editing Using Issues for Quality Control (section)

===Issues plugins===

The default EPrints Issues plugins can be found in ''perl_lib/EPrints/Plugin/Issues/''. Local repository plugins should be stored in ''archives/ARCHIVEID/cfg/plugins/EPrints/Plugin/Issues/''.

Each plugin receives a list of EPrints to test. Plugins can implement some or all of the following methods:

* '''process_item_in_list''' - record issues/details for whole list
* '''item_issues''' - return a list of issues for the given item
* '''process_at_end''' - add any additional issues after the list has been processed

If a plugin implements '''process_item_in_list'' this will be called for each item in the list, otherwise, '''item_issues''' will be called for each item in the list. '''process_at_end''' will be called after the whole list has been processed.

'''Example 1''' Use '''process_item_in_list''' to keep a record of all the titles encountered; check for duplicate titles in '''process_at_end''' and create issue for each matching item (code excerpts from the EPrints 3.1.3 default ExactTitleDups.pm plugin):

 sub process_item_in_list
 {
        ...
        my $title = $item->get_value( "title" );
        push @{$info->{titlemap}->{$title}}, $item->get_id;
 }
 
 sub process_at_end
 {
        ...
        foreach my $code ( keys %{$info->{titlemap}} )
        {
                my @set = @{$info->{titlemap}->{$code}};
                next unless scalar @set > 1;
                foreach my $id ( @set )
                {
                                ...
                                push @{$info->{issues}->{$id2}}, {
                                        type => "duplicate_title",
                                        id => "duplicate_title_$id",
                                        description => $desc,
                                };
                                ...
                }
        }
  }

'''Example 2''' Implement the item_issues method to check for PDF documents where the depositor has accidentally uploaded more than 1 file.

 sub item_issues
 {
        my( $plugin, $dataobj ) = @_;
  
        my @issues;
        foreach my $doc ( $dataobj->get_all_documents )
        {
                my $format = $doc->get_value( "format" );
                my %files = $doc->files;
                if( $format eq "application/pdf" && scalar keys %files > 1 )
                {
                        push @issues, {
                                id => "extra_files_" . $dataobj->get_id,
                                type => "extra_files",
                                description => "Extra files uploaded to PDF document",
                        };
                }
        }
        return @issues;
 }

[[Image:Issues_extra.png]]