This commit is contained in:
2024-10-14 00:08:40 +02:00
parent dbfba56f66
commit 1462d52e13
4572 changed files with 2658864 additions and 0 deletions

View File

@@ -0,0 +1,182 @@
# --
# Copyright (C) 2001-2019 OTRS AG, https://otrs.com/
# --
# 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.
# --
package Kernel::Output::HTML::TicketZoom::Customer::Base;
use strict;
use warnings;
use Digest::MD5 qw(md5_hex);
use Kernel::System::VariableCheck qw(IsHashRefWithData);
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::Output::HTML::Layout',
'Kernel::System::DynamicField',
'Kernel::System::DynamicField::Backend',
'Kernel::System::Log',
'Kernel::System::Ticket::Article',
);
sub new {
my ( $Type, %Param ) = @_;
# allocate new hash for object
my $Self = {};
bless( $Self, $Type );
return $Self;
}
=head2 ArticleRender()
Returns article html.
my $HTML = $ArticleBaseObject->ArticleRender(
TicketID => 123, # (required)
ArticleID => 123, # (required)
ShowBrowserLinkMessage => 1, # (optional) Default: 0.
ArticleActions => [], # (optional)
);
Result:
$HTML = "<div>...</div>";
=cut
sub ArticleRender {
die 'Virtual method in base class must not be called.';
}
=head2 ArticleMetaFields()
Returns common fields for any article.
my %ArticleMetaFields = $ArticleBaseObject->ArticleMetaFields(
TicketID => 123, # (required)
ArticleID => 123, # (required)
);
Returns:
%ArticleMetaFields = (
DynamicField_Item => {
Label => 'Item', # mandatory
Value => 'Value', # mandatory
Link => 'http://...', # optional
},
AccountedTime => {
...
},
);
=cut
sub ArticleMetaFields {
my ( $Self, %Param ) = @_;
# Check needed stuff.
for my $Needed (qw(TicketID ArticleID)) {
if ( !$Param{$Needed} ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "Need $Needed!",
);
return;
}
}
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
my $ArticleObject = $Kernel::OM->Get('Kernel::System::Ticket::Article');
my $LayoutObject = $Kernel::OM->Get('Kernel::Output::HTML::Layout');
my $BackendObject = $Kernel::OM->Get('Kernel::System::DynamicField::Backend');
my %Result;
# show accounted article time
if ( $ConfigObject->Get('Ticket::Frontend::CustomerTicketZoom')->{ZoomTimeDisplay} ) {
my $ArticleTime = $ArticleObject->ArticleAccountedTimeGet(
ArticleID => $Param{ArticleID},
);
if ($ArticleTime) {
$Result{Time} = {
Label => "Time",
Value => $ArticleTime,
};
}
}
# get dynamic field config for frontend module
my $DynamicFieldFilter = {
%{ $ConfigObject->Get("Ticket::Frontend::CustomerTicketZoom")->{DynamicField} || {} },
# TODO: Check if there are process dynamic fields for customer interface
# %{
# $ConfigObject->Get("Ticket::Frontend::CustomerTicketZoom")->{ProcessWidgetDynamicField}
# || {}
# },
};
# get the dynamic fields for article object
my $DynamicField = $Kernel::OM->Get('Kernel::System::DynamicField')->DynamicFieldListGet(
Valid => 1,
ObjectType => ['Article'],
FieldFilter => $DynamicFieldFilter || {},
);
my $DynamicFieldBackendObject = $Kernel::OM->Get('Kernel::System::DynamicField::Backend');
# cycle trough the activated Dynamic Fields
DYNAMICFIELD:
for my $DynamicFieldConfig ( @{$DynamicField} ) {
next DYNAMICFIELD if !IsHashRefWithData($DynamicFieldConfig);
# skip the dynamic field if is not desinged for customer interface
my $IsCustomerInterfaceCapable = $BackendObject->HasBehavior(
DynamicFieldConfig => $DynamicFieldConfig,
Behavior => 'IsCustomerInterfaceCapable',
);
next DYNAMICFIELD if !$IsCustomerInterfaceCapable;
my $Value = $DynamicFieldBackendObject->ValueGet(
DynamicFieldConfig => $DynamicFieldConfig,
ObjectID => $Param{ArticleID},
);
next DYNAMICFIELD if !$Value;
next DYNAMICFIELD if $Value eq '';
# get print string for this dynamic field
my $ValueStrg = $DynamicFieldBackendObject->DisplayValueRender(
DynamicFieldConfig => $DynamicFieldConfig,
Value => $Value,
ValueMaxChars => 160,
LayoutObject => $LayoutObject,
);
my $Label = $DynamicFieldConfig->{Label};
$Result{ $DynamicFieldConfig->{Name} } = {
Label => $Label,
Value => $ValueStrg->{Value},
Title => $ValueStrg->{Title},
};
if ( $ValueStrg->{Link} ) {
$Result{ $DynamicFieldConfig->{Name} }->{Link} = $ValueStrg->{Link};
}
if ( $ValueStrg->{LinkPreview} ) {
$Result{ $DynamicFieldConfig->{Name} }->{LinkPreview} = $ValueStrg->{LinkPreview};
}
}
return %Result;
}
1;

