# --
# Copyright (C) 2001-2021 OTRS AG, https://otrs.com/
# Copyright (C) 2021 Znuny GmbH, https://znuny.org/
# --
# This software comes with ABSOLUTELY NO WARRANTY. For details, see
# the enclosed file COPYING for license information (GPL). If you
# did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.
# --

use strict;
use warnings;
use utf8;

use vars (qw($Self));

use Kernel::System::PostMaster;

# get needed objects
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
my $TicketObject = $Kernel::OM->Get('Kernel::System::Ticket');

# get helper object
$Kernel::OM->ObjectParamAdd(
    'Kernel::System::UnitTest::Helper' => {
        RestoreDatabase => 1,
    },
);
my $HelperObject = $Kernel::OM->Get('Kernel::System::UnitTest::Helper');

# define needed variable
my $RandomID = $HelperObject->GetRandomID();
my %Jobs     = %{ $ConfigObject->Get('PostMaster::PreFilterModule') };

# create a dynamic field
my $FieldName = 'ExternalTNRecognition' . $RandomID;
my $FieldID   = $Kernel::OM->Get('Kernel::System::DynamicField')->DynamicFieldAdd(
    Name       => $FieldName,
    Label      => $FieldName . "_test",
    FieldOrder => 9991,
    FieldType  => 'Text',
    ObjectType => 'Ticket',
    Config     => {
        DefaultValue => 'a value',
    },
    ValidID => 1,
    UserID  => 1,
);

# verify dynamic field creation
$Self->True(
    $FieldID,
    "DynamicFieldAdd() successful for Field $FieldName",
);

my $ExternalTicketID = $HelperObject->GetRandomNumber();

