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

384 lines
11 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::AdminSignature;
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 $SignatureObject = $Kernel::OM->Get('Kernel::System::Signature');
my $Notification = $ParamObject->GetParam( Param => 'Notification' ) || '';
# ------------------------------------------------------------ #
# change
# ------------------------------------------------------------ #
if ( $Self->{Subaction} eq 'Change' ) {
my $ID = $ParamObject->GetParam( Param => 'ID' ) || '';
my %Data = $SignatureObject->SignatureGet(
ID => $ID,
);
my $Output = $LayoutObject->Header();
$Output .= $LayoutObject->NavigationBar();
$Output .= $LayoutObject->Notify( Info => Translatable('Signature updated!') )
if ( $Notification && $Notification eq 'Update' );
$Self->_Edit(
Action => 'Change',
%Data,
);
$Output .= $LayoutObject->Output(
TemplateFile => 'AdminSignature',
Data => \%Param,
);
$Output .= $LayoutObject->Footer();
return $Output;
}
# ------------------------------------------------------------ #
# change action
# ------------------------------------------------------------ #
elsif ( $Self->{Subaction} eq 'ChangeAction' ) {
# challenge token check for write action
$LayoutObject->ChallengeTokenCheck();
my ( %GetParam, %Errors );
for my $Parameter (qw(ID Name Text Comment ValidID)) {
$GetParam{$Parameter} = $ParamObject->GetParam( Param => $Parameter ) || '';
}
$GetParam{'Text'} = $ParamObject->GetParam(
Param => 'Text',
Raw => 1
) || '';
# get content type
my $ContentType = 'text/plain';
if ( $LayoutObject->{BrowserRichText} ) {
$ContentType = 'text/html';
}
# check needed data
for my $Needed (qw(Name ValidID)) {
if ( !$GetParam{$Needed} ) {
$Errors{ $Needed . 'Invalid' } = 'ServerError';
}
}
# if no errors occurred
if ( !%Errors ) {
# update signature
my $Update = $SignatureObject->SignatureUpdate(
%GetParam,
ContentType => $ContentType,
UserID => $Self->{UserID},
);
if ($Update) {
# if the user would like to continue editing the signature, 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,
%GetParam,
);
$Output .= $LayoutObject->Output(
TemplateFile => 'AdminSignature',
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 => 'AdminSignature',
Data => \%Param,
);
$Output .= $LayoutObject->Footer();
return $Output;
}
# ------------------------------------------------------------ #
# add action
# ------------------------------------------------------------ #
elsif ( $Self->{Subaction} eq 'AddAction' ) {
# challenge token check for write action
$LayoutObject->ChallengeTokenCheck();
my ( %GetParam, %Errors );
for my $Parameter (qw(ID Name Comment ValidID)) {
$GetParam{$Parameter} = $ParamObject->GetParam( Param => $Parameter ) || '';
}
$GetParam{'Text'} = $ParamObject->GetParam(
Param => 'Text',
Raw => 1
) || '';
# get content type
my $ContentType = 'text/plain';
if ( $LayoutObject->{BrowserRichText} ) {
$ContentType = 'text/html';
}
# check needed data
for my $Needed (qw(Name ValidID)) {
if ( !$GetParam{$Needed} ) {
$Errors{ $Needed . 'Invalid' } = 'ServerError';
}
}
# if no errors occurred
if ( !%Errors ) {
# add signature
my $NewSignature = $SignatureObject->SignatureAdd(
%GetParam,
ContentType => $ContentType,
UserID => $Self->{UserID},
);
if ($NewSignature) {
$Self->_Overview();
my $Output = $LayoutObject->Header();
$Output .= $LayoutObject->NavigationBar();
$Output .= $LayoutObject->Notify( Info => Translatable('Signature added!') );
$Output .= $LayoutObject->Output(
TemplateFile => 'AdminSignature',
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,
%GetParam,
);
$Output .= $LayoutObject->Output(
TemplateFile => 'AdminSignature',
Data => \%Param,
);
$Output .= $LayoutObject->Footer();
return $Output;
}
# ------------------------------------------------------------
# overview
# ------------------------------------------------------------
else {
$Self->_Overview();
my $Output = $LayoutObject->Header();
$Output .= $LayoutObject->NavigationBar();
$Output .= $LayoutObject->Notify( Info => Translatable('Signature updated!') )
if ( $Notification && $Notification eq 'Update' );
$Output .= $LayoutObject->Output(
TemplateFile => 'AdminSignature',
Data => \%Param,
);
$Output .= $LayoutObject->Footer();
return $Output;
}
}
sub _Edit {
my ( $Self, %Param ) = @_;
my $LayoutObject = $Kernel::OM->Get('Kernel::Output::HTML::Layout');
my $HTMLUtilsObject = $Kernel::OM->Get('Kernel::System::HTMLUtils');
# add rich text editor
if ( $LayoutObject->{BrowserRichText} ) {
# set up rich text editor
$LayoutObject->SetRichTextParameters(
Data => \%Param,
);
# reformat from plain to html
if ( $Param{ContentType} && $Param{ContentType} =~ /text\/plain/i ) {
$Param{Text} = $HTMLUtilsObject->ToHTML(
String => $Param{Text},
);
}
}
else {
# reformat from html to plain
if ( $Param{ContentType} && $Param{ContentType} =~ /text\/html/i ) {
$Param{Text} = $HTMLUtilsObject->ToAscii(
String => $Param{Text},
);
}
}
$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'} || '' ),
);
$LayoutObject->Block(
Name => 'OverviewUpdate',
Data => {
%Param,
%{ $Param{Errors} },
},
);
# shows header
if ( $Param{Action} eq 'Change' ) {
$LayoutObject->Block( Name => 'HeaderEdit' );
}
else {
$LayoutObject->Block( Name => 'HeaderAdd' );
}
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 => 'OverviewResult',
Data => \%Param,
);
$LayoutObject->Block(
Name => 'Filter'
);
my $SignatureObject = $Kernel::OM->Get('Kernel::System::Signature');
my %List = $SignatureObject->SignatureList(
Valid => 0,
);
# if there are any results, they are shown
if (%List) {
# get valid list
my %ValidList = $Kernel::OM->Get('Kernel::System::Valid')->ValidList();
for my $ListKey ( sort { $List{$a} cmp $List{$b} } keys %List ) {
my %Data = $SignatureObject->SignatureGet( ID => $ListKey );
$LayoutObject->Block(
Name => 'OverviewResultRow',
Data => {
Valid => $ValidList{ $Data{ValidID} },
%Data,
},
);
}
}
# otherwise a no data message is displayed
else {
$LayoutObject->Block(
Name => 'NoDataFoundMsg',
Data => {},
);
}
return 1;
}
1;