#!/usr/bin/perl

# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <https://www.gnu.org/licenses>.

use Modern::Perl;
use MARC::Record;
use Test::NoWarnings;
use Test::MockModule;
use Test::More tests => 5;
use Test::Warn;

use t::lib::TestBuilder;
use t::lib::Mocks;

use Koha::Database;
use C4::Matcher;
use C4::AuthoritiesMarc qw(AddAuthority);

my $schema  = Koha::Database->new->schema;
my $builder = t::lib::TestBuilder->new;
$schema->storage->txn_begin;

subtest 'GetMatcherList' => sub {
    plan tests => 9;

    $schema->resultset('MarcMatcher')->delete_all;
    my $matcher1 = $builder->build(
        {
            source => 'MarcMatcher',
            value  => { code => 'ISBN', description => 'ISBN', record_type => 'red', threshold => 1 },
        }
    );
    my $matcher2 = $builder->build(
        {
            source => 'MarcMatcher',
            value  => { code => 'ISSN', description => 'ISSN', record_type => 'blue', threshold => 0 },
        }
    );

    my @matchers = C4::Matcher::GetMatcherList();
    is( $matchers[0]->{'matcher_id'}, $matcher1->{matcher_id}, 'First matcher_id value' );
    is( $matchers[1]->{'matcher_id'}, $matcher2->{matcher_id}, 'Second matcher_id value' );

    my $matcher_id = C4::Matcher::GetMatcherId('ISBN');
    is( $matcher_id, $matcher1->{matcher_id}, 'testing getmatcherid' );

    my $testmatcher;
    ok( $testmatcher = C4::Matcher->new( 'red',  1 ), 'testing matcher new' );
    ok( $testmatcher = C4::Matcher->new( 'blue', 0 ), 'testing matcher new' );

    $testmatcher->threshold(1000);
    is( $testmatcher->threshold(), 1000, 'testing threshold accessor method' );

    $testmatcher->_id(53);
    is( $testmatcher->_id(), 53, 'testing _id accessor' );

    $testmatcher->code('match on ISBN');
    is( $testmatcher->code(), 'match on ISBN', 'testing code accessor' );

    $testmatcher->description('match on ISSN');
    is( $testmatcher->description(), 'match on ISSN', 'testing code accessor' );
};