View File

@@ -0,0 +1,130 @@
# --
# Copyright (C) 2001-2019 OTRS AG, https://otrs.com/
# --
# 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.
# --
package Kernel::Output::HTML::TicketZoom::Customer::Chat;
use parent 'Kernel::Output::HTML::TicketZoom::Customer::Base';
use strict;
use warnings;
use Kernel::System::VariableCheck qw(IsPositiveInteger);
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::Output::HTML::Layout',
'Kernel::System::CommunicationChannel',
'Kernel::System::Main',
'Kernel::System::Log',
'Kernel::System::Ticket::Article',
'Kernel::Output::HTML::Article::MIMEBase',
);
=head2 ArticleRender()
Returns article html.
my $HTML = $ArticleBaseObject->ArticleRender(
TicketID => 123, # (required)
ArticleID => 123, # (required)
Class => 'Visible', # (optional)
ShowBrowserLinkMessage => 1, # (optional) Default: 0.
ArticleActions => [], # (optional)
);
Result:
$HTML = "<div>...</div>";
=cut
sub ArticleRender {
my ( $Self, %Param ) = @_;
# Check needed stuff.
for my $Needed (qw(TicketID ArticleID)) {
if ( !$Param{$Needed} ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "Need $Needed!",
);
return;
}
}
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
my $LayoutObject = $Kernel::OM->Get('Kernel::Output::HTML::Layout');
my $MainObject = $Kernel::OM->Get('Kernel::System::Main');
my $ArticleBackendObject = $Kernel::OM->Get('Kernel::System::Ticket::Article')->BackendForArticle(%Param);
my %Article = $ArticleBackendObject->ArticleGet(
%Param,
RealNames => 1,
);
if ( !%Article ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "Article not found (ArticleID=$Param{ArticleID})!"
);
return;
}
# Get channel specific fields
my %ArticleFields = $LayoutObject->ArticleFields(%Param);
# Get dynamic fields and accounted time
my %ArticleMetaFields = $Self->ArticleMetaFields(%Param);
my $RichTextEnabled = $ConfigObject->Get('Ticket::Frontend::ZoomRichTextForce')
|| $LayoutObject->{BrowserRichText}
|| 0;
# Check if HTML should be displayed.
my $ShowHTML = $ConfigObject->Get('Ticket::Frontend::ZoomRichTextForce')
|| $LayoutObject->{BrowserRichText}
|| 0;
my $ArticleContent = $LayoutObject->ArticlePreview(
%Param,
ResultType => $ShowHTML ? 'HTML' : 'plain',
);
if ( !$ShowHTML ) {
# html quoting
$ArticleContent = $LayoutObject->Ascii2Html(
NewLine => $ConfigObject->Get('DefaultViewNewLine'),
Text => $ArticleContent,
VMax => $ConfigObject->Get('DefaultViewLines') || 5000,
HTMLResultMode => 1,
LinkFeature => 1,
);
}
my %CommunicationChannel = $Kernel::OM->Get('Kernel::System::CommunicationChannel')->ChannelGet(
ChannelID => $Article{CommunicationChannelID},
);
my $Content = $LayoutObject->Output(
TemplateFile => 'CustomerTicketZoom/ArticleRender/Chat',
Data => {
%Article,
ArticleFields => \%ArticleFields,
ArticleMetaFields => \%ArticleMetaFields,
Body => $ArticleContent,
HTML => $ShowHTML,
CommunicationChannel => $CommunicationChannel{DisplayName},
ChannelIcon => $CommunicationChannel{DisplayIcon},
Class => $Param{Class},
Age => $Param{ArticleAge},
},
);
return $Content;
}
1;

