Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue #2298 unit tests #2469

Merged
merged 2 commits into from
Aug 16, 2023
+164 −131
Merged

Issue #2298 unit tests #2469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a87a15f
Issue #2298: some tidying
bschmalhofer Aug 16, 2023
71e8595
Issue #2298: pass dynamic field values in _Mask() helpers
bschmalhofer Aug 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 67 additions & 64 deletions Kernel/Modules/AgentTicketEmailOutbound.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ package Kernel::Modules::AgentTicketEmailOutbound;
use strict;
use warnings;

# core modules

# CPAN modules

# OTOBO modules
use Kernel::System::VariableCheck qw(:all);
use Kernel::Language qw(Translatable);
use Mail::Address;
Expand All @@ -29,8 +34,7 @@ sub new {
my ( $Type, %Param ) = @_;

# allocate new hash for object
my $Self = {%Param};
bless( $Self, $Type );
my $Self = bless {%Param}, $Type;

# Try to load draft if requested.
if (
Expand Down Expand Up @@ -103,7 +107,7 @@ sub Run {

my $Output;

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

# get ACL restrictions
Expand Down Expand Up @@ -432,7 +436,6 @@ sub Form {

# check needed stuff
if ( !$Self->{TicketID} ) {

return $LayoutObject->ErrorScreen(
Message => Translatable('Got no TicketID!'),
Comment => Translatable('System Error!'),
Expand Down Expand Up @@ -464,7 +467,6 @@ sub Form {

# error screen, don't show ticket
if ( !$Access ) {

return $LayoutObject->NoPermission( WithHeader => 'yes' );
}

Expand All @@ -476,7 +478,6 @@ sub Form {
my @MultipleCustomerBcc = @{ $GetParamExtended{MultipleCustomerBcc} };

# get lock state
my $Output = '';
if ( $Config->{RequiredLock} ) {
if ( !$TicketObject->TicketLockGet( TicketID => $Self->{TicketID} ) ) {

Expand Down Expand Up @@ -517,19 +518,18 @@ sub Form {
OwnerID => $Self->{UserID},
);
if ( !$AccessOk ) {
my $Output = $LayoutObject->Header(
Type => 'Small',
BodyClass => 'Popup',
);
$Output .= $LayoutObject->Warning(
Message => Translatable('Sorry, you need to be the ticket owner to perform this action.'),
Comment => Translatable('Please change the owner first.'),
);
$Output .= $LayoutObject->Footer(
Type => 'Small',
);

return $Output;
return join '',
$LayoutObject->Header(
Type => 'Small',
BodyClass => 'Popup',
),
$LayoutObject->Warning(
Message => Translatable('Sorry, you need to be the ticket owner to perform this action.'),
Comment => Translatable('Please change the owner first.'),
),
$LayoutObject->Footer(
Type => 'Small',
);
}
else {
$LayoutObject->Block(
Expand All @@ -552,9 +552,8 @@ sub Form {
);
}

# Get selected or last customer article.
my %Data;

# Get selected article.
if ( $GetParam{ArticleID} ) {
my $ArticleBackendObject = $ArticleObject->BackendForArticle(
TicketID => $Self->{TicketID},
Expand All @@ -574,11 +573,10 @@ sub Form {
);
}
}

# Get the last customer article of the ticket.
else {
my $ArticleObject = $Kernel::OM->Get('Kernel::System::Ticket::Article');
my @MetaArticles = $ArticleObject->ArticleList(

# Get last customer article.
my @MetaArticles = $ArticleObject->ArticleList(
TicketID => $Self->{TicketID},
SenderType => 'customer',
OnlyLast => 1,
Expand Down Expand Up @@ -699,7 +697,6 @@ sub Form {

# load module
if ( !$Kernel::OM->Get('Kernel::System::Main')->Require( $Jobs{$Job}->{Module} ) ) {

return $LayoutObject->FatalError();
}
my $Object = $Jobs{$Job}->{Module}->new(
Expand All @@ -710,7 +707,6 @@ sub Form {
# get params
PARAMETER:
for my $Parameter ( $Object->Option( %GetParam, Config => $Jobs{$Job} ) ) {

if ( $Jobs{$Job}->{ParamType} && $Jobs{$Job}->{ParamType} ne 'Single' ) {
@{ $GetParam{$Parameter} } = $ParamObject->GetArray( Param => $Parameter );
next PARAMETER;
Expand Down Expand Up @@ -741,8 +737,8 @@ sub Form {

# cycle through the activated Dynamic Fields for this screen
DYNAMICFIELD:
for my $DynamicFieldConfig ( @{ $Self->{DynamicField} } ) {
next DYNAMICFIELD if !IsHashRefWithData($DynamicFieldConfig);
for my $DynamicFieldConfig ( $Self->{DynamicField}->@* ) {
next DYNAMICFIELD unless IsHashRefWithData($DynamicFieldConfig);

my $PossibleValuesFilter;

Expand Down Expand Up @@ -787,16 +783,17 @@ sub Form {
}

$DynamicFieldPossibleValues{ 'DynamicField_' . $DynamicFieldConfig->{Name} } = $PossibleValuesFilter;

}

# grep dynamic field values from ticket data
my %DFValues
= map { 'DynamicField_' . $_->{Name} => $Ticket{ 'DynamicField_' . $_->{Name} } } grep { $_->{ObjectType} eq 'Ticket' } $Self->{DynamicField}->@*;
# extract dynamic field values from ticket data
my %TicketDFValues =
map { 'DynamicField_' . $_->{Name} => $Ticket{ 'DynamicField_' . $_->{Name} } }
grep { $_->{ObjectType} eq 'Ticket' }
$Self->{DynamicField}->@*;

# build view ...
# start with page ...
$Output .= $LayoutObject->Header(
my $Output = $LayoutObject->Header(
Value => $Ticket{TicketNumber},
Type => 'Small',
BodyClass => 'Popup',
Expand Down Expand Up @@ -831,7 +828,7 @@ sub Form {
%Data,
%GetParam,
DFPossibleValues => \%DynamicFieldPossibleValues,
DFValues => \%DFValues,
DFValues => \%TicketDFValues,
);
$Output .= $LayoutObject->Footer(
Type => 'Small',
Expand Down Expand Up @@ -1076,7 +1073,7 @@ sub SendEmail {
# get ticket object
my $TicketObject = $Kernel::OM->Get('Kernel::System::Ticket');

# prepare subject
# get information on the current ticket
my %Ticket = $TicketObject->TicketGet(
TicketID => $Self->{TicketID},
DynamicFields => 1,
Expand Down Expand Up @@ -1152,7 +1149,6 @@ sub SendEmail {
);

if ( !IsHashRefWithData($ValidationResult) ) {

return $LayoutObject->ErrorScreen(
Message =>
$LayoutObject->{LanguageObject}->Translate( 'Could not perform validation on field %s!', $DynamicFieldConfig->{Label} ),
Expand Down Expand Up @@ -1195,7 +1191,7 @@ sub SendEmail {
$Error{ $Line . 'Invalid' } = 'ServerError';
}
my $IsLocal = $Kernel::OM->Get('Kernel::System::SystemAddress')->SystemAddressIsLocalAddress(
Address => $Email->address()
Address => $Email->address(),
);
if ($IsLocal) {
$Error{ $Line . 'IsLocalAddress' } = 'ServerError';
Expand All @@ -1217,7 +1213,6 @@ sub SendEmail {

# run compose modules
my %ArticleParam;

if ( ref( $ConfigObject->Get('Ticket::Frontend::ArticleComposeModule') ) eq 'HASH' ) {
my %Jobs = %{ $ConfigObject->Get('Ticket::Frontend::ArticleComposeModule') };
for my $Job ( sort keys %Jobs ) {
Expand Down Expand Up @@ -1249,7 +1244,7 @@ sub SendEmail {
$Object->Run(
%GetParam,
StoreNew => 1,
Config => $Jobs{$Job}
Config => $Jobs{$Job},
);

# get options that have been removed from the selection
Expand All @@ -1274,22 +1269,36 @@ sub SendEmail {
# ticket params
%ArticleParam = (
%ArticleParam,
$Object->ArticleOption( %GetParam, %ArticleParam, Config => $Jobs{$Job} ),
$Object->ArticleOption(
%GetParam,
%ArticleParam,
Config => $Jobs{$Job},
),
);

# get errors
%Error = (
%Error,
$Object->Error( %GetParam, Config => $Jobs{$Job} ),
$Object->Error(
%GetParam,
Config => $Jobs{$Job},
),
);
}
}

# check if there is an error
# Check whether there is an error.
# An error is not necessarily bad, often it is just that a form draft has been loaded.
if (%Error) {

my $QueueID = $TicketObject->TicketQueueID( TicketID => $Self->{TicketID} );
my $Output = $LayoutObject->Header(

# extract dynamic field values from ticket data
my %TicketDFValues =
map { 'DynamicField_' . $_->{Name} => $Ticket{ 'DynamicField_' . $_->{Name} } }
grep { $_->{ObjectType} eq 'Ticket' }
$Self->{DynamicField}->@*;

my $Output = $LayoutObject->Header(
Type => 'Small',
BodyClass => 'Popup',
);
Expand Down Expand Up @@ -1323,10 +1332,12 @@ sub SendEmail {
%GetParam,
DFPossibleValues => \%DynamicFieldPossibleValues,
DFErrors => \%DynamicFieldValidationResult,
DFValues => \%TicketDFValues,
);
$Output .= $LayoutObject->Footer(
Type => 'Small',
);

return $Output;
}

Expand Down Expand Up @@ -1354,7 +1365,6 @@ sub SendEmail {

# remove unused inline images
my @NewAttachmentData;

ATTACHMENT:
for my $Attachment (@AttachmentData) {
my $ContentID = $Attachment->{ContentID};
Expand Down Expand Up @@ -1384,7 +1394,6 @@ sub SendEmail {

# send email
my $To = '';

KEY:
for my $Key (qw(To Cc Bcc)) {
next KEY if !$GetParam{$Key};
Expand Down Expand Up @@ -1428,7 +1437,6 @@ sub SendEmail {

# error page
if ( !$ArticleID ) {

return $LayoutObject->ErrorScreen(
Comment => Translatable('Please contact the administrator.'),
);
Expand Down Expand Up @@ -1556,13 +1564,12 @@ sub AjaxUpdate {

my @ExtendedData;

# get config object
# get needed objects
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');

# run compose modules
if ( ref $ConfigObject->Get('Ticket::Frontend::ArticleComposeModule') eq 'HASH' ) {
my %Jobs = %{ $ConfigObject->Get('Ticket::Frontend::ArticleComposeModule') };

JOB:
for my $Job ( sort keys %Jobs ) {

Expand Down Expand Up @@ -1608,8 +1615,7 @@ sub AjaxUpdate {

my $Key = $Object->Option( %GetParam, Config => $Jobs{$Job} );
if ($Key) {
push(
@ExtendedData,
push @ExtendedData,
{
Name => $Key,
Data => \%Data,
Expand All @@ -1618,8 +1624,7 @@ sub AjaxUpdate {
PossibleNone => 1,
Multiple => $Multiple,
Max => 100,
}
);
};
}
}
}
Expand Down Expand Up @@ -1666,6 +1671,9 @@ sub AjaxUpdate {
# update Dynamic Fields Possible Values via AJAX
my @DynamicFieldAJAX;

# get ticket object
my $TicketObject = $Kernel::OM->Get('Kernel::System::Ticket');

# cycle through the activated Dynamic Fields for this screen
DYNAMICFIELD:
for my $DynamicFieldConfig ( @{ $Self->{DynamicField} } ) {
Expand All @@ -1685,9 +1693,6 @@ sub AjaxUpdate {
my %AclData = %{$PossibleValues};
@AclData{ keys %AclData } = keys %AclData;

# get ticket object
my $TicketObject = $Kernel::OM->Get('Kernel::System::Ticket');

# set possible values filter from ACLs
my $ACL = $TicketObject->TicketAcl(
%GetParam,
Expand All @@ -1714,16 +1719,14 @@ sub AjaxUpdate {
) || $PossibleValues;

# add dynamic field to the list of fields to update
push(
@DynamicFieldAJAX,
push @DynamicFieldAJAX,
{
Name => 'DynamicField_' . $DynamicFieldConfig->{Name},
Data => $DataValues,
SelectedID => $DynamicFieldValues{ $DynamicFieldConfig->{Name} },
Translation => $DynamicFieldConfig->{Config}->{TranslatableValues} || 0,
Max => 100,
}
);
};
}

my $JSON = $LayoutObject->BuildSelectionJSON(
Expand Down Expand Up @@ -1803,7 +1806,9 @@ sub _Mask {
# prepare errors!
if ( $Param{Errors} ) {
for my $Error ( sort keys %{ $Param{Errors} } ) {
$Param{$Error} = $LayoutObject->Ascii2Html( Text => $Param{Errors}->{$Error} );
$Param{$Error} = $LayoutObject->Ascii2Html(
Text => $Param{Errors}->{$Error},
);
}
}

Expand Down Expand Up @@ -1958,8 +1963,6 @@ sub _Mask {
);
}

my $DynamicFieldObject = $Kernel::OM->Get('Kernel::System::DynamicField');

# render dynamic fields
{
my %DynamicFieldConfigs = map { $_->{Name} => $_ } $Self->{DynamicField}->@*;
Expand Down
Loading