subtest '_get_match_keys() tests' => sub {
    plan tests => 21;

    my $matchpoint = get_title_matchpoint(
        {
            length => 0,
            norms  => ['legacy_default'],
            offset => 0
        }
    );

    my $record = MARC::Record->new();
    $record->append_fields(
        MARC::Field->new(
            '020', '1', ' ',
            a => '978-1451697216 (alk. paper)'
        ),
        MARC::Field->new(
            '020', '1', ' ',
            a => '145169721X (alk. paper)'
        ),
        MARC::Field->new(
            '020', '1', ' ',
            a => '1NOTISBN3'
        ),
        MARC::Field->new(
            '100', '1', ' ',
            a => 'King, Stephen',
            d => 'd1947-'
        ),
        MARC::Field->new(
            '245', ' ', ' ',
            a => '  .; thE t[]:,alias(m)/An\'"',
            c => 'Stephen King, Peter Straub.'
        ),
        MARC::Field->new(
            '700', ' ', ' ',
            a => 'Straub, Peter',
            d => '1943-'
        )
    );

    my @keys = C4::Matcher::_get_match_keys( $record, $matchpoint );

    is(
        $keys[0], 'THE TALIASMAN STEPHEN KING PETER STRAUB',
        'Match key correctly calculated with no $norms'
    );

    $matchpoint = get_title_matchpoint(
        {
            length => 9,
            norms  => ['legacy_default'],
            offset => 0
        }
    );
    @keys = C4::Matcher::_get_match_keys( $record, $matchpoint );
    is(
        $keys[0], 'THE',
        'Match key correctly calculated with length 9'
    );

    $matchpoint = get_title_matchpoint(
        {
            length => 9,
            norms  => ['legacy_default'],
            offset => 1
        }
    );
    @keys = C4::Matcher::_get_match_keys( $record, $matchpoint );
    is(
        $keys[0], 'THE T',
        'Match key correctly calculated with length 9 and offset 1'
    );

    $matchpoint = get_title_matchpoint(
        {
            length => 9,
            norms  => ['legacy_default'],
            offset => 2
        }
    );
    @keys = C4::Matcher::_get_match_keys( $record, $matchpoint );
    is(
        $keys[0], 'THE T',
        'Match key correctly calculated with length 9 and offset 2, should not remove space'
    );

    $matchpoint = get_authors_matchpoint(
        {
            length => 0,
            norms  => ['legacy_default'],
            offset => 0
        }
    );
    @keys = C4::Matcher::_get_match_keys( $record, $matchpoint );
    is(
        $keys[0], 'STRAUB PETER KING STEPHEN',
        'Match key correctly calculated with multiple components'
    );

    $matchpoint = get_authors_matchpoint(
        {
            length => 9,
            norms  => ['legacy_default'],
            offset => 0
        }
    );
    @keys = C4::Matcher::_get_match_keys( $record, $matchpoint );
    is(
        $keys[0], 'STRAUB P KING STE',
        'Match key correctly calculated with multiple components, length 9'
    );

    $matchpoint = get_authors_matchpoint(
        {
            length => 10,
            norms  => ['legacy_default'],
            offset => 0
        }
    );
    @keys = C4::Matcher::_get_match_keys( $record, $matchpoint );
    is(
        $keys[0], 'STRAUB PE KING STEP',
        'Match key correctly calculated with multiple components, length 10'
    );

    $matchpoint = get_authors_matchpoint(
        {
            length => 10,
            norms  => ['legacy_default'],
            offset => 2
        }
    );
    @keys = C4::Matcher::_get_match_keys( $record, $matchpoint );
    is(
        $keys[0], 'RAUB PETE NG STEPHE',
        'Match key correctly calculated with multiple components, length 10, offset 1'
    );

    $matchpoint = get_title_matchpoint(
        {
            length => 0,
            norms  => [ 'none', 'none' ],
            offset => 0
        }
    );
    @keys = C4::Matcher::_get_match_keys( $record, $matchpoint );
    is(
        $keys[0], '  .; thE t[]:,alias(m)/An\'" Stephen King, Peter Straub.',
        'Match key intact if \'none\' specified, length 0 and offset 0'
    );

    $matchpoint = get_authors_matchpoint(
        {
            length => 0,
            norms  => ['upper_case'],
            offset => 0
        }
    );
    @keys = C4::Matcher::_get_match_keys( $record, $matchpoint );
    is(
        $keys[0], 'STRAUB, PETER KING, STEPHEN',
        'Match key correctly calculated with multiple components, \'upper_case\' norm'
    );

    $matchpoint = get_authors_matchpoint(
        {
            length => 0,
            norms  => ['lower_case'],
            offset => 0
        }
    );
    @keys = C4::Matcher::_get_match_keys( $record, $matchpoint );
    is(
        $keys[0], 'straub, peter king, stephen',
        'Match key correctly calculated with multiple components, \'lower_case\' norm'
    );

    $matchpoint = get_authors_matchpoint(
        {
            length => 0,
            norms  => ['remove_spaces'],
            offset => 0
        }
    );
    @keys = C4::Matcher::_get_match_keys( $record, $matchpoint );
    is(
        $keys[0], 'Straub,Peter King,Stephen',
        'Match key correctly calculated with multiple components, \'remove_spaces\' norm'
    );

    $matchpoint = get_authors_matchpoint(
        {
            length => 0,
            norms  => [ 'remove_spaces', 'lower_case' ],
            offset => 0
        }
    );
    @keys = C4::Matcher::_get_match_keys( $record, $matchpoint );
    is(
        $keys[0], 'straub,peter king,stephen',
        'Match key correctly calculated with multiple components, \'remove_spaces\' and \'lower_case\' norm'
    );

    my $norm = 'unknown_norm';
    $matchpoint = get_title_matchpoint(
        {
            length => 0,
            norms  => [$norm],
            offset => 0
        }
    );
    warning_is { @keys = C4::Matcher::_get_match_keys( $record, $matchpoint ) }
    qq{Invalid normalization routine required ($norm)},
        'Passing an invalid normalization routine name raises a warning';

    is(
        $keys[0], '  .; thE t[]:,alias(m)/An\'" Stephen King, Peter Straub.',
        'Match key intact if invalid normalization routine specified'
    );

    $matchpoint = get_title_matchpoint(
        {
            length => 0,
            norms  => [ $norm, 'upper_case' ],
            offset => 0
        }
    );
    warning_is { @keys = C4::Matcher::_get_match_keys( $record, $matchpoint ) }
    qq{Invalid normalization routine required ($norm)},
        'Passing an invalid normalization routine name raises a warning';

    is(
        $keys[0], '  .; THE T[]:,ALIAS(M)/AN\'" STEPHEN KING, PETER STRAUB.',
        'Match key correctly normalized if invalid normalization routine specified'
    );

    $matchpoint = get_isbn_matchpoint(
        {
            length => 0,
            norms  => ['ISBN'],
            offset => 0
        }
    );
    @keys = C4::Matcher::_get_match_keys( $record, $matchpoint );
    is(
        $keys[0], '9781451697216',
        'Match key correctly calculated as ISBN13 when ISBN normalizer used'
    );
    is(
        $keys[1], '9781451697216',
        'Match key correctly calculated as ISBN13 when ISBN normalizer used'
    );
    is(
        $keys[2], '1NOTISBN3',
        'Match key passed through if not an isbn when ISBN normalizer used'
    );

    $matchpoint = get_title_matchpoint(
        {
            length => 0,
            offset => 0
        }
    );
    delete $matchpoint->{component}->{subfields};
    @keys = C4::Matcher::_get_match_keys( $record, $matchpoint );
    is(
        $keys[0], '  .; thE t[]:,alias(m)/An\'" Stephen King, Peter Straub.',
        "Match key correctly returns whole field if no subfields specified"
    );
};