View File

@@ -0,0 +1,20 @@
# --
# Copyright (C) 2001-2019 OTRS AG, https://otrs.com/
# --
# 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.
# --
package Kernel::Output::HTML::TicketZoom::Customer::Email;
use strict;
use warnings;
use parent 'Kernel::Output::HTML::TicketZoom::Customer::MIMEBase';
our @ObjectDependencies = (
);
1;

View File

@@ -0,0 +1,20 @@
# --
# Copyright (C) 2001-2019 OTRS AG, https://otrs.com/
# --
# 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.
# --
package Kernel::Output::HTML::TicketZoom::Customer::Internal;
use strict;
use warnings;
use parent 'Kernel::Output::HTML::TicketZoom::Customer::MIMEBase';
our @ObjectDependencies = (
);
1;

View File

@@ -0,0 +1,121 @@
# --
# Copyright (C) 2001-2019 OTRS AG, https://otrs.com/
# --
# 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.
# --
package Kernel::Output::HTML::TicketZoom::Customer::Invalid;
use parent 'Kernel::Output::HTML::TicketZoom::Customer::Base';
use strict;
use warnings;
use Kernel::System::VariableCheck qw(IsPositiveInteger);
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::Output::HTML::Layout',
'Kernel::System::CommunicationChannel',
'Kernel::System::Main',
'Kernel::System::Log',
'Kernel::System::Ticket::Article',
'Kernel::Output::HTML::Article::MIMEBase',
);
=head2 ArticleRender()
Returns article HTML.
my $HTML = $ArticleBaseObject->ArticleRender(
TicketID => 123, # (required)
ArticleID => 123, # (required)
Class => 'Visible', # (optional)
ShowBrowserLinkMessage => 1, # (optional) Default: 0.
ArticleActions => [], # (optional)
);
Result:
$HTML = "<div>...</div>";
=cut
sub ArticleRender {
my ( $Self, %Param ) = @_;
for my $Needed (qw(TicketID ArticleID)) {
if ( !$Param{$Needed} ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "Need $Needed!",
);
return;
}
}
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
my $LayoutObject = $Kernel::OM->Get('Kernel::Output::HTML::Layout');
my $MainObject = $Kernel::OM->Get('Kernel::System::Main');
my $ArticleBackendObject = $Kernel::OM->Get('Kernel::System::Ticket::Article')->BackendForArticle(%Param);
my %Article = $ArticleBackendObject->ArticleGet(
%Param,
RealNames => 1,
);
if ( !%Article ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "Article not found (ArticleID=$Param{ArticleID})!"
);
return;
}
# Get channel specific fields
my %ArticleFields = $LayoutObject->ArticleFields(%Param);
# Check if HTML should be displayed.
my $ShowHTML = $ConfigObject->Get('Ticket::Frontend::ZoomRichTextForce')
|| $LayoutObject->{BrowserRichText}
|| 0;
my $ArticleContent = $LayoutObject->ArticlePreview(
%Param,
ResultType => $ShowHTML ? 'HTML' : 'plain',
);
if ( !$ShowHTML ) {
# html quoting
$ArticleContent = $LayoutObject->Ascii2Html(
NewLine => $ConfigObject->Get('DefaultViewNewLine'),
Text => $ArticleContent,
VMax => $ConfigObject->Get('DefaultViewLines') || 5000,
HTMLResultMode => 1,
LinkFeature => 1,
);
}
my %CommunicationChannel = $Kernel::OM->Get('Kernel::System::CommunicationChannel')->ChannelGet(
ChannelID => $Article{CommunicationChannelID},
);
my $Content = $LayoutObject->Output(
TemplateFile => 'CustomerTicketZoom/ArticleRender/Invalid',
Data => {
%Article,
ArticleFields => \%ArticleFields,
Body => $ArticleContent,
HTML => $ShowHTML,
CommunicationChannel => $CommunicationChannel{DisplayName},
ChannelIcon => $CommunicationChannel{DisplayIcon},
Class => $Param{Class},
Age => $Param{ArticleAge},
},
);
return $Content;
}
1;

