init III
This commit is contained in:
695
Perl OTRS/Kernel/System/Calendar/Event/Notification.pm
Normal file
695
Perl OTRS/Kernel/System/Calendar/Event/Notification.pm
Normal file
@@ -0,0 +1,695 @@
|
||||
# --
|
||||
# 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::System::Calendar::Event::Notification;
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
use Kernel::System::VariableCheck qw(:all);
|
||||
|
||||
our @ObjectDependencies = (
|
||||
'Kernel::Config',
|
||||
'Kernel::System::Calendar',
|
||||
'Kernel::System::Calendar::Appointment',
|
||||
'Kernel::System::DateTime',
|
||||
'Kernel::System::Group',
|
||||
'Kernel::System::JSON',
|
||||
'Kernel::System::Log',
|
||||
'Kernel::System::NotificationEvent',
|
||||
'Kernel::System::CalendarTemplateGenerator',
|
||||
'Kernel::System::Ticket',
|
||||
'Kernel::System::User',
|
||||
);
|
||||
|
||||
sub new {
|
||||
my ( $Type, %Param ) = @_;
|
||||
|
||||
# allocate new hash for object
|
||||
my $Self = {};
|
||||
bless( $Self, $Type );
|
||||
|
||||
return $Self;
|
||||
}
|
||||
|
||||
sub Run {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(Event Data Config UserID)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
if ( !$Param{Data}->{AppointmentID} && !$Param{Data}->{CalendarID} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => 'Need either CalendarID or AppointmentID in Data!',
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
# get notification event object
|
||||
my $NotificationEventObject = $Kernel::OM->Get('Kernel::System::NotificationEvent');
|
||||
|
||||
# check if event is affected
|
||||
my @IDs = $NotificationEventObject->NotificationEventCheck(
|
||||
Event => $Param{Event},
|
||||
);
|
||||
|
||||
# return if no notification for event exists
|
||||
if ( !IsArrayRefWithData( \@IDs ) ) {
|
||||
|
||||
# update the future tasks
|
||||
$Self->_FutureTaskUpdate();
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
my $AppointmentObject = $Kernel::OM->Get('Kernel::System::Calendar::Appointment');
|
||||
my $CalendarObject = $Kernel::OM->Get('Kernel::System::Calendar');
|
||||
|
||||
my %Calendar;
|
||||
my %Appointment;
|
||||
|
||||
if ( $Param{Data}->{AppointmentID} ) {
|
||||
%Appointment = $AppointmentObject->AppointmentGet(
|
||||
AppointmentID => $Param{Data}->{AppointmentID},
|
||||
);
|
||||
%Calendar = $CalendarObject->CalendarGet(
|
||||
CalendarID => $Appointment{CalendarID} || $Param{Data}->{CalendarID},
|
||||
);
|
||||
}
|
||||
elsif ( $Param{Data}->{CalendarID} ) {
|
||||
%Calendar = $CalendarObject->CalendarGet(
|
||||
CalendarID => $Param{Data}->{CalendarID},
|
||||
);
|
||||
}
|
||||
|
||||
NOTIFICATIONID:
|
||||
for my $NotificationID (@IDs) {
|
||||
|
||||
my %Notification = $NotificationEventObject->NotificationGet(
|
||||
ID => $NotificationID,
|
||||
);
|
||||
|
||||
# verify appointment conditions
|
||||
my $PassFilter = $Self->_NotificationFilter(
|
||||
%Param,
|
||||
Appointment => \%Appointment,
|
||||
Calendar => \%Calendar,
|
||||
Notification => \%Notification,
|
||||
);
|
||||
|
||||
next NOTIFICATIONID if !$PassFilter;
|
||||
|
||||
# get recipients
|
||||
my @RecipientUsers = $Self->_RecipientsGet(
|
||||
%Param,
|
||||
Appointment => \%Appointment,
|
||||
Calendar => \%Calendar,
|
||||
Notification => \%Notification,
|
||||
);
|
||||
|
||||
my @NotificationBundle;
|
||||
|
||||
# get template generator object;
|
||||
my $TemplateGeneratorObject = $Kernel::OM->Get('Kernel::System::CalendarTemplateGenerator');
|
||||
|
||||
# parse all notification tags for each user
|
||||
for my $Recipient (@RecipientUsers) {
|
||||
|
||||
my %ReplacedNotification = $TemplateGeneratorObject->NotificationEvent(
|
||||
AppointmentID => $Param{Data}->{AppointmentID},
|
||||
CalendarID => $Param{Data}->{CalendarID},
|
||||
Recipient => $Recipient,
|
||||
Notification => \%Notification,
|
||||
UserID => $Param{UserID},
|
||||
);
|
||||
|
||||
my $UserNotificationTransport = $Kernel::OM->Get('Kernel::System::JSON')->Decode(
|
||||
Data => $Recipient->{AppointmentNotificationTransport},
|
||||
);
|
||||
|
||||
push @NotificationBundle, {
|
||||
Recipient => $Recipient,
|
||||
Notification => \%ReplacedNotification,
|
||||
RecipientNotificationTransport => $UserNotificationTransport,
|
||||
};
|
||||
}
|
||||
|
||||
# get config object
|
||||
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
|
||||
|
||||
# get notification transport config
|
||||
my %TransportConfig = %{ $ConfigObject->Get('AppointmentNotification::Transport') || {} };
|
||||
|
||||
# remember already sent agent notifications
|
||||
my %AlreadySent;
|
||||
|
||||
# loop over transports for each notification
|
||||
TRANSPORT:
|
||||
for my $Transport ( sort keys %TransportConfig ) {
|
||||
|
||||
# only configured transports for this notification
|
||||
if ( !grep { $_ eq $Transport } @{ $Notification{Data}->{Transports} } ) {
|
||||
next TRANSPORT;
|
||||
}
|
||||
|
||||
next TRANSPORT if !IsHashRefWithData( $TransportConfig{$Transport} );
|
||||
next TRANSPORT if !$TransportConfig{$Transport}->{Module};
|
||||
|
||||
# get transport object
|
||||
my $TransportObject;
|
||||
eval {
|
||||
$TransportObject = $Kernel::OM->Get( $TransportConfig{$Transport}->{Module} );
|
||||
};
|
||||
|
||||
if ( !$TransportObject ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Could not create a new $TransportConfig{$Transport}->{Module} object!",
|
||||
);
|
||||
|
||||
next TRANSPORT;
|
||||
}
|
||||
|
||||
if ( ref $TransportObject ne $TransportConfig{$Transport}->{Module} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "$TransportConfig{$Transport}->{Module} object is invalid",
|
||||
);
|
||||
|
||||
next TRANSPORT;
|
||||
}
|
||||
|
||||
# check if transport is usable
|
||||
next TRANSPORT if !$TransportObject->IsUsable();
|
||||
|
||||
BUNDLE:
|
||||
for my $Bundle (@NotificationBundle) {
|
||||
|
||||
my $UserPreference = "Notification-$Notification{ID}-$Transport";
|
||||
|
||||
# check if agent should get the notification
|
||||
my $AgentSendNotification = 0;
|
||||
if ( defined $Bundle->{RecipientNotificationTransport}->{$UserPreference} ) {
|
||||
$AgentSendNotification = $Bundle->{RecipientNotificationTransport}->{$UserPreference};
|
||||
}
|
||||
elsif ( grep { $_ eq $Transport } @{ $Notification{Data}->{AgentEnabledByDefault} } ) {
|
||||
$AgentSendNotification = 1;
|
||||
}
|
||||
elsif (
|
||||
!IsArrayRefWithData( $Notification{Data}->{VisibleForAgent} )
|
||||
|| (
|
||||
defined $Notification{Data}->{VisibleForAgent}->[0]
|
||||
&& !$Notification{Data}->{VisibleForAgent}->[0]
|
||||
)
|
||||
)
|
||||
{
|
||||
$AgentSendNotification = 1;
|
||||
}
|
||||
|
||||
# skip sending the notification if the agent has disable it in its preferences
|
||||
if (
|
||||
IsArrayRefWithData( $Notification{Data}->{VisibleForAgent} )
|
||||
&& $Notification{Data}->{VisibleForAgent}->[0]
|
||||
&& $Bundle->{Recipient}->{Type} eq 'Agent'
|
||||
&& !$AgentSendNotification
|
||||
)
|
||||
{
|
||||
next BUNDLE;
|
||||
}
|
||||
|
||||
my $Success = $Self->_SendRecipientNotification(
|
||||
AppointmentID => $Appointment{AppointmentID} || '',
|
||||
CalendarID => $Calendar{CalendarID} || $Appointment{CalendarID} || '',
|
||||
Notification => $Bundle->{Notification},
|
||||
CustomerMessageParams => $Param{Data}->{CustomerMessageParams} || {},
|
||||
Recipient => $Bundle->{Recipient},
|
||||
Event => $Param{Event},
|
||||
Transport => $Transport,
|
||||
TransportObject => $TransportObject,
|
||||
UserID => $Param{UserID},
|
||||
);
|
||||
|
||||
# remember to have sent
|
||||
$AlreadySent{ $Bundle->{Recipient}->{UserID} } = 1;
|
||||
|
||||
}
|
||||
|
||||
# get special recipients specific for each transport
|
||||
my @TransportRecipients = $TransportObject->GetTransportRecipients(
|
||||
Notification => \%Notification,
|
||||
);
|
||||
|
||||
next TRANSPORT if !@TransportRecipients;
|
||||
|
||||
RECIPIENT:
|
||||
for my $Recipient (@TransportRecipients) {
|
||||
|
||||
# replace all notification tags for each special recipient
|
||||
my %ReplacedNotification = $TemplateGeneratorObject->NotificationEvent(
|
||||
AppointmentID => $Param{Data}->{AppointmentID},
|
||||
Recipient => $Recipient,
|
||||
Notification => \%Notification,
|
||||
CustomerMessageParams => $Param{Data}->{CustomerMessageParams} || {},
|
||||
UserID => $Param{UserID},
|
||||
);
|
||||
|
||||
my $Success = $Self->_SendRecipientNotification(
|
||||
AppointmentID => $Appointment{AppointmentID} || '',
|
||||
CalendarID => $Calendar{CalendarID} || $Appointment{CalendarID} || '',
|
||||
Notification => \%ReplacedNotification,
|
||||
CustomerMessageParams => $Param{Data}->{CustomerMessageParams} || {},
|
||||
Recipient => $Recipient,
|
||||
Event => $Param{Event},
|
||||
Transport => $Transport,
|
||||
TransportObject => $TransportObject,
|
||||
UserID => $Param{UserID},
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# update appointment future tasks
|
||||
$Self->_FutureTaskUpdate();
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
sub _NotificationFilter {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed params
|
||||
for my $Needed (qw(Appointment Calendar Notification)) {
|
||||
return if !$Param{$Needed};
|
||||
}
|
||||
|
||||
# set local values
|
||||
my %Notification = %{ $Param{Notification} };
|
||||
|
||||
return if !IsHashRefWithData( $Notification{Data} );
|
||||
|
||||
KEY:
|
||||
for my $Key ( sort keys %{ $Notification{Data} } ) {
|
||||
|
||||
# ignore not appointment related attributes
|
||||
next KEY if $Key eq 'Recipients';
|
||||
next KEY if $Key eq 'SkipRecipients';
|
||||
next KEY if $Key eq 'RecipientAgents';
|
||||
next KEY if $Key eq 'RecipientGroups';
|
||||
next KEY if $Key eq 'RecipientRoles';
|
||||
next KEY if $Key eq 'TransportEmailTemplate';
|
||||
next KEY if $Key eq 'Events';
|
||||
next KEY if $Key eq 'ArticleTypeID';
|
||||
next KEY if $Key eq 'ArticleSenderTypeID';
|
||||
next KEY if $Key eq 'ArticleSubjectMatch';
|
||||
next KEY if $Key eq 'ArticleBodyMatch';
|
||||
next KEY if $Key eq 'ArticleAttachmentInclude';
|
||||
next KEY if $Key eq 'NotificationArticleTypeID';
|
||||
next KEY if $Key eq 'Transports';
|
||||
next KEY if $Key eq 'OncePerDay';
|
||||
next KEY if $Key eq 'VisibleForAgent';
|
||||
next KEY if $Key eq 'VisibleForAgentTooltip';
|
||||
next KEY if $Key eq 'LanguageID';
|
||||
next KEY if $Key eq 'SendOnOutOfOffice';
|
||||
next KEY if $Key eq 'AgentEnabledByDefault';
|
||||
next KEY if $Key eq 'NotificationType';
|
||||
|
||||
# check recipient fields from transport methods
|
||||
if ( $Key =~ m{\A Recipient}xms ) {
|
||||
next KEY;
|
||||
}
|
||||
|
||||
# check appointment attributes
|
||||
next KEY if !$Notification{Data}->{$Key};
|
||||
next KEY if !@{ $Notification{Data}->{$Key} };
|
||||
next KEY if !$Notification{Data}->{$Key}->[0];
|
||||
|
||||
my $Match = 0;
|
||||
|
||||
VALUE:
|
||||
for my $Value ( @{ $Notification{Data}->{$Key} } ) {
|
||||
|
||||
next VALUE if !$Value;
|
||||
|
||||
if (
|
||||
$Key eq 'TeamID'
|
||||
|| $Key eq 'ResourceID'
|
||||
)
|
||||
{
|
||||
# check for existing object ids in appointment
|
||||
next KEY if !IsArrayRefWithData( $Param{Appointment}->{$Key} );
|
||||
|
||||
OBJECTID:
|
||||
for my $ObjectID ( @{ $Param{Appointment}->{$Key} } ) {
|
||||
|
||||
next OBJECTID if !$ObjectID;
|
||||
|
||||
if ( $Value eq $ObjectID ) {
|
||||
$Match = 1;
|
||||
last VALUE;
|
||||
}
|
||||
}
|
||||
}
|
||||
elsif ( $Key eq 'Title' || $Key eq 'Location' ) {
|
||||
if ( defined $Param{Appointment}->{$Key} && $Param{Appointment}->{$Key} =~ m/$Value/i ) {
|
||||
$Match = 1;
|
||||
last VALUE;
|
||||
}
|
||||
}
|
||||
else {
|
||||
|
||||
if ( defined $Param{Appointment}->{$Key} && $Value eq $Param{Appointment}->{$Key} ) {
|
||||
$Match = 1;
|
||||
last VALUE;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return if !$Match;
|
||||
}
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
sub _RecipientsGet {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed params
|
||||
for my $Needed (qw(Appointment Calendar Notification)) {
|
||||
return if !$Param{$Needed};
|
||||
}
|
||||
|
||||
# set local values
|
||||
my %Notification = %{ $Param{Notification} };
|
||||
my %Appointment = %{ $Param{Appointment} };
|
||||
|
||||
# get needed objects
|
||||
my $AppointmentObject = $Kernel::OM->Get('Kernel::System::Calendar::Appointment');
|
||||
my $CalendarObject = $Kernel::OM->Get('Kernel::System::Calendar');
|
||||
my $GroupObject = $Kernel::OM->Get('Kernel::System::Group');
|
||||
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
|
||||
|
||||
my @RecipientUserIDs;
|
||||
my @RecipientUsers;
|
||||
|
||||
# add pre-calculated recipient
|
||||
if ( IsArrayRefWithData( $Param{Data}->{Recipients} ) ) {
|
||||
push @RecipientUserIDs, @{ $Param{Data}->{Recipients} };
|
||||
}
|
||||
|
||||
# remember pre-calculated user recipients for later comparisons
|
||||
my %PrecalculatedUserIDs = map { $_ => 1 } @RecipientUserIDs;
|
||||
|
||||
# get recipients by Recipients
|
||||
if ( $Notification{Data}->{Recipients} ) {
|
||||
|
||||
RECIPIENT:
|
||||
for my $Recipient ( @{ $Notification{Data}->{Recipients} } ) {
|
||||
|
||||
if (
|
||||
$Recipient
|
||||
=~ /^Appointment(Agents|AgentReadPermissions|AgentWritePermissions)$/
|
||||
)
|
||||
{
|
||||
if ( $Recipient eq 'AppointmentAgents' ) {
|
||||
|
||||
RESOURCEID:
|
||||
for my $ResourceID ( @{ $Appointment{ResourceID} } ) {
|
||||
|
||||
next RESOURCEID if !$ResourceID;
|
||||
|
||||
push @{ $Notification{Data}->{RecipientAgents} }, $ResourceID;
|
||||
}
|
||||
}
|
||||
elsif ( $Recipient eq 'AppointmentAgentReadPermissions' ) {
|
||||
|
||||
# get calendar information
|
||||
my %Calendar = $CalendarObject->CalendarGet(
|
||||
CalendarID => $Appointment{CalendarID} || $Param{Calendar}->{CalendarID},
|
||||
UserID => 1,
|
||||
);
|
||||
|
||||
# get a list of read access users for the related calendar
|
||||
my %Users = $GroupObject->PermissionGroupGet(
|
||||
GroupID => $Calendar{GroupID},
|
||||
Type => 'ro',
|
||||
);
|
||||
|
||||
USERID:
|
||||
for my $UserID ( sort keys %Users ) {
|
||||
|
||||
next USERID if !$UserID;
|
||||
|
||||
push @{ $Notification{Data}->{RecipientAgents} }, $UserID;
|
||||
}
|
||||
}
|
||||
elsif ( $Recipient eq 'AppointmentAgentWritePermissions' ) {
|
||||
|
||||
# get calendar information
|
||||
my %Calendar = $CalendarObject->CalendarGet(
|
||||
CalendarID => $Appointment{CalendarID} || $Param{Calendar}->{CalendarID},
|
||||
UserID => 1,
|
||||
);
|
||||
|
||||
# get a list of read access users for the related calendar
|
||||
my %Users = $GroupObject->PermissionGroupGet(
|
||||
GroupID => $Calendar{GroupID},
|
||||
Type => 'rw',
|
||||
);
|
||||
|
||||
USERID:
|
||||
for my $UserID ( sort keys %Users ) {
|
||||
|
||||
next USERID if !$UserID;
|
||||
|
||||
push @{ $Notification{Data}->{RecipientAgents} }, $UserID;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# add recipient agents
|
||||
if ( IsArrayRefWithData( $Notification{Data}->{RecipientAgents} ) ) {
|
||||
push @RecipientUserIDs, @{ $Notification{Data}->{RecipientAgents} };
|
||||
}
|
||||
|
||||
# hash to keep track which agents are already receiving this notification
|
||||
my %AgentUsed = map { $_ => 1 } @RecipientUserIDs;
|
||||
|
||||
# get recipients by RecipientGroups
|
||||
if ( $Notification{Data}->{RecipientGroups} ) {
|
||||
|
||||
RECIPIENT:
|
||||
for my $GroupID ( @{ $Notification{Data}->{RecipientGroups} } ) {
|
||||
|
||||
my %GroupMemberList = $GroupObject->PermissionGroupUserGet(
|
||||
GroupID => $GroupID,
|
||||
Type => 'ro',
|
||||
);
|
||||
|
||||
GROUPMEMBER:
|
||||
for my $UserID ( sort keys %GroupMemberList ) {
|
||||
|
||||
next GROUPMEMBER if $UserID == 1;
|
||||
next GROUPMEMBER if $AgentUsed{$UserID};
|
||||
|
||||
$AgentUsed{$UserID} = 1;
|
||||
|
||||
push @RecipientUserIDs, $UserID;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# get recipients by RecipientRoles
|
||||
if ( $Notification{Data}->{RecipientRoles} ) {
|
||||
|
||||
RECIPIENT:
|
||||
for my $RoleID ( @{ $Notification{Data}->{RecipientRoles} } ) {
|
||||
|
||||
my %RoleMemberList = $GroupObject->PermissionRoleUserGet(
|
||||
RoleID => $RoleID,
|
||||
);
|
||||
|
||||
ROLEMEMBER:
|
||||
for my $UserID ( sort keys %RoleMemberList ) {
|
||||
|
||||
next ROLEMEMBER if $UserID == 1;
|
||||
next ROLEMEMBER if $AgentUsed{$UserID};
|
||||
|
||||
$AgentUsed{$UserID} = 1;
|
||||
|
||||
push @RecipientUserIDs, $UserID;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# get needed objects
|
||||
my $UserObject = $Kernel::OM->Get('Kernel::System::User');
|
||||
|
||||
my %SkipRecipients;
|
||||
if ( IsArrayRefWithData( $Param{Data}->{SkipRecipients} ) ) {
|
||||
%SkipRecipients = map { $_ => 1 } @{ $Param{Data}->{SkipRecipients} };
|
||||
}
|
||||
|
||||
# agent 1 should not receive notifications
|
||||
$SkipRecipients{'1'} = 1;
|
||||
|
||||
# remove recipients should not receive a notification
|
||||
@RecipientUserIDs = grep { !$SkipRecipients{$_} } @RecipientUserIDs;
|
||||
|
||||
# get valid users list
|
||||
my %ValidUsersList = $UserObject->UserList(
|
||||
Type => 'Short',
|
||||
Valid => 1,
|
||||
NoOutOfOffice => 0,
|
||||
);
|
||||
|
||||
# remove invalid users
|
||||
@RecipientUserIDs = grep { $ValidUsersList{$_} } @RecipientUserIDs;
|
||||
|
||||
# remove duplicated
|
||||
my %TempRecipientUserIDs = map { $_ => 1 } @RecipientUserIDs;
|
||||
@RecipientUserIDs = sort keys %TempRecipientUserIDs;
|
||||
|
||||
my $DateTimeObject = $Kernel::OM->Create('Kernel::System::DateTime');
|
||||
|
||||
# get all data for recipients as they should be needed by all notification transports
|
||||
RECIPIENT:
|
||||
for my $UserID (@RecipientUserIDs) {
|
||||
|
||||
my %User = $UserObject->GetUserData(
|
||||
UserID => $UserID,
|
||||
Valid => 1,
|
||||
);
|
||||
next RECIPIENT if !%User;
|
||||
|
||||
# skip user that triggers the event (it should not be notified) but only if it is not
|
||||
# a pre-calculated recipient
|
||||
if (
|
||||
!$ConfigObject->Get('AgentSelfNotifyOnAction')
|
||||
&& $User{UserID} == $Param{UserID}
|
||||
&& !$PrecalculatedUserIDs{ $Param{UserID} }
|
||||
)
|
||||
{
|
||||
next RECIPIENT;
|
||||
}
|
||||
|
||||
# skip users out of the office if configured
|
||||
if ( !$Notification{Data}->{SendOnOutOfOffice} && $User{OutOfOffice} ) {
|
||||
my $Start = sprintf(
|
||||
"%04d-%02d-%02d 00:00:00",
|
||||
$User{OutOfOfficeStartYear}, $User{OutOfOfficeStartMonth},
|
||||
$User{OutOfOfficeStartDay}
|
||||
);
|
||||
my $StartTimeObject = $Kernel::OM->Create(
|
||||
'Kernel::System::DateTime',
|
||||
ObjectParams => {
|
||||
String => $Start,
|
||||
},
|
||||
);
|
||||
|
||||
my $End = sprintf(
|
||||
"%04d-%02d-%02d 23:59:59",
|
||||
$User{OutOfOfficeEndYear}, $User{OutOfOfficeEndMonth},
|
||||
$User{OutOfOfficeEndDay}
|
||||
);
|
||||
my $EndTimeObject = $Kernel::OM->Create(
|
||||
'Kernel::System::DateTime',
|
||||
ObjectParams => {
|
||||
String => $End,
|
||||
},
|
||||
);
|
||||
|
||||
next RECIPIENT if $StartTimeObject < $DateTimeObject && $EndTimeObject > $DateTimeObject;
|
||||
}
|
||||
|
||||
# skip PostMasterUserID
|
||||
my $PostmasterUserID = $ConfigObject->Get('PostmasterUserID') || 1;
|
||||
next RECIPIENT if $User{UserID} == $PostmasterUserID;
|
||||
|
||||
$User{Type} = 'Agent';
|
||||
|
||||
push @RecipientUsers, \%User;
|
||||
}
|
||||
|
||||
return @RecipientUsers;
|
||||
}
|
||||
|
||||
sub _SendRecipientNotification {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(UserID Notification Recipient Event Transport TransportObject)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
my $TransportObject = $Param{TransportObject};
|
||||
|
||||
# send notification to each recipient
|
||||
my $Success = $TransportObject->SendNotification(
|
||||
AppointmentID => $Param{AppointmentID},
|
||||
CalendarID => $Param{CalendarID},
|
||||
UserID => $Param{UserID},
|
||||
Notification => $Param{Notification},
|
||||
CustomerMessageParams => $Param{CustomerMessageParams},
|
||||
Recipient => $Param{Recipient},
|
||||
Event => $Param{Event},
|
||||
Attachments => $Param{Attachments},
|
||||
);
|
||||
|
||||
return if !$Success;
|
||||
|
||||
my %EventData = %{ $TransportObject->GetTransportEventData() };
|
||||
|
||||
return 1 if !%EventData;
|
||||
|
||||
if ( !$EventData{Event} || !$EventData{Data} || !$EventData{UserID} ) {
|
||||
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Could not trigger notification post send event",
|
||||
);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
sub _FutureTaskUpdate {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# Get the next upcoming appointment.
|
||||
my $Success = $Kernel::OM->Get('Kernel::System::Calendar::Appointment')->AppointmentFutureTasksUpdate();
|
||||
|
||||
if ( !$Success ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => 'Could not update upcoming appointment data!',
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
1;
|
||||
80
Perl OTRS/Kernel/System/Calendar/Event/TicketAppointments.pm
Normal file
80
Perl OTRS/Kernel/System/Calendar/Event/TicketAppointments.pm
Normal file
@@ -0,0 +1,80 @@
|
||||
# --
|
||||
# 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::System::Calendar::Event::TicketAppointments;
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
use parent qw(Kernel::System::AsynchronousExecutor);
|
||||
|
||||
our @ObjectDependencies = (
|
||||
'Kernel::System::Log',
|
||||
'Kernel::System::Calendar',
|
||||
);
|
||||
|
||||
sub new {
|
||||
my ( $Type, %Param ) = @_;
|
||||
|
||||
# allocate new hash for object
|
||||
my $Self = {};
|
||||
bless( $Self, $Type );
|
||||
|
||||
return $Self;
|
||||
}
|
||||
|
||||
sub Run {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(Event Data Config UserID)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
if ( !$Param{Data}->{AppointmentID} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => 'Need AppointmentID in Data!',
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
# loop protection: prevent from running if update was triggered by the ticket update
|
||||
if (
|
||||
$Kernel::OM->Get('Kernel::System::Calendar')
|
||||
->{'_TicketAppointments::TicketUpdate'}
|
||||
->{ $Param{Data}->{AppointmentID} }++
|
||||
)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
# run only on ticket appointments (get ticket id)
|
||||
my $TicketID = $Kernel::OM->Get('Kernel::System::Calendar')->TicketAppointmentTicketID(
|
||||
AppointmentID => $Param{Data}->{AppointmentID},
|
||||
);
|
||||
return if !$TicketID;
|
||||
|
||||
# update ticket in an asynchronous call
|
||||
return $Self->AsyncCall(
|
||||
ObjectName => 'Kernel::System::Calendar',
|
||||
FunctionName => 'TicketAppointmentUpdateTicket',
|
||||
FunctionParams => {
|
||||
AppointmentID => $Param{Data}->{AppointmentID},
|
||||
TicketID => $TicketID,
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
1;
|
||||
151
Perl OTRS/Kernel/System/Calendar/Event/Transport/Base.pm
Normal file
151
Perl OTRS/Kernel/System/Calendar/Event/Transport/Base.pm
Normal file
@@ -0,0 +1,151 @@
|
||||
# --
|
||||
# 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::System::Calendar::Event::Transport::Base;
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
use Kernel::System::VariableCheck qw(:all);
|
||||
|
||||
our @ObjectDependencies = (
|
||||
);
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Kernel::System::Calendar::Event::Transport::Base - common notification event transport functions
|
||||
|
||||
=head1 PUBLIC INTERFACE
|
||||
|
||||
=head2 SendNotification()
|
||||
|
||||
send a notification using an specified transport
|
||||
|
||||
my $Success = $TransportObject->SendNotification(
|
||||
TicketID => $Param{Data}->{TicketID},
|
||||
UserID => $Param{UserID},
|
||||
Notification => \%Notification,
|
||||
Recipient => {
|
||||
UserID => 123,
|
||||
UserLogin => 'some login',
|
||||
UserTitle => 'some title',
|
||||
UserFirstname => 'some first name',
|
||||
UserLastname => 'some last name'.
|
||||
# ...
|
||||
},
|
||||
Event => $Param{Event},
|
||||
Attachments => \@Attachments, # optional
|
||||
);
|
||||
|
||||
returns
|
||||
|
||||
$Success = 1; # or false in case of an error
|
||||
|
||||
=cut
|
||||
|
||||
=head2 GetTransportRecipients()
|
||||
|
||||
generates a list of recipients exclusive for a determined transport, the content of the list is
|
||||
usually an attribute of an Agent or Customer and it depends on each transport
|
||||
|
||||
my @TransportRecipients = $TransportObject->GetTransportRecipients(
|
||||
Notification => \%Notification,
|
||||
);
|
||||
|
||||
returns:
|
||||
|
||||
@TransportRecipents = (
|
||||
{
|
||||
UserEmail => 'some email', # optional
|
||||
UserFirstname => 'some name', # optional
|
||||
# ... # optional
|
||||
}
|
||||
);
|
||||
|
||||
or
|
||||
@TransportRecipients = undef; in case of an error
|
||||
|
||||
=cut
|
||||
|
||||
=head2 TransportSettingsDisplayGet()
|
||||
|
||||
generates and returns the HTML code to display exclusive settings for each transport.
|
||||
|
||||
my $HTMLOutput = $TransportObject->TransportSettingsDisplayGet(
|
||||
Data => $NotificationDataAttribute, # as retrieved from Kernel::System::NotificationEvent::NotificationGet()
|
||||
);
|
||||
|
||||
returns
|
||||
|
||||
$HTMLOutput = 'some HTML code';
|
||||
|
||||
=cut
|
||||
|
||||
=head2 TransportParamSettingsGet()
|
||||
|
||||
gets specific parameters from the web request and put them back in the GetParam attribute to be
|
||||
saved in the notification as the standard parameters
|
||||
|
||||
my $Success = $TransportObject->TransportParamSettingsGet(
|
||||
GetParam => $ParmHashRef,
|
||||
);
|
||||
|
||||
returns
|
||||
|
||||
$Success = 1; # or false in case of a failure
|
||||
|
||||
=cut
|
||||
|
||||
=head2 IsUsable();
|
||||
|
||||
returns if the transport can be used in the system environment,
|
||||
|
||||
my $Success = $TransportObject->IsUsable();
|
||||
|
||||
returns
|
||||
|
||||
$Success = 1; # or false
|
||||
|
||||
=cut
|
||||
|
||||
=head2 GetTransportEventData()
|
||||
|
||||
returns the needed event information after a notification has been sent
|
||||
|
||||
my $EventData = $TransportObject-> GetTransportEventData();
|
||||
|
||||
returns:
|
||||
|
||||
$EventData = {
|
||||
Event => 'ArticleAgentNotification', # or 'ArticleCustomerNotification'
|
||||
Data => {
|
||||
TicketID => 123,
|
||||
ArticleID => 123, # optional
|
||||
},
|
||||
UserID => 123,
|
||||
);
|
||||
|
||||
=cut
|
||||
|
||||
sub GetTransportEventData {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
return $Self->{EventData} // {};
|
||||
}
|
||||
|
||||
1;
|
||||
|
||||
=head1 TERMS AND CONDITIONS
|
||||
|
||||
This software is part of the OTRS project (L<https://otrs.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 L<https://www.gnu.org/licenses/gpl-3.0.txt>.
|
||||
|
||||
=cut
|
||||
606
Perl OTRS/Kernel/System/Calendar/Event/Transport/Email.pm
Normal file
606
Perl OTRS/Kernel/System/Calendar/Event/Transport/Email.pm
Normal file
@@ -0,0 +1,606 @@
|
||||
# --
|
||||
# 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::System::Calendar::Event::Transport::Email;
|
||||
## nofilter(TidyAll::Plugin::OTRS::Perl::LayoutObject)
|
||||
## nofilter(TidyAll::Plugin::OTRS::Perl::ParamObject)
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
use Kernel::System::VariableCheck qw(:all);
|
||||
use Kernel::Language qw(Translatable);
|
||||
|
||||
use parent qw(Kernel::System::Calendar::Event::Transport::Base);
|
||||
|
||||
our @ObjectDependencies = (
|
||||
'Kernel::Config',
|
||||
'Kernel::Output::HTML::Layout',
|
||||
'Kernel::System::Crypt::PGP',
|
||||
'Kernel::System::Crypt::SMIME',
|
||||
'Kernel::System::Email',
|
||||
'Kernel::System::Log',
|
||||
'Kernel::System::Main',
|
||||
'Kernel::System::SystemAddress',
|
||||
'Kernel::System::Web::Request',
|
||||
);
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Kernel::System::Calendar::Event::Transport::Email - email transport layer for appointment notifications
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
Notification event transport layer.
|
||||
|
||||
=head1 PUBLIC INTERFACE
|
||||
|
||||
=head2 new()
|
||||
|
||||
create a notification transport object. Do not use it directly, instead use:
|
||||
|
||||
my $TransportObject = $Kernel::OM->Get('Kernel::System::Ticket::Event::NotificationEvent::Transport::Email');
|
||||
|
||||
=cut
|
||||
|
||||
sub new {
|
||||
my ( $Type, %Param ) = @_;
|
||||
|
||||
# allocate new hash for object
|
||||
my $Self = {};
|
||||
bless( $Self, $Type );
|
||||
|
||||
return $Self;
|
||||
}
|
||||
|
||||
sub SendNotification {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(UserID Notification Recipient)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => 'Need $Needed!',
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
# cleanup event data
|
||||
$Self->{EventData} = undef;
|
||||
|
||||
# get needed objects
|
||||
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
|
||||
my $SystemAddressObject = $Kernel::OM->Get('Kernel::System::SystemAddress');
|
||||
my $LayoutObject = $Kernel::OM->Get('Kernel::Output::HTML::Layout');
|
||||
|
||||
# get recipient data
|
||||
my %Recipient = %{ $Param{Recipient} };
|
||||
|
||||
return if !$Recipient{UserEmail};
|
||||
|
||||
return if $Recipient{UserEmail} !~ /@/;
|
||||
|
||||
my $IsLocalAddress = $Kernel::OM->Get('Kernel::System::SystemAddress')->SystemAddressIsLocalAddress(
|
||||
Address => $Recipient{UserEmail},
|
||||
);
|
||||
|
||||
return if $IsLocalAddress;
|
||||
|
||||
my %Notification = %{ $Param{Notification} };
|
||||
|
||||
if ( $Param{Notification}->{ContentType} && $Param{Notification}->{ContentType} eq 'text/html' ) {
|
||||
|
||||
# Get configured template with fallback to Default.
|
||||
my $EmailTemplate = $Param{Notification}->{Data}->{TransportEmailTemplate}->[0] || 'Default';
|
||||
|
||||
my $Home = $Kernel::OM->Get('Kernel::Config')->Get('Home');
|
||||
my $TemplateDir = "$Home/Kernel/Output/HTML/Templates/Standard/NotificationEvent/Email";
|
||||
my $CustomTemplateDir = "$Home/Custom/Kernel/Output/HTML/Templates/Standard/NotificationEvent/Email";
|
||||
|
||||
if ( !-r "$TemplateDir/$EmailTemplate.tt" && !-r "$CustomTemplateDir/$EmailTemplate.tt" ) {
|
||||
$EmailTemplate = 'Default';
|
||||
}
|
||||
|
||||
# generate HTML
|
||||
$Notification{Body} = $LayoutObject->Output(
|
||||
TemplateFile => "NotificationEvent/Email/$EmailTemplate",
|
||||
Data => {
|
||||
Body => $Notification{Body},
|
||||
Subject => $Notification{Subject},
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
my $FromEmail = $ConfigObject->Get('NotificationSenderEmail');
|
||||
|
||||
# send notification
|
||||
my $From = $ConfigObject->Get('NotificationSenderName') . ' <'
|
||||
. $FromEmail . '>';
|
||||
|
||||
# security part
|
||||
my $SecurityOptions = $Self->SecurityOptionsGet( %Param, FromEmail => $FromEmail );
|
||||
return if !$SecurityOptions;
|
||||
|
||||
# get needed objects
|
||||
my $EmailObject = $Kernel::OM->Get('Kernel::System::Email');
|
||||
|
||||
my $Sent = $EmailObject->Send(
|
||||
From => $From,
|
||||
To => $Recipient{UserEmail},
|
||||
Subject => $Notification{Subject},
|
||||
MimeType => $Notification{ContentType},
|
||||
Type => $Notification{ContentType},
|
||||
Charset => 'utf-8',
|
||||
Body => $Notification{Body},
|
||||
Loop => 1,
|
||||
Attachment => $Param{Attachments},
|
||||
EmailSecurity => $SecurityOptions || {},
|
||||
);
|
||||
|
||||
if ( !$Sent->{Success} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "'$Notification{Name}' notification could not be sent to agent '$Recipient{UserEmail} ",
|
||||
);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
# log event
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'info',
|
||||
Message => "Sent agent '$Notification{Name}' notification to '$Recipient{UserEmail}'.",
|
||||
);
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
sub GetTransportRecipients {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
for my $Needed (qw(Notification)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed",
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
my @Recipients;
|
||||
|
||||
# get recipients by RecipientEmail
|
||||
if ( $Param{Notification}->{Data}->{RecipientEmail} ) {
|
||||
if ( $Param{Notification}->{Data}->{RecipientEmail}->[0] ) {
|
||||
my $RecipientEmail = $Param{Notification}->{Data}->{RecipientEmail}->[0];
|
||||
|
||||
my @RecipientEmails;
|
||||
|
||||
if ( !IsArrayRefWithData($RecipientEmail) ) {
|
||||
|
||||
# Split multiple recipients on known delimiters: comma and semi-colon.
|
||||
# Do this after the OTRS tags were replaced.
|
||||
@RecipientEmails = split /[;,\s]+/, $RecipientEmail;
|
||||
}
|
||||
else {
|
||||
@RecipientEmails = @{$RecipientEmail};
|
||||
}
|
||||
|
||||
# Include only valid email recipients.
|
||||
for my $Recipient ( sort @RecipientEmails ) {
|
||||
if ( $Recipient && $Recipient =~ /@/ ) {
|
||||
push @Recipients, {
|
||||
Realname => '',
|
||||
Type => 'Customer',
|
||||
UserEmail => $Recipient,
|
||||
IsVisibleForCustomer => $Param{Notification}->{Data}->{IsVisibleForCustomer},
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return @Recipients;
|
||||
}
|
||||
|
||||
sub TransportSettingsDisplayGet {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
KEY:
|
||||
for my $Key (qw(RecipientEmail)) {
|
||||
next KEY if !$Param{Data}->{$Key};
|
||||
next KEY if !defined $Param{Data}->{$Key}->[0];
|
||||
$Param{$Key} = $Param{Data}->{$Key}->[0];
|
||||
}
|
||||
|
||||
my $Home = $Kernel::OM->Get('Kernel::Config')->Get('Home');
|
||||
my $TemplateDir = "$Home/Kernel/Output/HTML/Templates/Standard/NotificationEvent/Email";
|
||||
my $CustomTemplateDir = "$Home/Custom/Kernel/Output/HTML/Templates/Standard/NotificationEvent/Email";
|
||||
|
||||
my @Files = $Kernel::OM->Get('Kernel::System::Main')->DirectoryRead(
|
||||
Directory => $TemplateDir,
|
||||
Filter => '*.tt',
|
||||
);
|
||||
if ( -d $CustomTemplateDir ) {
|
||||
push @Files, $Kernel::OM->Get('Kernel::System::Main')->DirectoryRead(
|
||||
Directory => $CustomTemplateDir,
|
||||
Filter => '*.tt',
|
||||
);
|
||||
}
|
||||
|
||||
# for deduplication
|
||||
my %Templates;
|
||||
|
||||
for my $File (@Files) {
|
||||
$File =~ s{^.*/([^/]+)\.tt}{$1}smxg;
|
||||
$Templates{$File} = $File;
|
||||
}
|
||||
|
||||
# get layout object
|
||||
my $LayoutObject = $Kernel::OM->Get('Kernel::Output::HTML::Layout');
|
||||
|
||||
$Param{TransportEmailTemplateStrg} = $LayoutObject->BuildSelection(
|
||||
Data => \%Templates,
|
||||
Name => 'TransportEmailTemplate',
|
||||
Translation => 0,
|
||||
SelectedID => $Param{Data}->{TransportEmailTemplate},
|
||||
Class => 'Modernize W50pc',
|
||||
);
|
||||
|
||||
# security fields
|
||||
|
||||
# get config object
|
||||
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
|
||||
|
||||
my %SecuritySignEncryptOptions;
|
||||
|
||||
if ( $ConfigObject->Get('PGP') ) {
|
||||
$SecuritySignEncryptOptions{'PGPSign'} = Translatable('PGP sign only');
|
||||
$SecuritySignEncryptOptions{'PGPCrypt'} = Translatable('PGP encrypt only');
|
||||
$SecuritySignEncryptOptions{'PGPSignCrypt'} = Translatable('PGP sign and encrypt');
|
||||
}
|
||||
|
||||
if ( $ConfigObject->Get('SMIME') ) {
|
||||
$SecuritySignEncryptOptions{'SMIMESign'} = Translatable('SMIME sign only');
|
||||
$SecuritySignEncryptOptions{'SMIMECrypt'} = Translatable('SMIME encrypt only');
|
||||
$SecuritySignEncryptOptions{'SMIMESignCrypt'} = Translatable('SMIME sign and encrypt');
|
||||
}
|
||||
|
||||
# set security settings enabled
|
||||
$Param{EmailSecuritySettings} = ( $Param{Data}->{EmailSecuritySettings} ? 'checked="checked"' : '' );
|
||||
$Param{SecurityDisabled} = 0;
|
||||
|
||||
if ( $Param{EmailSecuritySettings} eq '' ) {
|
||||
$Param{SecurityDisabled} = 1;
|
||||
}
|
||||
|
||||
if ( !IsHashRefWithData( \%SecuritySignEncryptOptions ) ) {
|
||||
$Param{EmailSecuritySettings} = 'disabled="disabled"';
|
||||
$Param{EmailSecurityInfo} = Translatable('PGP and SMIME not enabled.');
|
||||
}
|
||||
|
||||
# create security methods field
|
||||
$Param{EmailSigningCrypting} = $LayoutObject->BuildSelection(
|
||||
Data => \%SecuritySignEncryptOptions,
|
||||
Name => 'EmailSigningCrypting',
|
||||
SelectedID => $Param{Data}->{EmailSigningCrypting},
|
||||
Class => 'Security Modernize W50pc',
|
||||
Multiple => 0,
|
||||
Translation => 1,
|
||||
PossibleNone => 1,
|
||||
Disabled => $Param{SecurityDisabled},
|
||||
);
|
||||
|
||||
# create missing signing actions field
|
||||
$Param{EmailMissingSigningKeys} = $LayoutObject->BuildSelection(
|
||||
Data => [
|
||||
{
|
||||
Key => 'Skip',
|
||||
Value => Translatable('Skip notification delivery'),
|
||||
},
|
||||
{
|
||||
Key => 'Send',
|
||||
Value => Translatable('Send unsigned notification'),
|
||||
},
|
||||
],
|
||||
Name => 'EmailMissingSigningKeys',
|
||||
SelectedID => $Param{Data}->{EmailMissingSigningKeys},
|
||||
Class => 'Security Modernize W50pc',
|
||||
Multiple => 0,
|
||||
Translation => 1,
|
||||
Disabled => $Param{SecurityDisabled},
|
||||
);
|
||||
|
||||
# create missing crypting actions field
|
||||
$Param{EmailMissingCryptingKeys} = $LayoutObject->BuildSelection(
|
||||
Data => [
|
||||
{
|
||||
Key => 'Skip',
|
||||
Value => Translatable('Skip notification delivery'),
|
||||
},
|
||||
{
|
||||
Key => 'Send',
|
||||
Value => Translatable('Send unencrypted notification'),
|
||||
},
|
||||
],
|
||||
Name => 'EmailMissingCryptingKeys',
|
||||
SelectedID => $Param{Data}->{EmailMissingCryptingKeys},
|
||||
Class => 'Security Modernize W50pc',
|
||||
Multiple => 0,
|
||||
Translation => 1,
|
||||
Disabled => $Param{SecurityDisabled},
|
||||
);
|
||||
|
||||
# generate HTML
|
||||
my $Output = $LayoutObject->Output(
|
||||
TemplateFile => 'AdminAppointmentNotificationEventTransportEmailSettings',
|
||||
Data => \%Param,
|
||||
);
|
||||
|
||||
return $Output;
|
||||
}
|
||||
|
||||
sub TransportParamSettingsGet {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
for my $Needed (qw(GetParam)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed",
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
# get param object
|
||||
my $ParamObject = $Kernel::OM->Get('Kernel::System::Web::Request');
|
||||
|
||||
PARAMETER:
|
||||
for my $Parameter (
|
||||
qw(RecipientEmail TransportEmailTemplate
|
||||
EmailSigningCrypting EmailMissingSigningKeys EmailMissingCryptingKeys
|
||||
EmailSecuritySettings)
|
||||
)
|
||||
{
|
||||
my @Data = $ParamObject->GetArray( Param => $Parameter );
|
||||
next PARAMETER if !@Data;
|
||||
$Param{GetParam}->{Data}->{$Parameter} = \@Data;
|
||||
}
|
||||
|
||||
# Note: Example how to set errors and use them
|
||||
# on the normal AdminNotificationEvent screen
|
||||
# # set error
|
||||
# $Param{GetParam}->{$Parameter.'ServerError'} = 'ServerError';
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
sub IsUsable {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# define if this transport is usable on
|
||||
# this specific moment
|
||||
return 1;
|
||||
}
|
||||
|
||||
sub SecurityOptionsGet {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# Verify security options are enabled.
|
||||
my $EnableSecuritySettings = $Param{Notification}->{Data}->{EmailSecuritySettings}->[0] || '';
|
||||
|
||||
# Return empty hash ref to continue with email sending (without security options).
|
||||
return {} if !$EnableSecuritySettings;
|
||||
|
||||
# Verify if the notification has to be signed or encrypted
|
||||
my $SignEncryptNotification = $Param{Notification}->{Data}->{EmailSigningCrypting}->[0] || '';
|
||||
|
||||
# Return empty hash ref to continue with email sending (without security options).
|
||||
return {} if !$SignEncryptNotification;
|
||||
|
||||
my %Queue = %{ $Param{Queue} || {} };
|
||||
|
||||
# Define who is going to be the sender (from the given parameters)
|
||||
my $NotificationSenderEmail = $Param{FromEmail};
|
||||
|
||||
# Define security options container
|
||||
my %SecurityOptions = (
|
||||
Method => 'Detached',
|
||||
);
|
||||
|
||||
my @SignKeys;
|
||||
my @EncryptKeys;
|
||||
my $KeyField;
|
||||
|
||||
# Get private and public keys for the given backend (PGP or SMIME)
|
||||
if ( $SignEncryptNotification =~ /^PGP/i ) {
|
||||
|
||||
my $PGPObject = $Kernel::OM->Get('Kernel::System::Crypt::PGP');
|
||||
|
||||
if ( !$PGPObject ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "No PGP support!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
@SignKeys = $PGPObject->PrivateKeySearch(
|
||||
Search => $NotificationSenderEmail,
|
||||
);
|
||||
|
||||
# take just valid keys
|
||||
@SignKeys = grep { $_->{Status} eq 'good' } @SignKeys;
|
||||
|
||||
# get public keys
|
||||
@EncryptKeys = $PGPObject->PublicKeySearch(
|
||||
Search => $Param{Recipient}->{UserEmail},
|
||||
);
|
||||
|
||||
# Get PGP method (Detached or In-line).
|
||||
if ( !$Kernel::OM->Get('Kernel::Output::HTML::Layout')->{BrowserRichText} ) {
|
||||
$SecurityOptions{Method} = $Kernel::OM->Get('Kernel::Config')->Get('PGP::Method') || 'Detached';
|
||||
}
|
||||
|
||||
$SecurityOptions{Backend} = 'PGP';
|
||||
$KeyField = 'Key';
|
||||
}
|
||||
elsif ( $SignEncryptNotification =~ /^SMIME/i ) {
|
||||
|
||||
my $SMIMEObject = $Kernel::OM->Get('Kernel::System::Crypt::SMIME');
|
||||
|
||||
if ( !$SMIMEObject ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "No SMIME support!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
@SignKeys = $Kernel::OM->Get('Kernel::System::Crypt::SMIME')->PrivateSearch(
|
||||
Search => $NotificationSenderEmail,
|
||||
Valid => 1,
|
||||
);
|
||||
|
||||
@EncryptKeys = $Kernel::OM->Get('Kernel::System::Crypt::SMIME')->CertificateSearch(
|
||||
Search => $Param{Recipient}->{UserEmail},
|
||||
Valid => 1,
|
||||
);
|
||||
|
||||
$SecurityOptions{Backend} = 'SMIME';
|
||||
$KeyField = 'Filename';
|
||||
}
|
||||
|
||||
# Initialize sign key container
|
||||
my %SignKey;
|
||||
|
||||
# Initialize crypt key container
|
||||
my %EncryptKey;
|
||||
|
||||
# Get default signing key from the queue (if applies).
|
||||
if ( $Queue{DefaultSignKey} ) {
|
||||
|
||||
my $DefaultSignKey;
|
||||
|
||||
# Convert legacy stored default sign keys.
|
||||
if ( $Queue{DefaultSignKey} =~ m{ (?: Inline|Detached ) }msx ) {
|
||||
my ( $Type, $SubType, $Key ) = split /::/, $Queue{DefaultSignKey};
|
||||
$DefaultSignKey = $Key;
|
||||
}
|
||||
else {
|
||||
my ( $Type, $Key ) = split /::/, $Queue{DefaultSignKey};
|
||||
$DefaultSignKey = $Key;
|
||||
}
|
||||
|
||||
if ( grep { $_->{$KeyField} eq $DefaultSignKey } @SignKeys ) {
|
||||
$SignKey{$KeyField} = $DefaultSignKey;
|
||||
}
|
||||
}
|
||||
|
||||
# Otherwise take the first signing key available.
|
||||
if ( !%SignKey ) {
|
||||
SIGNKEY:
|
||||
for my $SignKey (@SignKeys) {
|
||||
%SignKey = %{$SignKey};
|
||||
last SIGNKEY;
|
||||
}
|
||||
}
|
||||
|
||||
# Also take the first encryption key available.
|
||||
CRYPTKEY:
|
||||
for my $EncryptKey (@EncryptKeys) {
|
||||
%EncryptKey = %{$EncryptKey};
|
||||
last CRYPTKEY;
|
||||
}
|
||||
|
||||
my $OnMissingSigningKeys = $Param{Notification}->{Data}->{EmailMissingSigningKeys}->[0] || '';
|
||||
|
||||
# Add options to sign the notification
|
||||
if ( $SignEncryptNotification =~ /Sign/i ) {
|
||||
|
||||
# Take an action if there are missing signing keys.
|
||||
if ( !IsHashRefWithData( \%SignKey ) ) {
|
||||
|
||||
my $Message
|
||||
= "Could not sign notification '$Param{Notification}->{Name}' due to missing $SecurityOptions{Backend} sign key for '$NotificationSenderEmail'";
|
||||
|
||||
if ( $OnMissingSigningKeys eq 'Skip' ) {
|
||||
|
||||
# Log skipping notification (return nothing to stop email sending).
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'notice',
|
||||
Message => $Message . ', skipping notification distribution!',
|
||||
);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
# Log sending unsigned notification.
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'notice',
|
||||
Message => $Message . ', sending unsigned!',
|
||||
);
|
||||
}
|
||||
|
||||
# Add signature option if a sign key is available
|
||||
else {
|
||||
$SecurityOptions{SignKey} = $SignKey{$KeyField};
|
||||
}
|
||||
}
|
||||
|
||||
my $OnMissingEncryptionKeys = $Param{Notification}->{Data}->{EmailMissingCryptingKeys}->[0] || '';
|
||||
|
||||
# Add options to encrypt the notification
|
||||
if ( $SignEncryptNotification =~ /Crypt/i ) {
|
||||
|
||||
# Take an action if there are missing encryption keys.
|
||||
if ( !IsHashRefWithData( \%EncryptKey ) ) {
|
||||
|
||||
my $Message
|
||||
= "Could not encrypt notification '$Param{Notification}->{Name}' due to missing $SecurityOptions{Backend} encryption key for '$Param{Recipient}->{UserEmail}'";
|
||||
|
||||
if ( $OnMissingEncryptionKeys eq 'Skip' ) {
|
||||
|
||||
# Log skipping notification (return nothing to stop email sending).
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'notice',
|
||||
Message => $Message . ', skipping notification distribution!',
|
||||
);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
# Log sending unencrypted notification.
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'notice',
|
||||
Message => $Message . ', sending unencrypted!',
|
||||
);
|
||||
}
|
||||
|
||||
# Add encrypt option if a encrypt key is available
|
||||
else {
|
||||
$SecurityOptions{EncryptKeys} = [ $EncryptKey{$KeyField}, ];
|
||||
}
|
||||
}
|
||||
|
||||
return \%SecurityOptions;
|
||||
|
||||
}
|
||||
1;
|
||||
|
||||
=head1 TERMS AND CONDITIONS
|
||||
|
||||
This software is part of the OTRS project (L<https://otrs.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 L<https://www.gnu.org/licenses/gpl-3.0.txt>.
|
||||
|
||||
=cut
|
||||
Reference in New Issue
Block a user