subtest '_get_match_keys() leader tests' => sub {
    plan tests => 2;
    my $record     = MARC::Record->new();
    my $matchpoint = get_leader_matchpoint(
        {
            length => 1,
            offset => 6,
        }
    );

    my @keys = C4::Matcher::_get_match_keys( $record, $matchpoint );
    is( $keys[0], ' ', 'Match key correctly calculated as " " from LDR6 when no leader available' );

    $record->leader('01344cam a22003014a 4500');

    @keys = C4::Matcher::_get_match_keys( $record, $matchpoint );
    is( $keys[0], 'a', 'Match key correctly calculated as "a" from LDR6' );
};

subtest 'get_matches bad record test' => sub {
    plan tests => 6;

    # First we need to generate a bad record
    my $record = MARC::Record->new();
    $record->append_fields( MARC::Field->new( '100', '1', '2', a => 'Name' ) );
    $record->append_fields( MARC::Field->new( '040', '',  '',  c => 'Test' ) );
    my $type   = $builder->build( { source => 'AuthType', value => { auth_tag_to_report => '100' } } );
    my $authid = C4::AuthoritiesMarc::AddAuthority(
        $record, undef,
        $type->{authtypecode}
    );
    my $dbh = C4::Context->dbh;
    my $sth = $dbh->prepare(
        q|UPDATE auth_header  SET marcxml = UpdateXML(marcxml, '//datafield[@tag="040"]/subfield[@code="c"]',CONCAT('<subfield code',CHAR(27),'="c">OSt</subfield>')) WHERE auth_header.authid=?|
    );
    $sth->execute( ($authid) );

    # Now we need to mock the search routines to ensure we get a result match
    t::lib::Mocks::mock_preference( 'SearchEngine', 'Elasticsearch' );

    #we aren't testing search, just need to be consistent to mock
    my $mock_searcher = Test::MockModule->new('Koha::SearchEngine::Elasticsearch::Search');
    $mock_searcher->mock(
        'search_auth_compat',
        sub {
            return [ { authid => $authid } ];
        }
    );

    # Now we create a matcher and fill the matchpoints
    my $matcher_db = $builder->build(
        {
            source => 'MarcMatcher',
            value  => { record_type => 'authority', threshold => 1 },
        }
    );
    my $matcher_object = C4::Matcher->fetch( $matcher_db->{matcher_id} );
    $matcher_object->{matchpoints} = [ get_authority_matchpoint() ];

    # Recoverable case: bad XML characters are stripped and the record is returned
    my @results;
    warnings_like {
        @results = $matcher_object->get_matches( $record, 1 );
    }
    [qr/Error parsing matched authority record /], "Record with bad XML characters handled";
    is( scalar(@results),         1,       "Recovered record is returned to the caller" );
    is( $results[0]->{record_id}, $authid, "Recovered record carries the expected authid" );

    # Unrecoverable case: record_strip_nonxml also fails, record must be skipped silently
    my $mock_authority = Test::MockModule->new('Koha::Authority');
    $mock_authority->mock( 'record_strip_nonxml', sub { return; } );
    warnings_like {
        @results = $matcher_object->get_matches( $record, 1 );
    }
    [qr/Error parsing matched authority record /],
        "Unrecoverable record still emits the parse warning";
    is( scalar(@results), 0, "Unrecoverable record is skipped from results" );
    $mock_authority->unmock('record_strip_nonxml');

    # Stale search index: the authid no longer exists in the database
    $mock_searcher->mock(
        'search_auth_compat',
        sub {
            return [ { authid => 0 } ];
        }
    );
    @results = $matcher_object->get_matches( $record, 1 );
    is( scalar(@results), 0, "Stale authid pointing at a missing record is skipped without dying" );
};