View File

@@ -0,0 +1,205 @@
# --
# Copyright (C) 2001-2019 OTRS AG, https://otrs.com/
# --
# 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.
# --
package Kernel::Output::HTML::TicketZoom::Customer::MIMEBase;
use parent 'Kernel::Output::HTML::TicketZoom::Customer::Base';
use strict;
use warnings;
use Kernel::System::VariableCheck qw(IsPositiveInteger);
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::Output::HTML::Layout',
'Kernel::System::CommunicationChannel',
'Kernel::System::Main',
'Kernel::System::Log',
'Kernel::System::Ticket::Article',
'Kernel::Output::HTML::Article::MIMEBase',
);
=head2 ArticleRender()
Returns article html.
my $HTML = $ArticleBaseObject->ArticleRender(
TicketID => 123, # (required)
ArticleID => 123, # (required)
ShowBrowserLinkMessage => 1, # (optional) Default: 0.
ArticleActions => [], # (optional)
Class => 'Visible', # (optional)
);
Result:
$HTML = "<div>...</div>";
=cut
sub ArticleRender {
my ( $Self, %Param ) = @_;
# Check needed stuff.
for my $Needed (qw(TicketID ArticleID)) {
if ( !$Param{$Needed} ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "Need $Needed!",
);
return;
}
}
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
my $LayoutObject = $Kernel::OM->Get('Kernel::Output::HTML::Layout');
my $MainObject = $Kernel::OM->Get('Kernel::System::Main');
my $ArticleBackendObject = $Kernel::OM->Get('Kernel::System::Ticket::Article')->BackendForArticle(%Param);
my %Article = $ArticleBackendObject->ArticleGet(
%Param,
RealNames => 1,
);
if ( !%Article ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "Article not found (ArticleID=$Param{ArticleID})!"
);
return;
}
# Get channel specific fields
my %ArticleFields = $LayoutObject->ArticleFields(%Param);
# Get dynamic fields and accounted time
my %ArticleMetaFields = $Self->ArticleMetaFields(%Param);
my $RichTextEnabled = $ConfigObject->Get('Ticket::Frontend::ZoomRichTextForce')
|| $LayoutObject->{BrowserRichText}
|| 0;
# Strip plain text attachments by default.
my $ExcludePlainText = 1;
# Do not strip plain text attachments if no plain text article body was found.
if ( $Article{Body} && $Article{Body} eq '- no text message => see attachment -' ) {
$ExcludePlainText = 0;
}
# Get attachment index (excluding body attachments).
my %AtmIndex = $ArticleBackendObject->ArticleAttachmentIndex(
ArticleID => $Param{ArticleID},
ExcludePlainText => $ExcludePlainText,
ExcludeHTMLBody => $RichTextEnabled,
ExcludeInline => $RichTextEnabled,
);
my @ArticleAttachments;
# Include attachments.
if (%AtmIndex) {
my $Type = $ConfigObject->Get('AttachmentDownloadType') || 'attachment';
# If attachment will be downloaded, don't open the link in new window!
my $Target = '';
if ( $Type =~ /inline/i ) {
$Target = 'target="attachment" ';
}
ATTACHMENT:
for my $FileID ( sort keys %AtmIndex ) {
push @ArticleAttachments, {
%{ $AtmIndex{$FileID} },
Action => 'Download',
Link => $LayoutObject->{Baselink} .
"Action=CustomerTicketAttachment;TicketID=$Param{TicketID};ArticleID=$Param{ArticleID};FileID=$FileID",
Target => $Target,
};
}
}
# Check if HTML should be displayed.
my $ShowHTML = $ConfigObject->Get('Ticket::Frontend::ZoomRichTextForce')
|| $LayoutObject->{BrowserRichText}
|| 0;
# Check if HTML attachment is missing.
if ( $ShowHTML && !$Kernel::OM->Get('Kernel::Output::HTML::Article::MIMEBase')->HTMLBodyAttachmentIDGet(%Param) ) {
$ShowHTML = 0;
}
my $ArticleContent;
if ( !$ShowHTML ) {
$ArticleContent = $LayoutObject->ArticlePreview(
%Param,
ResultType => 'plain',
);
# html quoting
$ArticleContent = $LayoutObject->Ascii2Html(
NewLine => $ConfigObject->Get('DefaultViewNewLine'),
Text => $ArticleContent,
VMax => $ConfigObject->Get('DefaultViewLines') || 5000,
HTMLResultMode => 1,
LinkFeature => 1,
);
}
my %CommunicationChannel = $Kernel::OM->Get('Kernel::System::CommunicationChannel')->ChannelGet(
ChannelID => $Article{CommunicationChannelID},
);
# Get screen config for CustomerTicketZoom
my $ScreenConfig = $ConfigObject->Get('Ticket::Frontend::CustomerTicketZoom');
# Define if internal notes that are marked as "visible for customer" should show the real name of the agent
# or just a default agent name.
if (
$ScreenConfig->{DisplayNoteFrom}
&& $ScreenConfig->{DisplayNoteFrom} eq 'DefaultAgentName'
&& $CommunicationChannel{ChannelName} eq 'Internal'
&& $Article{SenderType} eq 'agent'
&& $Article{IsVisibleForCustomer}
)
{
my $DefaultAgentName
= $LayoutObject->{LanguageObject}->Translate( $ScreenConfig->{DefaultAgentName} || 'Support Agent' );
$ArticleFields{From}->{Realname} = $DefaultAgentName;
$ArticleFields{From}->{Value} = $DefaultAgentName;
$ArticleFields{Sender}->{Realname} = $DefaultAgentName;
$ArticleFields{Sender}->{Value} = $DefaultAgentName;
$Article{FromRealname} = $DefaultAgentName;
}
my $Content = $LayoutObject->Output(
TemplateFile => 'CustomerTicketZoom/ArticleRender/MIMEBase',
Data => {
%Article,
ArticleFields => \%ArticleFields,
ArticleMetaFields => \%ArticleMetaFields,
Class => $Param{Class},
Attachments => \@ArticleAttachments,
MenuItems => $Param{ArticleActions},
Body => $ArticleContent,
HTML => $ShowHTML,
CommunicationChannel => $CommunicationChannel{DisplayName},
ChannelIcon => $CommunicationChannel{DisplayIcon},
BrowserLinkMessage => $Param{ShowBrowserLinkMessage} && $ShowHTML,
BodyHTMLLoad => $Param{ArticleExpanded},
Age => $Param{ArticleAge},
},
);
return $Content;
}
1;

View File

@@ -0,0 +1,20 @@
# --
# Copyright (C) 2001-2019 OTRS AG, https://otrs.com/
# --
# 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.
# --
package Kernel::Output::HTML::TicketZoom::Customer::Phone;
use strict;
use warnings;
use parent 'Kernel::Output::HTML::TicketZoom::Customer::MIMEBase';
our @ObjectDependencies = (
);
1;