# filter test
my @Tests = (
    {
        Name  => '#1 - From Test - Fail',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example.com>
Subject: An incident subject Incident-' . $ExternalTicketID . '

Some Content in Body',
        Check     => {},
        JobConfig => {
            DynamicFieldName     => $FieldName,
            FromAddressRegExp    => 'externalsystem@example.com',
            Module               => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name                 => 'Some Description',
            NumberRegExp         => '\\s*Incident-(\\d.*)\\s*',
            SearchInBody         => '1',
            SearchInSubject      => '1',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 1,
    },
    {
        Name  => '#2 - From Test Success',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example.com>
Subject: An incident subject Incident-' . $ExternalTicketID . '

Some Content in Body',
        Check => {
            "DynamicField_$FieldName" => $ExternalTicketID,
        },
        JobConfig => {
            DynamicFieldName     => $FieldName,
            FromAddressRegExp    => '\\s*@example.com',
            Module               => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name                 => 'Some Description',
            NumberRegExp         => '\\s*Incident-(\\d.*)\\s*',
            SearchInBody         => '1',
            SearchInSubject      => '1',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 1,
    },
    {
        Name  => '#3 - Subject Test - Fail',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example.com>
Subject: An incident subject Incident-' . $ExternalTicketID . '7

Some Content in Body',
        Check     => {},
        JobConfig => {
            DynamicFieldName     => $FieldName,
            FromAddressRegExp    => '\\s*@example.com',
            Module               => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name                 => 'Some Description',
            NumberRegExp         => '\\s*Incident-(\\d.*)\\s*',
            SearchInBody         => '1',
            SearchInSubject      => '1',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 1,
    },
    {
        Name  => '#4 - Subject Test - Fail',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example.com>
Subject: An incident subject Incident-' . $ExternalTicketID . '

Some Content in Body',
        Check     => {},
        JobConfig => {
            DynamicFieldName     => $FieldName,
            FromAddressRegExp    => '\\s*@example.com',
            Module               => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name                 => 'Some Description',
            NumberRegExp         => '\\s*Incident-(\\d.*)\\s*',
            SearchInBody         => '1',
            SearchInSubject      => '0',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 1,
    },
    {
        Name  => '#5 - Subject Test - Fail',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example.com>
Subject: An incident subject Incident-' . $ExternalTicketID . '

Some Content in Body',
        Check     => {},
        JobConfig => {
            DynamicFieldName     => $FieldName,
            FromAddressRegExp    => '\\s*@example.com',
            Module               => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name                 => 'Some Description',
            NumberRegExp         => '\\s*Report-(\\d.*)\\s*',
            SearchInBody         => '1',
            SearchInSubject      => '1',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 1,
    },
    {
        Name  => '#6 - Subject Test Success',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example.com>
Subject: An incident subject Incident-' . $ExternalTicketID . '

Some Content in Body',
        Check => {
            "DynamicField_$FieldName" => $ExternalTicketID,
        },
        JobConfig => {
            DynamicFieldName     => $FieldName,
            FromAddressRegExp    => '\\s*@example.com',
            Module               => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name                 => 'Some Description',
            NumberRegExp         => '\\s*Incident-(\\d.*)\\s*',
            SearchInBody         => '1',
            SearchInSubject      => '1',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 2,
    },
    {
        Name  => '#3 - Body Test - Fail',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example.com>
Subject: An incident subject

Some Content in Body Incident-' . $ExternalTicketID . '7',
        Check     => {},
        JobConfig => {
            DynamicFieldName     => $FieldName,
            FromAddressRegExp    => '\\s*@example.com',
            Module               => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name                 => 'Some Description',
            NumberRegExp         => '\\s*Incident-(\\d.*)\\s*',
            SearchInBody         => '1',
            SearchInSubject      => '1',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 2,
    },
    {
        Name  => '#4 - Body Test - Fail',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example.com>
Subject: An incident subject

Some Content in Body Incident-' . $ExternalTicketID,
        Check     => {},
        JobConfig => {
            DynamicFieldName     => $FieldName,
            FromAddressRegExp    => '\\s*@example.com',
            Module               => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name                 => 'Some Description',
            NumberRegExp         => '\\s*Incident-(\\d.*)\\s*',
            SearchInBody         => '0',
            SearchInSubject      => '1',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 1,
    },
    {
        Name  => '#5 - Body Test - Fail',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example.com>
Subject: An incident subject

Some Content in Body Incident-' . $ExternalTicketID,
        Check     => {},
        JobConfig => {
            DynamicFieldName     => $FieldName,
            FromAddressRegExp    => '\\s*@example.com',
            Module               => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name                 => 'Some Description',
            NumberRegExp         => '\\s*Report-(\\d.*)\\s*',
            SearchInBody         => '1',
            SearchInSubject      => '1',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 1,
    },
    {
        Name  => '#6 - Body Test Success',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example.com>
Subject: An incident subject

Some Content in Body Incident-' . $ExternalTicketID,
        Check => {
            "DynamicField_$FieldName" => $ExternalTicketID,
        },
        JobConfig => {
            DynamicFieldName     => $FieldName,
            FromAddressRegExp    => '\\s*@example.com',
            Module               => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name                 => 'Some Description',
            NumberRegExp         => '\\s*Incident-(\\d.*)\\s*',
            SearchInBody         => '1',
            SearchInSubject      => '1',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 2,
    },
    {
        Name =>
            '#7 - Body Test Success with Complex TicketNumber / Regex; special characters must be escaped in the regex',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example.com>
Subject: An incident subject

Some Content in Body Incident#/' . $ExternalTicketID,
        Check => {
            "DynamicField_$FieldName" => $ExternalTicketID,
        },
        JobConfig => {
            DynamicFieldName     => $FieldName,
            FromAddressRegExp    => '\\s*@example.com',
            Module               => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name                 => 'Some Description',
            NumberRegExp         => '\\s*Incident\#\/(\\d.*)\\s*',
            SearchInBody         => '1',
            SearchInSubject      => '1',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 2,
    },
    {
        Name =>
            '#8 - Bug#13961 - Using white space in regex',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example.com>
Subject: An incident subject

This is an update to incident ' . $ExternalTicketID . ' by mail',
        Check => {
            "DynamicField_$FieldName" => $ExternalTicketID,
        },
        JobConfig => {
            DynamicFieldName  => $FieldName,
            FromAddressRegExp => '\\s*@example.com',
            Module            => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name              => 'Some Description',

            NumberRegExp         => 'update to incident (\\d.*) by mail',
            SearchInBody         => '1',
            SearchInSubject      => '0',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 2,
    },

    # See bug#14363 - The regex in ExternalTicketnumberRecognitaion does not match
    # The first capturing group from the 'NumberRegExp' expression will be used as the ticket number value.
    {
        Name =>
            '#9 - Bug#14363 - more capturing group in the NumberRegExp expression',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example.com>
Subject: An incident subject

This is an update to incident ' . $ExternalTicketID . ' by mail',
        JobConfig => {
            DynamicFieldName  => $FieldName,
            FromAddressRegExp => '\\s*@example.com',
            Module            => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name              => 'Some Description',

            NumberRegExp         => 'Some test (\\d.*) by mail|update to incident (\\d.*) by mail',
            SearchInBody         => '1',
            SearchInSubject      => '0',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 1,
    },
    {
        Name =>
            '#10 - Bug#14363 - only one capturing group in regex - match in the body',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example.com>
Subject: An incident subject

This is an update to incident ' . $ExternalTicketID . ' by mail',
        Check => {
            "DynamicField_$FieldName" => $ExternalTicketID,
        },
        JobConfig => {
            DynamicFieldName  => $FieldName,
            FromAddressRegExp => '\\s*@example.com',
            Module            => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name              => 'Some Description',

            NumberRegExp         => '(?:Some test\\s|update to incident\\s)(\\d.*) by mail',
            SearchInBody         => '1',
            SearchInSubject      => '0',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 2,
    },
    {
        Name =>
            '#11 - Bug#14363 - only one capturing group in regex - match in the subject',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example.com>
Subject: An incident subject ' . $ExternalTicketID . '

This is an update to incident by mail',
        Check => {
            "DynamicField_$FieldName" => $ExternalTicketID,
        },
        JobConfig => {
            DynamicFieldName  => $FieldName,
            FromAddressRegExp => '\\s*@example.com',
            Module            => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name              => 'Some Description',

            NumberRegExp         => '(?:Some test\\s|incident subject\\s)(\\d.*)',
            SearchInBody         => '0',
            SearchInSubject      => '1',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 2,
    },
    {
        Name =>
            '#12 - Added option ToAddressRegExp - matching To',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example2.com>
Subject: An incident subject ' . $ExternalTicketID . '

This is an update to incident by mail',
        Check => {
            "DynamicField_$FieldName" => $ExternalTicketID,
        },
        JobConfig => {
            DynamicFieldName  => $FieldName,
            FromAddressRegExp => '\\s*@example.com',
            ToAddressRegExp   => '\\s*@example2.com',
            Module            => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name              => 'Some Description',

            NumberRegExp         => '(?:Some test\\s|incident subject\\s)(\\d.*)',
            SearchInBody         => '0',
            SearchInSubject      => '1',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 2,
    },
    {
        Name =>
            '#12 - Added option CcAddressRegExp - matching Cc',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example2.com>
Cc: Some Other Name <recipient@example3.com>
Subject: An incident subject ' . $ExternalTicketID . '

This is an update to incident by mail',
        Check => {
            "DynamicField_$FieldName" => $ExternalTicketID,
        },
        JobConfig => {
            DynamicFieldName  => $FieldName,
            FromAddressRegExp => '\\s*@example.com',
            ToAddressRegExp   => '\\s*@example2.com',
            CcAddressRegExp   => '\\s*@example3.com',
            Module            => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name              => 'Some Description',

            NumberRegExp         => '(?:Some test\\s|incident subject\\s)(\\d.*)',
            SearchInBody         => '0',
            SearchInSubject      => '1',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 2,
    },
    {
        Name =>
            '#13 - Added option ToAddressRegExp - non-matching To',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example999.com>
Subject: An incident subject ' . $ExternalTicketID . '

This is an update to incident by mail',
        Check => {
            "DynamicField_$FieldName" => undef,
        },
        JobConfig => {
            DynamicFieldName  => $FieldName,
            FromAddressRegExp => '\\s*@example.com',
            ToAddressRegExp   => '\\s*@example2.com',
            Module            => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name              => 'Some Description',

            NumberRegExp         => '(?:Some test\\s|incident subject\\s)(\\d.*)',
            SearchInBody         => '0',
            SearchInSubject      => '1',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 1,
    },
    {
        Name =>
            '#13 - Added option CcAddressRegExp - non-matching Cc',
        Email => 'From: Sender <sender@example.com>
To: Some Name <recipient@example2.com>
Cc: Some Name <recipient@example999.com>
Subject: An incident subject ' . $ExternalTicketID . '

This is an update to incident by mail',
        Check => {
            "DynamicField_$FieldName" => undef,
        },
        JobConfig => {
            DynamicFieldName  => $FieldName,
            FromAddressRegExp => '\\s*@example.com',
            ToAddressRegExp   => '\\s*@example2.com',
            CcAddressRegExp   => '\\s*@example3.com',
            Module            => 'Kernel::System::PostMaster::Filter::ExternalTicketNumberRecognition',
            Name              => 'Some Description',

            NumberRegExp         => '(?:Some test\\s|incident subject\\s)(\\d.*)',
            SearchInBody         => '0',
            SearchInSubject      => '1',
            SenderType           => 'system',
            IsVisibleForCustomer => 1,
            TicketStateTypes     => 'new;open',
        },
        NewTicket => 1,
    },
);

for my $Test (@Tests) {

    $ConfigObject->Set(
        Key   => 'PostMaster::PreFilterModule',
        Value => {},
    );

    $ConfigObject->Set(
        Key   => 'PostMaster::PreFilterModule',
        Value => {
            '00-ExternalTicketNumberRecognition1' => {
                %{ $Test->{JobConfig} }
            },
        },
    );

    my @Return;
    {
        my $CommunicationLogObject = $Kernel::OM->Create(
            'Kernel::System::CommunicationLog',
            ObjectParams => {
                Transport => 'Email',
                Direction => 'Incoming',
            },
        );
        $CommunicationLogObject->ObjectLogStart( ObjectLogType => 'Message' );

        my $PostMasterObject = Kernel::System::PostMaster->new(
            CommunicationLogObject => $CommunicationLogObject,
            Email                  => \$Test->{Email},
            Debug                  => 2,
        );

        @Return = $PostMasterObject->Run();

        $CommunicationLogObject->ObjectLogStop(
            ObjectLogType => 'Message',
            Status        => 'Successful',
        );
        $CommunicationLogObject->CommunicationStop(
            Status => 'Successful',
        );
    }

    $Self->Is(
        $Return[0] || 0,
        $Test->{NewTicket},
        "$Test->{Name}: Filter Run() - NewTicket",
    );
    $Self->True(
        $Return[1] || 0,
        "$Test->{Name}: Filter  Run() - NewTicket/TicketID",
    );
    my %Ticket = $TicketObject->TicketGet(
        TicketID      => $Return[1],
        DynamicFields => 1,
    );

    for my $Key ( sort keys %{ $Test->{Check} } ) {
        $Self->Is(
            $Ticket{$Key},
            $Test->{Check}->{$Key},
            "$Test->{Name}: Filter Run() - $Key",
        );
    }
}

# set back values for prefilter config
$ConfigObject->Set(
    Key   => 'PostMaster::PreFilterModule',
    Value => \%Jobs,
);

# cleanup is done by RestoreDatabase.

1;