sub get_title_matchpoint {
    my $params = shift;

    my $length = $params->{length} // 0;
    my $norms  = $params->{norms}  // [];
    my $offset = $params->{offset} // 0;

    my $matchpoint = {
        components => [
            {
                length    => $length,
                norms     => $norms,
                offset    => $offset,
                subfields => {
                    a => 1,
                    c => 1
                },
                tag => '245'
            }
        ],
        index => "title",
        score => 1000
    };

    return $matchpoint;
}

sub get_authority_matchpoint {
    my $params = shift;

    my $length = $params->{length} // 0;
    my $norms  = $params->{norms}  // [];
    my $offset = $params->{offset} // 0;

    my $matchpoint = {
        components => [
            {
                length    => $length,
                norms     => $norms,
                offset    => $offset,
                subfields => { a => 1 },
                tag       => '100'
            }
        ],
        index => "match-heading",
        score => 1000
    };

    return $matchpoint;
}

sub get_authors_matchpoint {
    my $params = shift;

    my $length = $params->{length} // 0;
    my $norms  = $params->{norms}  // [];
    my $offset = $params->{offset} // 0;

    my $matchpoint = {
        components => [
            {
                length    => $length,
                norms     => $norms,
                offset    => $offset,
                subfields => { a => 1 },
                tag       => '700'
            },
            {
                length    => $length,
                norms     => $norms,
                offset    => $offset,
                subfields => { a => 1 },
                tag       => '100'
            }
        ],
        index => "author",
        score => 1000
    };

    return $matchpoint;
}

sub get_isbn_matchpoint {
    my $params = shift;

    my $length = $params->{length} // 0;
    my $norms  = $params->{norms}  // [];
    my $offset = $params->{offset} // 0;

    my $matchpoint = {
        components => [
            {
                length    => $length,
                norms     => $norms,
                offset    => $offset,
                subfields => { a => 1 },
                tag       => '020'
            },
        ],
        index => "isbn",
        score => 1000
    };

    return $matchpoint;
}

sub get_leader_matchpoint {
    my $params = shift;
    my $length = $params->{length} // 0;
    my $norms  = $params->{norms}  // [];
    my $offset = $params->{offset} // 0;

    my $matchpoint = {
        components => [
            {
                length => $length,
                norms  => $norms,
                offset => $offset,
                tag    => 'LDR'
            },
        ],
    };

    return $matchpoint;
}

$schema->storage->txn_rollback;