Files
scripts/Perl OTRS/Kernel/Modules/AdminTemplate.pm
2024-10-14 00:08:40 +02:00

513 lines
17 KiB
Perl

# --
# 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::Modules::AdminTemplate;
use strict;
use warnings;
use Kernel::Language qw(Translatable);
our $ObjectManagerDisabled = 1;
sub new {
my ( $Type, %Param ) = @_;
# allocate new hash for object
my $Self = {%Param};
bless( $Self, $Type );
return $Self;
}
sub Run {
my ( $Self, %Param ) = @_;
my $ParamObject = $Kernel::OM->Get('Kernel::System::Web::Request');
my $LayoutObject = $Kernel::OM->Get('Kernel::Output::HTML::Layout');
my $StandardTemplateObject = $Kernel::OM->Get('Kernel::System::StandardTemplate');
my $StdAttachmentObject = $Kernel::OM->Get('Kernel::System::StdAttachment');
my $Notification = $ParamObject->GetParam( Param => 'Notification' ) || '';
# ------------------------------------------------------------ #
# change
# ------------------------------------------------------------ #
if ( $Self->{Subaction} eq 'Change' ) {
my $ID = $ParamObject->GetParam( Param => 'ID' ) || '';
my %Data = $StandardTemplateObject->StandardTemplateGet(
ID => $ID,
);
my @SelectedAttachment;
my %SelectedAttachmentData = $StdAttachmentObject->StdAttachmentStandardTemplateMemberList(
StandardTemplateID => $ID,
);
for my $Key ( sort keys %SelectedAttachmentData ) {
push @SelectedAttachment, $Key;
}
my $Output = $LayoutObject->Header();
$Output .= $LayoutObject->NavigationBar();
$Output .= $LayoutObject->Notify( Info => Translatable('Template updated!') )
if ( $Notification && $Notification eq 'Update' );
$Self->_Edit(
Action => 'Change',
%Data,
SelectedAttachments => \@SelectedAttachment,
);
$Output .= $LayoutObject->Output(
TemplateFile => 'AdminTemplate',
Data => \%Param,
);
$Output .= $LayoutObject->Footer();
return $Output;
}
# ------------------------------------------------------------ #
# change action
# ------------------------------------------------------------ #
elsif ( $Self->{Subaction} eq 'ChangeAction' ) {
# challenge token check for write action
$LayoutObject->ChallengeTokenCheck();
my @NewIDs = $ParamObject->GetArray( Param => 'IDs' );
my ( %GetParam, %Errors );
for my $Parameter (qw(ID Name Comment ValidID TemplateType)) {
$GetParam{$Parameter} = $ParamObject->GetParam( Param => $Parameter ) || '';
}
$GetParam{'Template'} = $ParamObject->GetParam(
Param => 'Template',
Raw => 1
) || '';
# get composed content type
$GetParam{ContentType} = 'text/plain';
if ( $LayoutObject->{BrowserRichText} ) {
$GetParam{ContentType} = 'text/html';
}
# check needed data
for my $Needed (qw(Name ValidID TemplateType)) {
if ( !$GetParam{$Needed} ) {
$Errors{ $Needed . 'Invalid' } = 'ServerError';
}
}
# check if a standard template exist with this name
my $NameExists = $StandardTemplateObject->NameExistsCheck(
Name => $GetParam{Name},
ID => $GetParam{ID}
);
if ($NameExists) {
$Errors{NameExists} = 1;
$Errors{'NameInvalid'} = 'ServerError';
}
# if no errors occurred
if ( !%Errors ) {
# update group
if (
$StandardTemplateObject->StandardTemplateUpdate(
%GetParam,
UserID => $Self->{UserID},
)
)
{
my %AttachmentsAll = $StdAttachmentObject->StdAttachmentList();
# create hash with selected queues
my %AttachmentsSelected = map { $_ => 1 } @NewIDs;
# check all used attachments
for my $AttachmentID ( sort keys %AttachmentsAll ) {
my $Active = $AttachmentsSelected{$AttachmentID} ? 1 : 0;
# set attachment to standard template relation
my $Success = $StdAttachmentObject->StdAttachmentStandardTemplateMemberAdd(
AttachmentID => $AttachmentID,
StandardTemplateID => $GetParam{ID},
Active => $Active,
UserID => $Self->{UserID},
);
}
# if the user would like to continue editing the template, just redirect to the edit screen
if (
defined $ParamObject->GetParam( Param => 'ContinueAfterSave' )
&& ( $ParamObject->GetParam( Param => 'ContinueAfterSave' ) eq '1' )
)
{
my $ID = $ParamObject->GetParam( Param => 'ID' ) || '';
return $LayoutObject->Redirect(
OP => "Action=$Self->{Action};Subaction=Change;ID=$ID;Notification=Update"
);
}
else {
# otherwise return to overview
return $LayoutObject->Redirect( OP => "Action=$Self->{Action};Notification=Update" );
}
}
}
# something has gone wrong
my $Output = $LayoutObject->Header();
$Output .= $LayoutObject->NavigationBar();
$Output .= $LayoutObject->Notify( Priority => 'Error' );
$Self->_Edit(
Action => 'Change',
Errors => \%Errors,
SelectedAttachments => \@NewIDs,
%GetParam,
);
$Output .= $LayoutObject->Output(
TemplateFile => 'AdminTemplate',
Data => \%Param,
);
$Output .= $LayoutObject->Footer();
return $Output;
}
# ------------------------------------------------------------ #
# add
# ------------------------------------------------------------ #
elsif ( $Self->{Subaction} eq 'Add' ) {
my %GetParam;
$GetParam{Name} = $ParamObject->GetParam( Param => 'Name' );
my $Output = $LayoutObject->Header();
$Output .= $LayoutObject->NavigationBar();
$Self->_Edit(
Action => 'Add',
%GetParam,
);
$Output .= $LayoutObject->Output(
TemplateFile => 'AdminTemplate',
Data => \%Param,
);
$Output .= $LayoutObject->Footer();
return $Output;
}
# ------------------------------------------------------------ #
# add action
# ------------------------------------------------------------ #
elsif ( $Self->{Subaction} eq 'AddAction' ) {
# challenge token check for write action
$LayoutObject->ChallengeTokenCheck();
my @NewIDs = $ParamObject->GetArray( Param => 'IDs' );
my ( %GetParam, %Errors );
for my $Parameter (qw(ID Name Comment ValidID TemplateType)) {
$GetParam{$Parameter} = $ParamObject->GetParam( Param => $Parameter ) || '';
}
$GetParam{'Template'} = $ParamObject->GetParam(
Param => 'Template',
Raw => 1
) || '';
# get composed content type
$GetParam{ContentType} = 'text/plain';
if ( $LayoutObject->{BrowserRichText} ) {
$GetParam{ContentType} = 'text/html';
}
# check needed data
for my $Needed (qw(Name ValidID TemplateType)) {
if ( !$GetParam{$Needed} ) {
$Errors{ $Needed . 'Invalid' } = 'ServerError';
}
}
# check if a standard template exists with this name
my $NameExists = $StandardTemplateObject->NameExistsCheck( Name => $GetParam{Name} );
if ($NameExists) {
$Errors{NameExists} = 1;
$Errors{'NameInvalid'} = 'ServerError';
}
# if no errors occurred
if ( !%Errors ) {
# add template
my $StandardTemplateID = $StandardTemplateObject->StandardTemplateAdd(
%GetParam,
UserID => $Self->{UserID},
);
if ($StandardTemplateID) {
my %AttachmentsAll = $StdAttachmentObject->StdAttachmentList();
# create hash with selected queues
my %AttachmentsSelected = map { $_ => 1 } @NewIDs;
# check all used attachments
for my $AttachmentID ( sort keys %AttachmentsAll ) {
my $Active = $AttachmentsSelected{$AttachmentID} ? 1 : 0;
# set attachment to standard template relation
my $Success = $StdAttachmentObject->StdAttachmentStandardTemplateMemberAdd(
AttachmentID => $AttachmentID,
StandardTemplateID => $StandardTemplateID,
Active => $Active,
UserID => $Self->{UserID},
);
}
$Self->_Overview();
my $Output = $LayoutObject->Header();
$Output .= $LayoutObject->NavigationBar();
$Output .= $LayoutObject->Notify(
Info => Translatable('Template added!'),
);
$Output .= $LayoutObject->Output(
TemplateFile => 'AdminTemplate',
Data => \%Param,
);
$Output .= $LayoutObject->Footer();
return $Output;
}
}
# something has gone wrong
my $Output = $LayoutObject->Header();
$Output .= $LayoutObject->NavigationBar();
$Output .= $LayoutObject->Notify( Priority => 'Error' );
$Self->_Edit(
Action => 'Add',
Errors => \%Errors,
SelectedAttachments => \@NewIDs,
%GetParam,
);
$Output .= $LayoutObject->Output(
TemplateFile => 'AdminTemplate',
Data => \%Param,
);
$Output .= $LayoutObject->Footer();
return $Output;
}
# ------------------------------------------------------------ #
# delete action
# ------------------------------------------------------------ #
elsif ( $Self->{Subaction} eq 'Delete' ) {
# challenge token check for write action
$LayoutObject->ChallengeTokenCheck();
my $ID = $ParamObject->GetParam( Param => 'ID' );
my $Delete = $StandardTemplateObject->StandardTemplateDelete(
ID => $ID,
);
if ( !$Delete ) {
return $LayoutObject->ErrorScreen();
}
return $LayoutObject->Attachment(
ContentType => 'text/html',
Content => $Delete,
Type => 'inline',
NoCache => 1,
);
}
# ------------------------------------------------------------
# overview
# ------------------------------------------------------------
else {
$Self->_Overview();
my $Output = $LayoutObject->Header();
$Output .= $LayoutObject->NavigationBar();
$Output .= $LayoutObject->Notify( Info => Translatable('Template updated!') )
if ( $Notification && $Notification eq 'Update' );
$Output .= $LayoutObject->Output(
TemplateFile => 'AdminTemplate',
Data => \%Param,
);
$Output .= $LayoutObject->Footer();
return $Output;
}
}
sub _Edit {
my ( $Self, %Param ) = @_;
my $LayoutObject = $Kernel::OM->Get('Kernel::Output::HTML::Layout');
$LayoutObject->Block(
Name => 'Overview',
Data => \%Param,
);
$LayoutObject->Block( Name => 'ActionList' );
$LayoutObject->Block( Name => 'ActionOverview' );
# get valid list
my %ValidList = $Kernel::OM->Get('Kernel::System::Valid')->ValidList();
my %ValidListReverse = reverse %ValidList;
$Param{ValidOption} = $LayoutObject->BuildSelection(
Data => \%ValidList,
Name => 'ValidID',
SelectedID => $Param{ValidID} || $ValidListReverse{valid},
Class => 'Modernize Validate_Required ' . ( $Param{Errors}->{'ValidIDInvalid'} || '' ),
);
my $TemplateTypeList = $Kernel::OM->Get('Kernel::Config')->Get('StandardTemplate::Types');
$Param{TemplateTypeString} = $LayoutObject->BuildSelection(
Data => $TemplateTypeList,
Name => 'TemplateType',
SelectedID => $Param{TemplateType},
Class => 'Modernize Validate_Required ' . ( $Param{Errors}->{'TemplateTypeInvalid'} || '' ),
);
my %AttachmentData = $Kernel::OM->Get('Kernel::System::StdAttachment')->StdAttachmentList( Valid => 1 );
$Param{AttachmentOption} = $LayoutObject->BuildSelection(
Data => \%AttachmentData,
Name => 'IDs',
Multiple => 1,
Size => 6,
Translation => 0,
PossibleNone => 1,
SelectedID => $Param{SelectedAttachments},
Class => 'Modernize',
);
my $HTMLUtilsObject = $Kernel::OM->Get('Kernel::System::HTMLUtils');
if ( $LayoutObject->{BrowserRichText} ) {
# reformat from plain to html
if ( $Param{ContentType} && $Param{ContentType} =~ /text\/plain/i ) {
$Param{Template} = $HTMLUtilsObject->ToHTML(
String => $Param{Template},
);
}
}
else {
# reformat from html to plain
if ( $Param{ContentType} && $Param{ContentType} =~ /text\/html/i ) {
$Param{Template} = $HTMLUtilsObject->ToAscii(
String => $Param{Template},
);
}
}
$LayoutObject->Block(
Name => 'OverviewUpdate',
Data => {
%Param,
%{ $Param{Errors} },
},
);
# show appropriate messages for ServerError
if ( defined $Param{Errors}->{NameExists} && $Param{Errors}->{NameExists} == 1 ) {
$LayoutObject->Block( Name => 'ExistNameServerError' );
}
else {
$LayoutObject->Block( Name => 'NameServerError' );
}
# add rich text editor
if ( $LayoutObject->{BrowserRichText} ) {
# set up rich text editor
$LayoutObject->SetRichTextParameters(
Data => \%Param,
);
}
return 1;
}
sub _Overview {
my ( $Self, %Param ) = @_;
my $LayoutObject = $Kernel::OM->Get('Kernel::Output::HTML::Layout');
$LayoutObject->Block(
Name => 'Overview',
Data => \%Param,
);
$LayoutObject->Block( Name => 'ActionList' );
$LayoutObject->Block( Name => 'ActionAdd' );
$LayoutObject->Block( Name => 'Filter' );
$LayoutObject->Block(
Name => 'OverviewResult',
Data => \%Param,
);
my $StandardTemplateObject = $Kernel::OM->Get('Kernel::System::StandardTemplate');
my %List = $StandardTemplateObject->StandardTemplateList(
UserID => 1,
Valid => 0,
);
# if there are any results, they are shown
if (%List) {
my %ListGet;
for my $ID ( sort keys %List ) {
%{ $ListGet{$ID} } = $StandardTemplateObject->StandardTemplateGet(
ID => $ID,
);
$ListGet{$ID}->{SortName} = $ListGet{$ID}->{TemplateType} . $ListGet{$ID}->{Name};
}
# get valid list
my %ValidList = $Kernel::OM->Get('Kernel::System::Valid')->ValidList();
for my $ID ( sort { $ListGet{$a}->{SortName} cmp $ListGet{$b}->{SortName} } keys %ListGet )
{
my %Data = %{ $ListGet{$ID} };
my @SelectedAttachment;
my %SelectedAttachmentData
= $Kernel::OM->Get('Kernel::System::StdAttachment')->StdAttachmentStandardTemplateMemberList(
StandardTemplateID => $ID,
);
for my $Key ( sort keys %SelectedAttachmentData ) {
push @SelectedAttachment, $Key;
}
$LayoutObject->Block(
Name => 'OverviewResultRow',
Data => {
Valid => $ValidList{ $Data{ValidID} },
%Data,
Attachments => scalar @SelectedAttachment,
},
);
}
}
# otherwise it displays a no data found message
else {
$LayoutObject->Block(
Name => 'NoDataFoundMsg',
Data => {},
);
}
return 1;
}
1;