init III
This commit is contained in:
2828
Perl OTRS/Kernel/System/Calendar/Appointment.pm
Normal file
2828
Perl OTRS/Kernel/System/Calendar/Appointment.pm
Normal file
File diff suppressed because it is too large
Load Diff
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
|
||||
445
Perl OTRS/Kernel/System/Calendar/Export/ICal.pm
Normal file
445
Perl OTRS/Kernel/System/Calendar/Export/ICal.pm
Normal file
@@ -0,0 +1,445 @@
|
||||
# --
|
||||
# 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::Export::ICal;
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
use Data::ICal;
|
||||
use Data::ICal::Entry::Event;
|
||||
use Date::ICal;
|
||||
|
||||
use Kernel::System::VariableCheck qw(:all);
|
||||
|
||||
our @ObjectDependencies = (
|
||||
'Kernel::Config',
|
||||
'Kernel::System::Cache',
|
||||
'Kernel::System::Calendar',
|
||||
'Kernel::System::Calendar::Appointment',
|
||||
'Kernel::System::Calendar::Plugin',
|
||||
'Kernel::System::Calendar::Team',
|
||||
'Kernel::System::DateTime',
|
||||
'Kernel::System::DB',
|
||||
'Kernel::System::Log',
|
||||
'Kernel::System::Main',
|
||||
'Kernel::System::Package',
|
||||
'Kernel::System::User',
|
||||
);
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Kernel::System::Calendar::Export::ICal - C<iCalendar> export lib
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
Export functions for C<iCalendar> format.
|
||||
|
||||
=head1 PUBLIC INTERFACE
|
||||
|
||||
=head2 new()
|
||||
|
||||
create an object. Do not use it directly, instead use:
|
||||
|
||||
use Kernel::System::ObjectManager;
|
||||
local $Kernel::OM = Kernel::System::ObjectManager->new();
|
||||
my $ExportObject = $Kernel::OM->Get('Kernel::System::Calendar::Export::ICal');
|
||||
|
||||
=cut
|
||||
|
||||
sub new {
|
||||
my ( $Type, %Param ) = @_;
|
||||
|
||||
my $Self = {%Param};
|
||||
bless( $Self, $Type );
|
||||
|
||||
return $Self;
|
||||
}
|
||||
|
||||
=head2 Export()
|
||||
|
||||
Export calendar to C<iCalendar> format.
|
||||
|
||||
my $ICalString = $ExportObject->Export(
|
||||
CalendarID => 1, # (required) Valid CalendarID
|
||||
UserID => 1, # (required) UserID
|
||||
);
|
||||
|
||||
Returns C<iCalendar> string if successful.
|
||||
|
||||
=cut
|
||||
|
||||
sub Export {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(CalendarID UserID)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
my %Calendar = $Kernel::OM->Get('Kernel::System::Calendar')->CalendarGet(
|
||||
CalendarID => $Param{CalendarID},
|
||||
UserID => $Param{UserID},
|
||||
);
|
||||
return if !$Calendar{CalendarID};
|
||||
|
||||
my $AppointmentObject = $Kernel::OM->Get('Kernel::System::Calendar::Appointment');
|
||||
|
||||
my @AppointmentIDs = $AppointmentObject->AppointmentList(
|
||||
CalendarID => $Calendar{CalendarID},
|
||||
Result => 'ARRAY',
|
||||
);
|
||||
|
||||
my $ICalCalendar = Data::ICal->new(
|
||||
calname => $Calendar{CalendarName},
|
||||
);
|
||||
|
||||
# export color for apple calendar
|
||||
$ICalCalendar->add_property(
|
||||
'x-apple-calendar-color' => $Calendar{Color},
|
||||
);
|
||||
|
||||
my $PluginObject = $Kernel::OM->Get('Kernel::System::Calendar::Plugin');
|
||||
|
||||
my $TeamObject;
|
||||
if ( $Kernel::OM->Get('Kernel::System::Main')->Require( 'Kernel::System::Calendar::Team', Silent => 1 ) ) {
|
||||
$TeamObject = $Kernel::OM->Get('Kernel::System::Calendar::Team');
|
||||
}
|
||||
|
||||
APPOINTMENT_ID:
|
||||
for my $AppointmentID (@AppointmentIDs) {
|
||||
my %Appointment = $AppointmentObject->AppointmentGet(
|
||||
AppointmentID => $AppointmentID,
|
||||
);
|
||||
return if !$Appointment{AppointmentID};
|
||||
|
||||
# Calculate start time.
|
||||
my $StartTimeObject = $Kernel::OM->Create(
|
||||
'Kernel::System::DateTime',
|
||||
ObjectParams => {
|
||||
String => $Appointment{StartTime},
|
||||
},
|
||||
);
|
||||
my $ICalStartTime = Date::ICal->new(
|
||||
epoch => $StartTimeObject->ToEpoch(),
|
||||
);
|
||||
|
||||
# Calculate end time.
|
||||
my $EndTimeObject = $Kernel::OM->Create(
|
||||
'Kernel::System::DateTime',
|
||||
ObjectParams => {
|
||||
String => $Appointment{EndTime},
|
||||
},
|
||||
);
|
||||
my $ICalEndTime = Date::ICal->new(
|
||||
epoch => $EndTimeObject->ToEpoch(),
|
||||
);
|
||||
|
||||
# Recalculate for all day appointment, discard time data.
|
||||
if ( $Appointment{AllDay} ) {
|
||||
my $StartTimeSettings = $StartTimeObject->Get();
|
||||
$ICalStartTime = Date::ICal->new(
|
||||
year => $StartTimeSettings->{Year},
|
||||
month => $StartTimeSettings->{Month},
|
||||
day => $StartTimeSettings->{Day},
|
||||
offset => '+0000', # UTC
|
||||
);
|
||||
my $EndTimeSettings = $EndTimeObject->Get();
|
||||
$ICalEndTime = Date::ICal->new(
|
||||
year => $EndTimeSettings->{Year},
|
||||
month => $EndTimeSettings->{Month},
|
||||
day => $EndTimeSettings->{Day},
|
||||
offset => '+0000', # UTC
|
||||
);
|
||||
}
|
||||
|
||||
# create iCalendar event entry
|
||||
my $ICalEvent = Data::ICal::Entry::Event->new();
|
||||
|
||||
# optional properties
|
||||
my %ICalEventProperties;
|
||||
|
||||
# repeatable properties
|
||||
my @ICalRepeatableProperties;
|
||||
|
||||
if ( $Appointment{Description} ) {
|
||||
$ICalEventProperties{description} = $Appointment{Description};
|
||||
}
|
||||
if ( $Appointment{Location} ) {
|
||||
$ICalEventProperties{location} = $Appointment{Location};
|
||||
}
|
||||
if ( $Appointment{Recurring} ) {
|
||||
$ICalEventProperties{rrule} = '';
|
||||
|
||||
if ( $Appointment{RecurrenceType} eq 'Daily' ) {
|
||||
$ICalEventProperties{rrule} .= 'FREQ=DAILY';
|
||||
}
|
||||
elsif ( $Appointment{RecurrenceType} eq 'Weekly' ) {
|
||||
$ICalEventProperties{rrule} .= 'FREQ=WEEKLY';
|
||||
}
|
||||
elsif ( $Appointment{RecurrenceType} eq 'Monthly' ) {
|
||||
$ICalEventProperties{rrule} .= 'FREQ=MONTHLY';
|
||||
}
|
||||
elsif ( $Appointment{RecurrenceType} eq 'Yearly' ) {
|
||||
$ICalEventProperties{rrule} .= 'FREQ=YEARLY';
|
||||
}
|
||||
elsif ( $Appointment{RecurrenceType} eq 'CustomDaily' ) {
|
||||
$ICalEventProperties{rrule} .= "FREQ=DAILY;INTERVAL=$Appointment{RecurrenceInterval}";
|
||||
}
|
||||
elsif ( $Appointment{RecurrenceType} eq 'CustomWeekly' ) {
|
||||
$ICalEventProperties{rrule} .= "FREQ=WEEKLY;INTERVAL=$Appointment{RecurrenceInterval}";
|
||||
|
||||
if ( IsArrayRefWithData( $Appointment{RecurrenceFrequency} ) ) {
|
||||
my @DayNames;
|
||||
|
||||
for my $Day ( @{ $Appointment{RecurrenceFrequency} } ) {
|
||||
if ( $Day == 1 ) {
|
||||
push @DayNames, 'MO';
|
||||
}
|
||||
elsif ( $Day == 2 ) {
|
||||
push @DayNames, 'TU';
|
||||
}
|
||||
elsif ( $Day == 3 ) {
|
||||
push @DayNames, 'WE';
|
||||
}
|
||||
elsif ( $Day == 4 ) {
|
||||
push @DayNames, 'TH';
|
||||
}
|
||||
elsif ( $Day == 5 ) {
|
||||
push @DayNames, 'FR';
|
||||
}
|
||||
elsif ( $Day == 6 ) {
|
||||
push @DayNames, 'SA';
|
||||
}
|
||||
elsif ( $Day == 7 ) {
|
||||
push @DayNames, 'SU';
|
||||
}
|
||||
}
|
||||
|
||||
$ICalEventProperties{rrule} .= ";BYDAY=" . join( ",", @DayNames );
|
||||
}
|
||||
}
|
||||
elsif ( $Appointment{RecurrenceType} eq 'CustomMonthly' ) {
|
||||
$ICalEventProperties{rrule} .= "FREQ=MONTHLY;INTERVAL=$Appointment{RecurrenceInterval}";
|
||||
$ICalEventProperties{rrule} .= ";BYMONTHDAY=" . join( ",", @{ $Appointment{RecurrenceFrequency} } );
|
||||
|
||||
}
|
||||
elsif ( $Appointment{RecurrenceType} eq 'CustomYearly' ) {
|
||||
my $StartTimeSettings = $StartTimeObject->Get();
|
||||
|
||||
$ICalEventProperties{rrule}
|
||||
.= "FREQ=YEARLY;INTERVAL=$Appointment{RecurrenceInterval};BYMONTHDAY=$StartTimeSettings->{Day}";
|
||||
$ICalEventProperties{rrule} .= ";BYMONTH=" . join( ",", @{ $Appointment{RecurrenceFrequency} } );
|
||||
|
||||
# RRULE:FREQ=YEARLY;UNTIL=20200602T080000Z;INTERVAL=2;BYMONTHDAY=1;BYMONTH=4
|
||||
}
|
||||
|
||||
if ( $Appointment{RecurrenceUntil} ) {
|
||||
my $RecurrenceUntilObject = $Kernel::OM->Create(
|
||||
'Kernel::System::DateTime',
|
||||
ObjectParams => {
|
||||
String => $Appointment{RecurrenceUntil},
|
||||
},
|
||||
);
|
||||
my $ICalRecurrenceUntil = Date::ICal->new(
|
||||
epoch => $RecurrenceUntilObject->ToEpoch(),
|
||||
);
|
||||
$ICalEventProperties{rrule} .= ';UNTIL=' . substr( $ICalRecurrenceUntil->ical(), 0, -1 );
|
||||
}
|
||||
elsif ( $Appointment{RecurrenceCount} ) {
|
||||
$ICalEventProperties{rrule} .= ';COUNT=' . $Appointment{RecurrenceCount};
|
||||
}
|
||||
if ( $Appointment{RecurrenceExclude} ) {
|
||||
RECURRENCE_EXCLUDE:
|
||||
for my $RecurrenceExclude ( @{ $Appointment{RecurrenceExclude} } ) {
|
||||
next RECURRENCE_EXCLUDE if !$RecurrenceExclude;
|
||||
my $RecurrenceExcludeObject = $Kernel::OM->Create(
|
||||
'Kernel::System::DateTime',
|
||||
ObjectParams => {
|
||||
String => $RecurrenceExclude,
|
||||
},
|
||||
);
|
||||
my $ICalRecurrenceID = Date::ICal->new(
|
||||
epoch => $RecurrenceExcludeObject->ToEpoch(),
|
||||
);
|
||||
|
||||
push @ICalRepeatableProperties, {
|
||||
Property => 'exdate',
|
||||
Value => $Appointment{AllDay}
|
||||
? substr( $ICalRecurrenceID->ical(), 0, -1 )
|
||||
: $ICalRecurrenceID->ical(),
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# occurrence appointment
|
||||
if ( $Appointment{ParentID} ) {
|
||||
|
||||
# overridden occurrences only
|
||||
if (
|
||||
$Appointment{RecurrenceID}
|
||||
&& grep { ( $_ // '' ) eq $Appointment{RecurrenceID} } @{ $Appointment{RecurrenceExclude} }
|
||||
)
|
||||
{
|
||||
|
||||
# Calculate recurrence ID.
|
||||
my $RecurrenceIDObject = $Kernel::OM->Create(
|
||||
'Kernel::System::DateTime',
|
||||
ObjectParams => {
|
||||
String => $Appointment{RecurrenceID},
|
||||
},
|
||||
);
|
||||
my $ICalRecurrenceID = Date::ICal->new(
|
||||
epoch => $RecurrenceIDObject->ToEpoch(),
|
||||
);
|
||||
|
||||
$ICalEventProperties{'recurrence-id'}
|
||||
= $Appointment{AllDay} ? substr( $ICalRecurrenceID->ical(), 0, -1 ) : $ICalRecurrenceID->ical();
|
||||
}
|
||||
|
||||
# skip if not overridden
|
||||
else {
|
||||
next APPOINTMENT_ID;
|
||||
}
|
||||
}
|
||||
|
||||
# Calculate last modified time.
|
||||
my $ChangeTimeObject = $Kernel::OM->Create(
|
||||
'Kernel::System::DateTime',
|
||||
ObjectParams => {
|
||||
String => $Appointment{ChangeTime},
|
||||
},
|
||||
);
|
||||
my $ICalChangeTime = Date::ICal->new(
|
||||
epoch => $ChangeTimeObject->ToEpoch(),
|
||||
);
|
||||
|
||||
# check if team object is registered
|
||||
if ($TeamObject) {
|
||||
|
||||
# include team names
|
||||
if ( $Appointment{TeamID} ) {
|
||||
my @Teams;
|
||||
|
||||
# get team names
|
||||
for my $TeamID ( @{ $Appointment{TeamID} } ) {
|
||||
if ($TeamID) {
|
||||
my %Team = $TeamObject->TeamGet(
|
||||
TeamID => $TeamID,
|
||||
UserID => $Param{UserID},
|
||||
);
|
||||
if ( $Team{Name} ) {
|
||||
push @Teams, $Team{Name};
|
||||
}
|
||||
}
|
||||
}
|
||||
if (@Teams) {
|
||||
$ICalEvent->add_properties(
|
||||
"x-otrs-team" => join( ',', @Teams ),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
# include resource names
|
||||
if ( $Appointment{ResourceID} ) {
|
||||
my @Users;
|
||||
|
||||
# get user object
|
||||
my $UserObject = $Kernel::OM->Get('Kernel::System::User');
|
||||
|
||||
# get user data
|
||||
for my $UserID ( @{ $Appointment{ResourceID} } ) {
|
||||
if ($UserID) {
|
||||
my %User = $UserObject->GetUserData(
|
||||
UserID => $UserID,
|
||||
);
|
||||
if ( $User{UserLogin} ) {
|
||||
push @Users, $User{UserLogin};
|
||||
}
|
||||
}
|
||||
}
|
||||
if (@Users) {
|
||||
$ICalEvent->add_properties(
|
||||
"x-otrs-resource" => join( ',', @Users ),
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# include plugin (link) data
|
||||
my $PluginList = $PluginObject->PluginList();
|
||||
for my $PluginKey ( sort keys %{$PluginList} ) {
|
||||
my $LinkList = $PluginObject->PluginLinkList(
|
||||
AppointmentID => $Appointment{AppointmentID},
|
||||
PluginKey => $PluginKey,
|
||||
UserID => $Param{UserID},
|
||||
);
|
||||
my @LinkArray;
|
||||
for my $LinkID ( sort keys %{$LinkList} ) {
|
||||
push @LinkArray, $LinkList->{$LinkID}->{LinkID};
|
||||
}
|
||||
|
||||
if (@LinkArray) {
|
||||
$ICalEvent->add_properties(
|
||||
"x-otrs-plugin-$PluginKey" => join( ',', @LinkArray ),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
# add both required and optional properties
|
||||
# remove time zone flag for all day appointments
|
||||
$ICalEvent->add_properties(
|
||||
summary => $Appointment{Title},
|
||||
dtstart => $Appointment{AllDay} ? substr( $ICalStartTime->ical(), 0, -1 ) : $ICalStartTime->ical(),
|
||||
dtend => $Appointment{AllDay} ? substr( $ICalEndTime->ical(), 0, -1 ) : $ICalEndTime->ical(),
|
||||
uid => $Appointment{UniqueID},
|
||||
'last-modified' => $ICalChangeTime->ical(),
|
||||
%ICalEventProperties,
|
||||
);
|
||||
|
||||
# add repeatable properties
|
||||
for my $Repeatable (@ICalRepeatableProperties) {
|
||||
$ICalEvent->add_properties(
|
||||
$Repeatable->{Property} => $Repeatable->{Value},
|
||||
);
|
||||
}
|
||||
|
||||
$ICalCalendar->add_entry($ICalEvent);
|
||||
}
|
||||
|
||||
return $ICalCalendar->as_string();
|
||||
}
|
||||
|
||||
{
|
||||
no warnings 'redefine'; ## no critic
|
||||
|
||||
# Include product name and version in product ID property for debugging purposes, by redefining
|
||||
# external library method.
|
||||
sub Data::ICal::product_id { ## no critic
|
||||
return 'OTRS ' . $Kernel::OM->Get('Kernel::Config')->Get('Version');
|
||||
}
|
||||
}
|
||||
|
||||
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
|
||||
799
Perl OTRS/Kernel/System/Calendar/Import/ICal.pm
Normal file
799
Perl OTRS/Kernel/System/Calendar/Import/ICal.pm
Normal file
@@ -0,0 +1,799 @@
|
||||
# --
|
||||
# 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::Import::ICal;
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
use Data::ICal;
|
||||
use Data::ICal::Entry::Event;
|
||||
use Date::ICal;
|
||||
|
||||
use Kernel::System::VariableCheck qw(:all);
|
||||
|
||||
our @ObjectDependencies = (
|
||||
'Kernel::Config',
|
||||
'Kernel::System::Cache',
|
||||
'Kernel::System::Calendar',
|
||||
'Kernel::System::Calendar::Appointment',
|
||||
'Kernel::System::Calendar::Plugin',
|
||||
'Kernel::System::Calendar::Team',
|
||||
'Kernel::System::DateTime',
|
||||
'Kernel::System::DB',
|
||||
'Kernel::System::Encode',
|
||||
'Kernel::System::Log',
|
||||
'Kernel::System::Main',
|
||||
'Kernel::System::User',
|
||||
);
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Kernel::System::Calendar::Import::ICal - C<iCalendar> import lib
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
Import functions for C<iCalendar> format.
|
||||
|
||||
=head1 PUBLIC INTERFACE
|
||||
|
||||
=head2 new()
|
||||
|
||||
create an object. Do not use it directly, instead use:
|
||||
|
||||
use Kernel::System::ObjectManager;
|
||||
local $Kernel::OM = Kernel::System::ObjectManager->new();
|
||||
my $ImportObject = $Kernel::OM->Get('Kernel::System::Calendar::Export::ICal');
|
||||
|
||||
=cut
|
||||
|
||||
sub new {
|
||||
my ( $Type, %Param ) = @_;
|
||||
|
||||
# allocate new hash for object
|
||||
my $Self = {%Param};
|
||||
bless( $Self, $Type );
|
||||
|
||||
return $Self;
|
||||
}
|
||||
|
||||
=head2 Import()
|
||||
|
||||
Import calendar in C<iCalendar> format.
|
||||
|
||||
my $Success = $ImportObject->Import(
|
||||
CalendarID => 123,
|
||||
ICal => # (required) iCal string
|
||||
'
|
||||
BEGIN:VCALENDAR
|
||||
PRODID:Zimbra-Calendar-Provider
|
||||
VERSION:2.0
|
||||
METHOD:REQUEST
|
||||
...
|
||||
',
|
||||
UserID => 1, # (required) UserID
|
||||
UpdateExisting => 0, # (optional) Delete existing Appointments within same Calendar if UniqueID matches
|
||||
UntilLimit => '2017-01-01 00:00:00', # (optional) If provided, system will use this value for limiting recurring Appointments without defined end date
|
||||
# instead of AppointmentCalendar::Import::RecurringMonthsLimit to do the calculation
|
||||
# NOTE: PLEASE USE THIS PARAMETER FOR UNIT TESTS ONLY
|
||||
);
|
||||
|
||||
Returns number of imported appointments if successful, otherwise 0.
|
||||
|
||||
=cut
|
||||
|
||||
sub Import {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(CalendarID ICal UserID)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
my $UntilLimitedTimestamp = $Param{UntilLimit} || '';
|
||||
|
||||
if ( !$UntilLimitedTimestamp ) {
|
||||
|
||||
# Calculate until time which will be used if there is any recurring Appointment without end
|
||||
# time defined.
|
||||
my $UntilTimeObject = $Kernel::OM->Create('Kernel::System::DateTime');
|
||||
my $RecurringMonthsLimit
|
||||
= $Kernel::OM->Get('Kernel::Config')->Get("AppointmentCalendar::Import::RecurringMonthsLimit")
|
||||
|| '12'; # default 12 months
|
||||
|
||||
$UntilTimeObject->Add(
|
||||
Months => $RecurringMonthsLimit,
|
||||
);
|
||||
$UntilLimitedTimestamp = $UntilTimeObject->ToString();
|
||||
}
|
||||
|
||||
# Turn on UTF8 flag on supplied string for correct encoding in PostgreSQL backend.
|
||||
$Kernel::OM->Get('Kernel::System::Encode')->EncodeInput( \$Param{ICal} );
|
||||
|
||||
my $Calendar = Data::ICal->new( data => $Param{ICal} );
|
||||
|
||||
# If external library encountered an error while parsing the ICS file, log the received message
|
||||
# at this time and return.
|
||||
if ( $Calendar->{errno} ) {
|
||||
my $ErrorMessage = $Calendar->{error_message} // '';
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "[Data::ICal] $ErrorMessage",
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
my @Entries = @{ $Calendar->entries() };
|
||||
my $AppointmentsImported = 0;
|
||||
|
||||
my $PluginObject = $Kernel::OM->Get('Kernel::System::Calendar::Plugin');
|
||||
my $AppointmentObject = $Kernel::OM->Get('Kernel::System::Calendar::Appointment');
|
||||
|
||||
ENTRY:
|
||||
for my $Entry (@Entries) {
|
||||
my $Properties = $Entry->properties();
|
||||
|
||||
my %Parameters;
|
||||
my %LinkedObjects;
|
||||
|
||||
# get uid
|
||||
if (
|
||||
IsArrayRefWithData( $Properties->{'uid'} )
|
||||
&& ref $Properties->{'uid'}->[0] eq 'Data::ICal::Property'
|
||||
&& $Properties->{'uid'}->[0]->{'value'}
|
||||
)
|
||||
{
|
||||
$Parameters{UniqueID} = $Properties->{'uid'}->[0]->{'value'};
|
||||
}
|
||||
|
||||
# get title
|
||||
if (
|
||||
IsArrayRefWithData( $Properties->{'summary'} )
|
||||
&& ref $Properties->{'summary'}->[0] eq 'Data::ICal::Property'
|
||||
&& $Properties->{'summary'}->[0]->{'value'}
|
||||
)
|
||||
{
|
||||
$Parameters{Title} = $Properties->{'summary'}->[0]->{'value'};
|
||||
}
|
||||
|
||||
# get description
|
||||
if (
|
||||
IsArrayRefWithData( $Properties->{'description'} )
|
||||
&& ref $Properties->{'description'}->[0] eq 'Data::ICal::Property'
|
||||
&& $Properties->{'description'}->[0]->{'value'}
|
||||
)
|
||||
{
|
||||
$Parameters{Description} = $Properties->{'description'}->[0]->{'value'};
|
||||
}
|
||||
|
||||
# get start time
|
||||
if (
|
||||
IsArrayRefWithData( $Properties->{'dtstart'} )
|
||||
&& ref $Properties->{'dtstart'}->[0] eq 'Data::ICal::Property'
|
||||
&& $Properties->{'dtstart'}->[0]->{'value'}
|
||||
)
|
||||
{
|
||||
|
||||
my $TimezoneID;
|
||||
|
||||
if ( ref $Properties->{'dtstart'}->[0]->{'_parameters'} eq 'HASH' ) {
|
||||
|
||||
# check if it's an all day event
|
||||
# 1) there is no time component for the date value
|
||||
# 2) there is an explicit value parameter set to DATE
|
||||
if (
|
||||
length $Properties->{'dtstart'}->[0]->{'value'} == 8
|
||||
||
|
||||
(
|
||||
$Properties->{'dtstart'}->[0]->{'_parameters'}->{'VALUE'}
|
||||
&& $Properties->{'dtstart'}->[0]->{'_parameters'}->{'VALUE'} eq 'DATE'
|
||||
)
|
||||
)
|
||||
{
|
||||
$Parameters{AllDay} = 1;
|
||||
}
|
||||
|
||||
# check timezone
|
||||
if ( $Properties->{'dtstart'}->[0]->{'_parameters'}->{'TZID'} ) {
|
||||
$TimezoneID = $Properties->{'dtstart'}->[0]->{'_parameters'}->{'TZID'};
|
||||
}
|
||||
}
|
||||
|
||||
my $StartTimeICal = $Self->_FormatTime(
|
||||
Time => $Properties->{'dtstart'}->[0]->{'value'},
|
||||
);
|
||||
my $StartTimeObject = $Kernel::OM->Create(
|
||||
'Kernel::System::DateTime',
|
||||
ObjectParams => {
|
||||
String => $StartTimeICal,
|
||||
TimeZone => $TimezoneID,
|
||||
},
|
||||
);
|
||||
|
||||
if ( !$Parameters{AllDay} ) {
|
||||
$StartTimeObject->ToOTRSTimeZone();
|
||||
}
|
||||
|
||||
$Parameters{StartTime} = $StartTimeObject->ToString();
|
||||
}
|
||||
|
||||
# get end time
|
||||
if (
|
||||
IsArrayRefWithData( $Properties->{'dtend'} )
|
||||
&& ref $Properties->{'dtend'}->[0] eq 'Data::ICal::Property'
|
||||
&& $Properties->{'dtend'}->[0]->{'value'}
|
||||
)
|
||||
{
|
||||
my $TimezoneID;
|
||||
|
||||
if ( ref $Properties->{'dtend'}->[0]->{'_parameters'} eq 'HASH' ) {
|
||||
|
||||
# check timezone
|
||||
if ( $Properties->{'dtend'}->[0]->{'_parameters'}->{'TZID'} ) {
|
||||
$TimezoneID = $Properties->{'dtend'}->[0]->{'_parameters'}->{'TZID'};
|
||||
}
|
||||
}
|
||||
|
||||
my $EndTimeICal = $Self->_FormatTime(
|
||||
Time => $Properties->{'dtend'}->[0]->{'value'},
|
||||
);
|
||||
my $EndTimeObject = $Kernel::OM->Create(
|
||||
'Kernel::System::DateTime',
|
||||
ObjectParams => {
|
||||
String => $EndTimeICal,
|
||||
TimeZone => $TimezoneID,
|
||||
},
|
||||
);
|
||||
|
||||
if ( !$Parameters{AllDay} ) {
|
||||
$EndTimeObject->ToOTRSTimeZone();
|
||||
}
|
||||
|
||||
$Parameters{EndTime} = $EndTimeObject->ToString();
|
||||
}
|
||||
|
||||
# Some iCalendar implementations (looking at you icalendar-ruby) do not require nor include
|
||||
# end time for appointments. In this case, prevent failing and use start time instead.
|
||||
else {
|
||||
$Parameters{EndTime} = $Parameters{StartTime};
|
||||
}
|
||||
|
||||
# get location
|
||||
if (
|
||||
IsArrayRefWithData( $Properties->{'location'} )
|
||||
&& ref $Properties->{'location'}->[0] eq 'Data::ICal::Property'
|
||||
&& $Properties->{'location'}->[0]->{'value'}
|
||||
)
|
||||
{
|
||||
$Parameters{Location} = $Properties->{'location'}->[0]->{'value'};
|
||||
}
|
||||
|
||||
# get rrule
|
||||
if (
|
||||
IsArrayRefWithData( $Properties->{'rrule'} )
|
||||
&& ref $Properties->{'rrule'}->[0] eq 'Data::ICal::Property'
|
||||
&& $Properties->{'rrule'}->[0]->{'value'}
|
||||
)
|
||||
{
|
||||
my ( $Frequency, $Until, $Interval, $Count, $DayNames, $MonthDay, $Months );
|
||||
|
||||
my @Rules = split ';', $Properties->{'rrule'}->[0]->{'value'};
|
||||
|
||||
RULE:
|
||||
for my $Rule (@Rules) {
|
||||
|
||||
if ( $Rule =~ /FREQ=(.*?)$/i ) {
|
||||
$Frequency = $1;
|
||||
}
|
||||
elsif ( $Rule =~ /UNTIL=(.*?)$/i ) {
|
||||
$Until = $1;
|
||||
}
|
||||
elsif ( $Rule =~ /INTERVAL=(\d+?)$/i ) {
|
||||
$Interval = $1;
|
||||
}
|
||||
elsif ( $Rule =~ /COUNT=(\d+?)$/i ) {
|
||||
$Count = $1;
|
||||
}
|
||||
elsif ( $Rule =~ /BYDAY=(.*?)$/i ) {
|
||||
$DayNames = $1;
|
||||
}
|
||||
elsif ( $Rule =~ /BYMONTHDAY=(.*?)$/i ) {
|
||||
$MonthDay = $1;
|
||||
}
|
||||
elsif ( $Rule =~ /BYMONTH=(.*?)$/i ) {
|
||||
$Months = $1;
|
||||
}
|
||||
}
|
||||
|
||||
$Interval ||= 1; # default value
|
||||
|
||||
# this appointment is repeating
|
||||
if ( $Frequency eq "DAILY" ) {
|
||||
$Parameters{Recurring} = 1;
|
||||
$Parameters{RecurrenceType} = $Interval == 1 ? "Daily" : "CustomDaily";
|
||||
$Parameters{RecurrenceInterval} = $Interval;
|
||||
|
||||
}
|
||||
elsif ( $Frequency eq "WEEKLY" ) {
|
||||
if ($DayNames) {
|
||||
|
||||
# custom
|
||||
|
||||
my @Days;
|
||||
|
||||
# SU,MO,TU,WE,TH,FR,SA
|
||||
for my $DayName ( split( ',', $DayNames ) ) {
|
||||
|
||||
if ( uc $DayName eq 'MO' ) {
|
||||
push @Days, 1;
|
||||
}
|
||||
elsif ( uc $DayName eq 'TU' ) {
|
||||
push @Days, 2;
|
||||
}
|
||||
elsif ( uc $DayName eq 'WE' ) {
|
||||
push @Days, 3;
|
||||
}
|
||||
elsif ( uc $DayName eq 'TH' ) {
|
||||
push @Days, 4;
|
||||
}
|
||||
elsif ( uc $DayName eq 'FR' ) {
|
||||
push @Days, 5;
|
||||
}
|
||||
elsif ( uc $DayName eq 'SA' ) {
|
||||
push @Days, 6;
|
||||
}
|
||||
elsif ( uc $DayName eq 'SU' ) {
|
||||
push @Days, 7;
|
||||
}
|
||||
}
|
||||
|
||||
if ( scalar @Days > 0 ) {
|
||||
|
||||
$Parameters{Recurring} = 1;
|
||||
$Parameters{RecurrenceType} = "CustomWeekly";
|
||||
$Parameters{RecurrenceInterval} = $Interval;
|
||||
$Parameters{RecurrenceFrequency} = \@Days;
|
||||
}
|
||||
}
|
||||
else {
|
||||
# each n days
|
||||
$Parameters{Recurring} = 1;
|
||||
$Parameters{RecurrenceType} = "Weekly";
|
||||
$Parameters{RecurrenceInterval} = $Interval;
|
||||
}
|
||||
}
|
||||
elsif ( $Frequency eq "MONTHLY" ) {
|
||||
|
||||
# Skip unsupported custom monthly recurring rules:
|
||||
# - FREQ=MONTHLY;BYDAY=2SA
|
||||
if ($DayNames) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Skip import of unsupported recurring rule: "
|
||||
. $Properties->{'rrule'}->[0]->{'value'},
|
||||
);
|
||||
next ENTRY;
|
||||
}
|
||||
|
||||
if ($MonthDay) {
|
||||
|
||||
# Custom
|
||||
# FREQ=MONTHLY;UNTIL=20170101T080000Z;BYMONTHDAY=16,31'
|
||||
my @Days = split( ',', $MonthDay );
|
||||
|
||||
$Parameters{Recurring} = 1;
|
||||
$Parameters{RecurrenceType} = "CustomMonthly";
|
||||
$Parameters{RecurrenceFrequency} = \@Days;
|
||||
$Parameters{RecurrenceInterval} = $Interval;
|
||||
}
|
||||
else {
|
||||
$Parameters{Recurring} = 1;
|
||||
$Parameters{RecurrenceType} = "Monthly";
|
||||
$Parameters{RecurrenceInterval} = $Interval;
|
||||
}
|
||||
}
|
||||
elsif ( $Frequency eq "YEARLY" ) {
|
||||
|
||||
# Skip unsupported custom yearly recurring rules:
|
||||
# - FREQ=YEARLY;BYMONTH=3;BYDAY=-1SU
|
||||
# - FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU
|
||||
if ($DayNames) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Skip import of unsupported recurring rule: "
|
||||
. $Properties->{'rrule'}->[0]->{'value'},
|
||||
);
|
||||
next ENTRY;
|
||||
}
|
||||
|
||||
my @Months = split( ',', $Months || '' );
|
||||
|
||||
my $StartTimeObject = $Kernel::OM->Create(
|
||||
'Kernel::System::DateTime',
|
||||
ObjectParams => {
|
||||
String => $Parameters{StartTime},
|
||||
},
|
||||
);
|
||||
|
||||
if (
|
||||
scalar @Months > 1
|
||||
|| (
|
||||
scalar @Months == 1
|
||||
&& $StartTimeObject->Get()->{Day} != $Months[0]
|
||||
)
|
||||
)
|
||||
{
|
||||
$Parameters{Recurring} = 1;
|
||||
$Parameters{RecurrenceType} = "CustomYearly";
|
||||
$Parameters{RecurrenceFrequency} = \@Months;
|
||||
$Parameters{RecurrenceInterval} = $Interval;
|
||||
}
|
||||
else {
|
||||
$Parameters{Recurring} = 1;
|
||||
$Parameters{RecurrenceType} = "Yearly";
|
||||
$Parameters{RecurrenceInterval} = $Interval;
|
||||
}
|
||||
}
|
||||
|
||||
# FREQ=YEARLY;INTERVAL=2;BYMONTH=1,2,12
|
||||
# FREQ=MONTHLY;UNTIL=20170302T121500Z'
|
||||
# FREQ=MONTHLY;UNTIL=20170202T090000Z;INTERVAL=2;BYMONTHDAY=31',
|
||||
# FREQ=WEEKLY;INTERVAL=2;BYDAY=TU
|
||||
# FREQ=YEARLY;UNTIL=20200602T080000Z;INTERVAL=2;BYMONTHDAY=1;BYMONTH=4';
|
||||
|
||||
# FREQ=DAILY;COUNT=3
|
||||
|
||||
if ($Until) {
|
||||
$Parameters{RecurrenceUntil} = $Self->_FormatTime(
|
||||
Time => $Until,
|
||||
);
|
||||
}
|
||||
elsif ($Count) {
|
||||
$Parameters{RecurrenceCount} = $Count;
|
||||
}
|
||||
else {
|
||||
# default value
|
||||
$Parameters{RecurrenceUntil} = $UntilLimitedTimestamp;
|
||||
}
|
||||
|
||||
# excluded dates
|
||||
if ( IsArrayRefWithData( $Properties->{'exdate'} ) ) {
|
||||
my @RecurrenceExclude;
|
||||
for my $Exclude ( @{ $Properties->{'exdate'} } ) {
|
||||
if (
|
||||
ref $Exclude eq 'Data::ICal::Property'
|
||||
&& $Exclude->{'value'}
|
||||
)
|
||||
{
|
||||
my $TimezoneID;
|
||||
if ( ref $Exclude->{'_parameters'} eq 'HASH' ) {
|
||||
|
||||
# check timezone
|
||||
if ( $Exclude->{'_parameters'}->{'TZID'} ) {
|
||||
$TimezoneID = $Exclude->{'_parameters'}->{'TZID'};
|
||||
}
|
||||
}
|
||||
|
||||
my $ExcludeTimeICal = $Self->_FormatTime(
|
||||
Time => $Exclude->{'value'},
|
||||
);
|
||||
my $ExcludeTimeObject = $Kernel::OM->Create(
|
||||
'Kernel::System::DateTime',
|
||||
ObjectParams => {
|
||||
String => $ExcludeTimeICal,
|
||||
TimeZone => $TimezoneID,
|
||||
},
|
||||
);
|
||||
|
||||
if ( !$Parameters{AllDay} ) {
|
||||
$ExcludeTimeObject->ToOTRSTimeZone();
|
||||
}
|
||||
|
||||
push @RecurrenceExclude, $ExcludeTimeObject->ToString();
|
||||
}
|
||||
}
|
||||
$Parameters{RecurrenceExclude} = \@RecurrenceExclude;
|
||||
}
|
||||
}
|
||||
|
||||
# check if team object is registered
|
||||
if ( $Kernel::OM->Get('Kernel::System::Main')->Require( 'Kernel::System::Calendar::Team', Silent => 1 ) ) {
|
||||
|
||||
# get team
|
||||
if (
|
||||
IsArrayRefWithData( $Properties->{'x-otrs-team'} )
|
||||
&& ref $Properties->{'x-otrs-team'}->[0] eq 'Data::ICal::Property'
|
||||
&& $Properties->{'x-otrs-team'}->[0]->{'value'}
|
||||
)
|
||||
{
|
||||
my @Teams = split( ",", $Properties->{'x-otrs-team'}->[0]->{'value'} );
|
||||
|
||||
if (@Teams) {
|
||||
my @TeamIDs;
|
||||
|
||||
# get team ids
|
||||
for my $TeamName (@Teams) {
|
||||
my %Team = $Kernel::OM->Get('Kernel::System::Calendar::Team')->TeamGet(
|
||||
Name => $TeamName,
|
||||
UserID => $Param{UserID},
|
||||
);
|
||||
push @TeamIDs, $Team{ID} if $Team{ID};
|
||||
}
|
||||
$Parameters{TeamID} = \@TeamIDs if @TeamIDs;
|
||||
}
|
||||
}
|
||||
|
||||
# get resource
|
||||
if (
|
||||
IsArrayRefWithData( $Properties->{'x-otrs-resource'} )
|
||||
&& ref $Properties->{'x-otrs-resource'}->[0] eq 'Data::ICal::Property'
|
||||
&& $Properties->{'x-otrs-resource'}->[0]->{'value'}
|
||||
)
|
||||
{
|
||||
my @Resources = split( ",", $Properties->{'x-otrs-resource'}->[0]->{'value'} );
|
||||
|
||||
if (@Resources) {
|
||||
my @Users;
|
||||
|
||||
# get user ids
|
||||
for my $UserLogin (@Resources) {
|
||||
my $UserID = $Kernel::OM->Get('Kernel::System::User')->UserLookup(
|
||||
UserLogin => $UserLogin,
|
||||
);
|
||||
push @Users, $UserID if $UserID;
|
||||
}
|
||||
$Parameters{ResourceID} = \@Users if @Users;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# get available plugin keys suitable for lowercase search
|
||||
my $PluginKeys = $PluginObject->PluginKeys();
|
||||
|
||||
# plugin fields (start with 'x-otrs-plugin-')
|
||||
my @PluginFields = grep { $_ =~ /x-otrs-plugin-/i } keys %{$Properties};
|
||||
|
||||
PLUGINFIELD:
|
||||
for my $PluginField (@PluginFields) {
|
||||
if (
|
||||
IsArrayRefWithData( $Properties->{$PluginField} )
|
||||
&& ref $Properties->{$PluginField}->[0] eq 'Data::ICal::Property'
|
||||
&& $Properties->{$PluginField}->[0]->{'value'}
|
||||
)
|
||||
{
|
||||
# extract lowercase plugin key
|
||||
$PluginField =~ /x-otrs-plugin-(.*)$/;
|
||||
my $PluginKeyLC = $1;
|
||||
|
||||
# get proper plugin key
|
||||
my $PluginKey = $PluginKeys->{$PluginKeyLC};
|
||||
next PLUGINFIELD if !$PluginKey;
|
||||
|
||||
my @PluginData = split( ",", $Properties->{$PluginField}->[0]->{'value'} );
|
||||
$LinkedObjects{$PluginKey} = \@PluginData;
|
||||
}
|
||||
}
|
||||
|
||||
next ENTRY if !$Parameters{Title};
|
||||
|
||||
my %Appointment;
|
||||
|
||||
# get recurrence id
|
||||
if (
|
||||
IsArrayRefWithData( $Properties->{'recurrence-id'} )
|
||||
&& ref $Properties->{'recurrence-id'}->[0] eq 'Data::ICal::Property'
|
||||
&& $Properties->{'recurrence-id'}->[0]->{'value'}
|
||||
)
|
||||
{
|
||||
# get parent id
|
||||
my %ParentAppointment = $AppointmentObject->AppointmentGet(
|
||||
UniqueID => $Parameters{UniqueID},
|
||||
CalendarID => $Param{CalendarID},
|
||||
);
|
||||
next ENTRY if !%ParentAppointment;
|
||||
|
||||
$Parameters{ParentID} = $ParentAppointment{AppointmentID};
|
||||
|
||||
my $TimezoneID;
|
||||
if ( ref $Properties->{'recurrence-id'}->[0]->{'_parameters'} eq 'HASH' ) {
|
||||
|
||||
# check timezone
|
||||
if ( $Properties->{'recurrence-id'}->[0]->{'_parameters'}->{'TZID'} ) {
|
||||
$TimezoneID = $Properties->{'recurrence-id'}->[0]->{'_parameters'}->{'TZID'};
|
||||
}
|
||||
}
|
||||
|
||||
my $RecurrenceIDICal = $Self->_FormatTime(
|
||||
Time => $Properties->{'recurrence-id'}->[0]->{'value'},
|
||||
);
|
||||
my $RecurrenceIDObject = $Kernel::OM->Create(
|
||||
'Kernel::System::DateTime',
|
||||
ObjectParams => {
|
||||
String => $RecurrenceIDICal,
|
||||
TimeZone => $TimezoneID,
|
||||
},
|
||||
);
|
||||
|
||||
if ( !$Parameters{AllDay} ) {
|
||||
$RecurrenceIDObject->ToOTRSTimeZone();
|
||||
}
|
||||
|
||||
$Param{RecurrenceID} = $RecurrenceIDObject->ToString();
|
||||
|
||||
# delete existing overridden occurrence
|
||||
$AppointmentObject->AppointmentDeleteOccurrence(
|
||||
UniqueID => $Parameters{UniqueID},
|
||||
CalendarID => $Param{CalendarID},
|
||||
RecurrenceID => $Param{RecurrenceID},
|
||||
UserID => $Param{UserID},
|
||||
);
|
||||
}
|
||||
|
||||
# Check if appointment with same UniqueID in the same calendar already exists.
|
||||
else {
|
||||
%Appointment = $AppointmentObject->AppointmentGet(
|
||||
UniqueID => $Parameters{UniqueID},
|
||||
CalendarID => $Param{CalendarID},
|
||||
);
|
||||
|
||||
if (
|
||||
$Appointment{CalendarID}
|
||||
&& ( !$Param{UpdateExisting} || $Appointment{CalendarID} != $Param{CalendarID} )
|
||||
)
|
||||
{
|
||||
# If overwrite option isn't activated, create new appointment by clearing the
|
||||
# UniqueID.
|
||||
if (%Appointment) {
|
||||
delete $Parameters{UniqueID};
|
||||
}
|
||||
%Appointment = ();
|
||||
}
|
||||
}
|
||||
|
||||
my $Success;
|
||||
|
||||
# appointment exists in same Calendar, update it
|
||||
if (
|
||||
%Appointment
|
||||
&& $Appointment{AppointmentID}
|
||||
&& $Param{CalendarID} == $Appointment{CalendarID}
|
||||
)
|
||||
{
|
||||
$Success = $AppointmentObject->AppointmentUpdate(
|
||||
CalendarID => $Param{CalendarID},
|
||||
AppointmentID => $Appointment{AppointmentID},
|
||||
UserID => $Param{UserID},
|
||||
%Parameters,
|
||||
);
|
||||
}
|
||||
|
||||
# there is no appointment, create new one
|
||||
else {
|
||||
$Success = $AppointmentObject->AppointmentCreate(
|
||||
CalendarID => $Param{CalendarID},
|
||||
UserID => $Param{UserID},
|
||||
%Parameters,
|
||||
);
|
||||
}
|
||||
|
||||
if ($Success) {
|
||||
|
||||
PLUGINKEY:
|
||||
for my $PluginKey ( sort keys %LinkedObjects ) {
|
||||
next PLUGINKEY if !IsArrayRefWithData( $LinkedObjects{$PluginKey} );
|
||||
|
||||
# add links
|
||||
for my $PluginData ( @{ $LinkedObjects{$PluginKey} } ) {
|
||||
my $LinkSuccess = $PluginObject->PluginLinkAdd(
|
||||
AppointmentID => $Success,
|
||||
PluginKey => $PluginKey,
|
||||
PluginData => $PluginData,
|
||||
UserID => $Param{UserID},
|
||||
);
|
||||
|
||||
if ( !$LinkSuccess ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message =>
|
||||
"Unable to create object link (AppointmentID=$Success - $PluginKey=$PluginData) during calendar import!"
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$AppointmentsImported++;
|
||||
}
|
||||
}
|
||||
|
||||
return $AppointmentsImported;
|
||||
}
|
||||
|
||||
sub _FormatTime {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(Time)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
my $TimeStamp;
|
||||
|
||||
if ( $Param{Time} =~ /(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})(\d{2})/i ) {
|
||||
|
||||
# format string
|
||||
$TimeStamp = "$1-$2-$3 $4:$5:$6";
|
||||
}
|
||||
elsif ( $Param{Time} =~ /(\d{4})(\d{2})(\d{2})/ ) {
|
||||
|
||||
# only date is given (without time)
|
||||
$TimeStamp = "$1-$2-$3 00:00:00";
|
||||
}
|
||||
|
||||
return $TimeStamp;
|
||||
}
|
||||
|
||||
{
|
||||
no warnings 'redefine'; ## no critic
|
||||
|
||||
# Include additional optional repeatable properties used by some iCalendar implementations, in
|
||||
# order to prevent Perl warnings.
|
||||
sub Data::ICal::Entry::Alarm::optional_repeatable_properties { ## no critic
|
||||
qw(
|
||||
uid acknowledged related-to description
|
||||
);
|
||||
}
|
||||
|
||||
sub Data::ICal::Entry::Event::optional_repeatable_properties { ## no critic
|
||||
my $Self = shift;
|
||||
|
||||
my @Properties;
|
||||
|
||||
if ( not $Self->vcal10 ) { ## no critic
|
||||
@Properties = qw(
|
||||
attach attendee categories comment
|
||||
contact exdate exrule request-status related-to
|
||||
resources rdate rrule
|
||||
);
|
||||
}
|
||||
else {
|
||||
@Properties = qw(
|
||||
aalarm attach attendee categories
|
||||
dalarm exdate exrule malarm palarm related-to
|
||||
resources rdate rrule
|
||||
);
|
||||
}
|
||||
|
||||
push @Properties, '';
|
||||
|
||||
return @Properties;
|
||||
}
|
||||
}
|
||||
|
||||
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
|
||||
277
Perl OTRS/Kernel/System/Calendar/Plugin.pm
Normal file
277
Perl OTRS/Kernel/System/Calendar/Plugin.pm
Normal file
@@ -0,0 +1,277 @@
|
||||
# --
|
||||
# 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::Plugin;
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
use Kernel::System::VariableCheck qw(:all);
|
||||
|
||||
our @ObjectDependencies = (
|
||||
'Kernel::Config',
|
||||
'Kernel::System::Log',
|
||||
'Kernel::System::Main',
|
||||
'Kernel::System::LinkObject',
|
||||
);
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Kernel::System::Calendar::Plugin - Plugin lib
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
Abstraction layer for appointment plugins.
|
||||
|
||||
=head1 PUBLIC INTERFACE
|
||||
|
||||
=head2 new()
|
||||
|
||||
create an object. Do not use it directly, instead use:
|
||||
|
||||
use Kernel::System::ObjectManager;
|
||||
local $Kernel::OM = Kernel::System::ObjectManager->new();
|
||||
my $TeamObject = $Kernel::OM->Get('Kernel::System::Calendar::Plugin');
|
||||
|
||||
=cut
|
||||
|
||||
sub new {
|
||||
my ( $Type, %Param ) = @_;
|
||||
|
||||
# allocate new hash for object
|
||||
my $Self = {};
|
||||
bless( $Self, $Type );
|
||||
|
||||
# get registered plugin modules
|
||||
my $PluginConfig = $Kernel::OM->Get('Kernel::Config')->Get("AppointmentCalendar::Plugin");
|
||||
|
||||
my $MainObject = $Kernel::OM->Get('Kernel::System::Main');
|
||||
|
||||
# load plugin modules
|
||||
PLUGIN:
|
||||
for my $PluginKey ( sort keys %{$PluginConfig} ) {
|
||||
|
||||
my $GenericModule = $PluginConfig->{$PluginKey}->{Module};
|
||||
next PLUGIN if !$GenericModule;
|
||||
|
||||
if ( !$MainObject->Require($GenericModule) ) {
|
||||
$MainObject->Die("Can't load plugin module $GenericModule! $@");
|
||||
}
|
||||
|
||||
$Self->{Plugins}->{$PluginKey}->{PluginName} = $PluginConfig->{$PluginKey}->{Name} // $GenericModule;
|
||||
$Self->{Plugins}->{$PluginKey}->{PluginModule} = $GenericModule->new( %{$Self} );
|
||||
|
||||
my $PluginURL = $PluginConfig->{$PluginKey}->{URL};
|
||||
$PluginURL =~ s{<OTRS_CONFIG_(.+?)>}{$Kernel::OM->Get('Kernel::Config')->Get($1)}egx;
|
||||
$Self->{Plugins}->{$PluginKey}->{PluginURL} = $PluginURL;
|
||||
}
|
||||
|
||||
return $Self;
|
||||
}
|
||||
|
||||
=head2 PluginList()
|
||||
|
||||
returns the hash of registered plugins
|
||||
|
||||
my $PluginList = $PluginObject->PluginList();
|
||||
|
||||
=cut
|
||||
|
||||
sub PluginList {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
my %PluginList = map {
|
||||
$_ => {
|
||||
PluginName => $Self->{Plugins}->{$_}->{PluginName},
|
||||
PluginURL => $Self->{Plugins}->{$_}->{PluginURL},
|
||||
}
|
||||
} keys %{ $Self->{Plugins} };
|
||||
|
||||
return \%PluginList;
|
||||
}
|
||||
|
||||
=head2 PluginKeys()
|
||||
|
||||
returns the hash of proper plugin keys for lowercase matching
|
||||
|
||||
my $PluginKeys = $PluginObject->PluginKeys();
|
||||
|
||||
=cut
|
||||
|
||||
sub PluginKeys {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
my %PluginKeys = map {
|
||||
lc $_ => $_
|
||||
} keys %{ $Self->{Plugins} };
|
||||
|
||||
return \%PluginKeys;
|
||||
}
|
||||
|
||||
=head2 PluginLinkAdd()
|
||||
|
||||
link appointment by plugin
|
||||
|
||||
my $Success = $PluginObject->PluginLinkAdd(
|
||||
AppointmentID => 1,
|
||||
PluginKey => '0100-Ticket',
|
||||
PluginData => '42',
|
||||
UserID => 1,
|
||||
);
|
||||
|
||||
=cut
|
||||
|
||||
sub PluginLinkAdd {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(AppointmentID PluginKey PluginData UserID)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
my $Success = $Self->{Plugins}->{ $Param{PluginKey} }->{PluginModule}->LinkAdd(
|
||||
%Param,
|
||||
);
|
||||
|
||||
return $Success;
|
||||
}
|
||||
|
||||
=head2 PluginLinkList()
|
||||
|
||||
returns list of links for supplied appointment
|
||||
|
||||
my $LinkList = $PluginObject->PluginLinkList(
|
||||
AppointmentID => 1,
|
||||
PluginKey => '0100-Ticket',
|
||||
UserID => 1,
|
||||
);
|
||||
|
||||
=cut
|
||||
|
||||
sub PluginLinkList {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(AppointmentID PluginKey UserID)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
$Param{PluginURL} = $Self->{Plugins}->{ $Param{PluginKey} }->{PluginURL};
|
||||
|
||||
my $LinkList = $Self->{Plugins}->{ $Param{PluginKey} }->{PluginModule}->LinkList(%Param);
|
||||
|
||||
return $LinkList;
|
||||
}
|
||||
|
||||
=head2 PluginLinkDelete()
|
||||
|
||||
removes all links for an appointment
|
||||
|
||||
my $Success = $PluginObject->PluginLinkDelete(
|
||||
AppointmentID => 1,
|
||||
UserID => 1,
|
||||
);
|
||||
|
||||
=cut
|
||||
|
||||
sub PluginLinkDelete {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(AppointmentID UserID)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
my $Success = $Kernel::OM->Get('Kernel::System::LinkObject')->LinkDeleteAll(
|
||||
Object => 'Appointment',
|
||||
Key => $Param{AppointmentID},
|
||||
UserID => $Param{UserID},
|
||||
);
|
||||
|
||||
if ( !$Success ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Unable to delete plugin links!",
|
||||
);
|
||||
}
|
||||
|
||||
return $Success;
|
||||
}
|
||||
|
||||
=head2 PluginSearch()
|
||||
|
||||
search for plugin objects
|
||||
|
||||
my $ResultList = $PluginObject->PluginSearch(
|
||||
PluginKey => $PluginKey, # (required)
|
||||
|
||||
Search => $Search, # (required) Search string
|
||||
# or
|
||||
ObjectID => $ObjectID # (required) Object ID
|
||||
|
||||
UserID => $Self->{UserID}, # (required)
|
||||
);
|
||||
|
||||
=cut
|
||||
|
||||
sub PluginSearch {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(PluginKey UserID)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
if ( !$Param{Search} && !$Param{ObjectID} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => 'Need either Search or ObjectID!',
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
my $ResultList = $Self->{Plugins}->{ $Param{PluginKey} }->{PluginModule}->Search(
|
||||
%Param,
|
||||
);
|
||||
|
||||
return $ResultList;
|
||||
}
|
||||
|
||||
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
|
||||
247
Perl OTRS/Kernel/System/Calendar/Plugin/Ticket.pm
Normal file
247
Perl OTRS/Kernel/System/Calendar/Plugin/Ticket.pm
Normal file
@@ -0,0 +1,247 @@
|
||||
# --
|
||||
# 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::Plugin::Ticket;
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
use Kernel::System::VariableCheck qw(:all);
|
||||
|
||||
our @ObjectDependencies = (
|
||||
'Kernel::System::Log',
|
||||
'Kernel::System::LinkObject',
|
||||
'Kernel::System::Ticket',
|
||||
);
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Kernel::System::Calendar::Plugin::Ticket - Ticket plugin
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
Ticket appointment plugin.
|
||||
|
||||
=head1 PUBLIC INTERFACE
|
||||
|
||||
=head2 new()
|
||||
|
||||
create an object. Do not use it directly, instead use:
|
||||
|
||||
use Kernel::System::ObjectManager;
|
||||
local $Kernel::OM = Kernel::System::ObjectManager->new();
|
||||
my $TicketPluginObject = $Kernel::OM->Get('Kernel::System::Calendar::Plugin::Ticket');
|
||||
|
||||
=cut
|
||||
|
||||
sub new {
|
||||
my ( $Type, %Param ) = @_;
|
||||
|
||||
# allocate new hash for object
|
||||
my $Self = {};
|
||||
bless( $Self, $Type );
|
||||
|
||||
return $Self;
|
||||
}
|
||||
|
||||
=head2 LinkAdd()
|
||||
|
||||
adds a link from an appointment to the ticket
|
||||
|
||||
my $Success = $TicketPluginObject->LinkAdd(
|
||||
AppointmentID => 123,
|
||||
PluginData => $TicketID,
|
||||
UserID => 1,
|
||||
);
|
||||
|
||||
=cut
|
||||
|
||||
sub LinkAdd {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(AppointmentID PluginData UserID)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
# check ticket id
|
||||
my %Ticket = $Kernel::OM->Get('Kernel::System::Ticket')->TicketGet(
|
||||
TicketID => $Param{PluginData},
|
||||
UserID => $Param{UserID},
|
||||
);
|
||||
return if !%Ticket;
|
||||
|
||||
my $Success = $Kernel::OM->Get('Kernel::System::LinkObject')->LinkAdd(
|
||||
SourceObject => 'Appointment',
|
||||
SourceKey => $Param{AppointmentID},
|
||||
TargetObject => 'Ticket',
|
||||
TargetKey => $Param{PluginData},
|
||||
Type => 'Normal',
|
||||
State => 'Valid',
|
||||
UserID => $Param{UserID},
|
||||
);
|
||||
|
||||
return $Success;
|
||||
}
|
||||
|
||||
=head2 LinkList()
|
||||
|
||||
returns a hash of linked tickets to an appointment
|
||||
|
||||
my $Success = $TicketPluginObject->LinkList(
|
||||
AppointmentID => 123,
|
||||
UserID => 1,
|
||||
);
|
||||
|
||||
=cut
|
||||
|
||||
sub LinkList {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(AppointmentID UserID PluginURL)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
my %LinkKeyList = $Kernel::OM->Get('Kernel::System::LinkObject')->LinkKeyListWithData(
|
||||
Object1 => 'Appointment',
|
||||
Key1 => $Param{AppointmentID},
|
||||
Object2 => 'Ticket',
|
||||
State => 'Valid',
|
||||
UserID => $Param{UserID},
|
||||
);
|
||||
|
||||
my %Result = map {
|
||||
$_ => {
|
||||
LinkID => $LinkKeyList{$_}->{TicketID},
|
||||
LinkName => $LinkKeyList{$_}->{TicketNumber} . ' ' . $LinkKeyList{$_}->{Title},
|
||||
LinkURL => sprintf( $Param{PluginURL}, $LinkKeyList{$_}->{TicketID} ),
|
||||
}
|
||||
} keys %LinkKeyList;
|
||||
|
||||
return \%Result;
|
||||
}
|
||||
|
||||
=head2 Search()
|
||||
|
||||
search for ticket and return a hash of found tickets
|
||||
|
||||
my $ResultList = $TicketPluginObject->Search(
|
||||
Search => '**', # search by ticket number or title
|
||||
# or
|
||||
ObjectID => 1, # search by ticket ID (single result)
|
||||
|
||||
UserID => 1,
|
||||
);
|
||||
|
||||
=cut
|
||||
|
||||
sub Search {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(UserID)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
if ( !$Param{Search} && !$Param{ObjectID} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => 'Need either Search or ObjectID!',
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
# get ticket object
|
||||
my $TicketObject = $Kernel::OM->Get('Kernel::System::Ticket');
|
||||
|
||||
my @TicketIDs;
|
||||
if ( $Param{Search} ) {
|
||||
|
||||
# search the tickets by ticket number
|
||||
@TicketIDs = $TicketObject->TicketSearch(
|
||||
TicketNumber => $Param{Search},
|
||||
Limit => 100,
|
||||
Result => 'ARRAY',
|
||||
ArchiveFlags => ['n'],
|
||||
UserID => $Param{UserID},
|
||||
);
|
||||
|
||||
# try the title search if no results were found
|
||||
if ( !@TicketIDs ) {
|
||||
@TicketIDs = $TicketObject->TicketSearch(
|
||||
Title => '%' . $Param{Search},
|
||||
Limit => 100,
|
||||
Result => 'ARRAY',
|
||||
ArchiveFlags => ['n'],
|
||||
UserID => $Param{UserID},
|
||||
);
|
||||
}
|
||||
}
|
||||
elsif ( $Param{ObjectID} ) {
|
||||
@TicketIDs = $TicketObject->TicketSearch(
|
||||
TicketID => $Param{ObjectID},
|
||||
Limit => 100,
|
||||
Result => 'ARRAY',
|
||||
ArchiveFlags => ['n'],
|
||||
UserID => $Param{UserID},
|
||||
);
|
||||
}
|
||||
|
||||
my %ResultList;
|
||||
|
||||
# clean the results
|
||||
TICKET:
|
||||
for my $TicketID (@TicketIDs) {
|
||||
|
||||
next TICKET if !$TicketID;
|
||||
|
||||
# get ticket data
|
||||
my %Ticket = $TicketObject->TicketGet(
|
||||
TicketID => $TicketID,
|
||||
DynamicFields => 0,
|
||||
UserID => $Self->{UserID},
|
||||
);
|
||||
|
||||
next TICKET if !%Ticket;
|
||||
|
||||
# generate the ticket information string
|
||||
$ResultList{ $Ticket{TicketID} } = $Ticket{TicketNumber} . ' ' . $Ticket{Title};
|
||||
}
|
||||
|
||||
return \%ResultList;
|
||||
}
|
||||
|
||||
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
|
||||
154
Perl OTRS/Kernel/System/Calendar/Ticket/DynamicField.pm
Normal file
154
Perl OTRS/Kernel/System/Calendar/Ticket/DynamicField.pm
Normal file
@@ -0,0 +1,154 @@
|
||||
# --
|
||||
# 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::Ticket::DynamicField;
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
use Kernel::System::VariableCheck qw(:all);
|
||||
|
||||
our @ObjectDependencies = (
|
||||
'Kernel::System::Log',
|
||||
'Kernel::System::DynamicField',
|
||||
'Kernel::System::DynamicFieldValue',
|
||||
'Kernel::System::Ticket',
|
||||
);
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Kernel::System::Calendar::Ticket::DynamicField - DynamicField appointment type
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
DynamicField ticket appointment type.
|
||||
|
||||
=head1 PUBLIC INTERFACE
|
||||
|
||||
=head2 new()
|
||||
|
||||
create an object. Do not use it directly, instead use:
|
||||
|
||||
use Kernel::System::ObjectManager;
|
||||
local $Kernel::OM = Kernel::System::ObjectManager->new();
|
||||
my $TicketDynamicFieldObject = $Kernel::OM->Get('Kernel::System::Calendar::Ticket::DynamicField');
|
||||
|
||||
=cut
|
||||
|
||||
sub new {
|
||||
my ( $Type, %Param ) = @_;
|
||||
|
||||
# allocate new hash for object
|
||||
my $Self = {};
|
||||
bless( $Self, $Type );
|
||||
|
||||
return $Self;
|
||||
}
|
||||
|
||||
=head2 GetTime()
|
||||
|
||||
returns time value for dynamic field appointment type.
|
||||
|
||||
my $StartTime = $TicketDynamicFieldObject->GetTime(
|
||||
Type => 'DynamicField_TestDate',
|
||||
TicketID => 1,
|
||||
);
|
||||
|
||||
=cut
|
||||
|
||||
sub GetTime {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(Type TicketID)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
# get ticket data incl. dynamic fields
|
||||
my %Ticket = $Kernel::OM->Get('Kernel::System::Ticket')->TicketGet(
|
||||
TicketID => $Param{TicketID},
|
||||
DynamicFields => 1,
|
||||
);
|
||||
return if !$Ticket{ $Param{Type} };
|
||||
|
||||
# check if we found a valid time value and return it
|
||||
if ( $Ticket{ $Param{Type} } =~ '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}' ) {
|
||||
return $Ticket{ $Param{Type} };
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
=head2 SetTime()
|
||||
|
||||
set ticket dynamic field value to supplied time value.
|
||||
|
||||
my $Success = $TicketDynamicFieldObject->SetTime(
|
||||
Type => 'DynamicField_TestDate',
|
||||
Value => '2016-01-01 00:00:00'
|
||||
TicketID => 1,
|
||||
);
|
||||
|
||||
returns 1 if successful.
|
||||
|
||||
=cut
|
||||
|
||||
sub SetTime {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(Type Value TicketID)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
# get dynamic field data
|
||||
my $DynamicFieldName = $Param{Type};
|
||||
$DynamicFieldName =~ s/^DynamicField_//;
|
||||
my $DynamicField = $Kernel::OM->Get('Kernel::System::DynamicField')->DynamicFieldGet(
|
||||
Name => $DynamicFieldName,
|
||||
);
|
||||
return if !$DynamicField;
|
||||
|
||||
# set dynamic field value
|
||||
my $Success = $Kernel::OM->Get('Kernel::System::DynamicFieldValue')->ValueSet(
|
||||
FieldID => $DynamicField->{ID},
|
||||
ObjectID => $Param{TicketID},
|
||||
Value => [
|
||||
{
|
||||
ValueDateTime => $Param{Value},
|
||||
},
|
||||
],
|
||||
UserID => 1,
|
||||
);
|
||||
|
||||
return $Success;
|
||||
}
|
||||
|
||||
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
|
||||
107
Perl OTRS/Kernel/System/Calendar/Ticket/EscalationTime.pm
Normal file
107
Perl OTRS/Kernel/System/Calendar/Ticket/EscalationTime.pm
Normal file
@@ -0,0 +1,107 @@
|
||||
# --
|
||||
# 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::Ticket::EscalationTime;
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
use Kernel::System::VariableCheck qw(:all);
|
||||
|
||||
our @ObjectDependencies = (
|
||||
'Kernel::System::Log',
|
||||
'Kernel::System::Ticket',
|
||||
);
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Kernel::System::Calendar::Ticket::EscalationTime - EscalationTime appointment type
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
EscalationTime ticket appointment type.
|
||||
|
||||
=head1 PUBLIC INTERFACE
|
||||
|
||||
=head2 new()
|
||||
|
||||
create an object. Do not use it directly, instead use:
|
||||
|
||||
use Kernel::System::ObjectManager;
|
||||
local $Kernel::OM = Kernel::System::ObjectManager->new();
|
||||
my $TicketEscalationTimeObject = $Kernel::OM->Get('Kernel::System::Calendar::Ticket::EscalationTime');
|
||||
|
||||
=cut
|
||||
|
||||
sub new {
|
||||
my ( $Type, %Param ) = @_;
|
||||
|
||||
# allocate new hash for object
|
||||
my $Self = {};
|
||||
bless( $Self, $Type );
|
||||
|
||||
return $Self;
|
||||
}
|
||||
|
||||
=head2 GetTime()
|
||||
|
||||
returns time value for escalation time appointment type.
|
||||
|
||||
my $SolutionTime = $TicketEscalationTimeObject->GetTime(
|
||||
Type => 'SolutionTime',
|
||||
TicketID => 1,
|
||||
);
|
||||
|
||||
=cut
|
||||
|
||||
sub GetTime {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(Type TicketID)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
# get ticket data
|
||||
my %Ticket = $Kernel::OM->Get('Kernel::System::Ticket')->TicketGet(
|
||||
TicketID => $Param{TicketID},
|
||||
);
|
||||
return if !$Ticket{ $Param{Type} . 'DestinationDate' };
|
||||
|
||||
# return escalation destination date
|
||||
return $Ticket{ $Param{Type} . 'DestinationDate' };
|
||||
}
|
||||
|
||||
=head2 SetTime()
|
||||
|
||||
does nothing, as you cannot explicitly set ticket escalation times.
|
||||
returns 1 to prevent errors in log.
|
||||
|
||||
=cut
|
||||
|
||||
sub SetTime {
|
||||
return 1;
|
||||
}
|
||||
|
||||
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
|
||||
146
Perl OTRS/Kernel/System/Calendar/Ticket/PendingTime.pm
Normal file
146
Perl OTRS/Kernel/System/Calendar/Ticket/PendingTime.pm
Normal file
@@ -0,0 +1,146 @@
|
||||
# --
|
||||
# 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::Ticket::PendingTime;
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
use Kernel::System::VariableCheck qw(:all);
|
||||
|
||||
our @ObjectDependencies = (
|
||||
'Kernel::System::DateTime',
|
||||
'Kernel::System::Log',
|
||||
'Kernel::System::Ticket',
|
||||
);
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Kernel::System::Calendar::Ticket::PendingTime - PendingTime appointment type
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
PendingTime ticket appointment type.
|
||||
|
||||
=head1 PUBLIC INTERFACE
|
||||
|
||||
=head2 new()
|
||||
|
||||
create an object. Do not use it directly, instead use:
|
||||
|
||||
use Kernel::System::ObjectManager;
|
||||
local $Kernel::OM = Kernel::System::ObjectManager->new();
|
||||
my $TicketPendingTimeObject = $Kernel::OM->Get('Kernel::System::Calendar::Ticket::PendingTime');
|
||||
|
||||
=cut
|
||||
|
||||
sub new {
|
||||
my ( $Type, %Param ) = @_;
|
||||
|
||||
# allocate new hash for object
|
||||
my $Self = {};
|
||||
bless( $Self, $Type );
|
||||
|
||||
return $Self;
|
||||
}
|
||||
|
||||
=head2 GetTime()
|
||||
|
||||
returns time value for pending time appointment type.
|
||||
|
||||
my $PendingTime = $TicketPendingTimeObject->GetTime(
|
||||
Type => 'PendingTime',
|
||||
TicketID => 1,
|
||||
);
|
||||
|
||||
=cut
|
||||
|
||||
sub GetTime {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
for my $Needed (qw(Type TicketID)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
my %Ticket = $Kernel::OM->Get('Kernel::System::Ticket')->TicketGet(
|
||||
TicketID => $Param{TicketID},
|
||||
);
|
||||
return if !$Ticket{UntilTime};
|
||||
|
||||
# Calculate pending time.
|
||||
my $PendingTimeObject = $Kernel::OM->Create('Kernel::System::DateTime');
|
||||
$PendingTimeObject->Add(
|
||||
Seconds => $Ticket{UntilTime},
|
||||
);
|
||||
|
||||
return $PendingTimeObject->ToString();
|
||||
}
|
||||
|
||||
=head2 SetTime()
|
||||
|
||||
set ticket pending time to supplied time value.
|
||||
|
||||
my $Success = $TicketPendingTimeObject->SetTime(
|
||||
Type => 'PendingTime',
|
||||
Value => '2016-01-01 00:00:00'
|
||||
TicketID => 1,
|
||||
);
|
||||
|
||||
returns 1 if successful.
|
||||
|
||||
=cut
|
||||
|
||||
sub SetTime {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for my $Needed (qw(Type Value TicketID)) {
|
||||
if ( !$Param{$Needed} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $Needed!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
my $PendingTimeObject = $Kernel::OM->Create(
|
||||
'Kernel::System::DateTime',
|
||||
ObjectParams => {
|
||||
String => $Param{Value},
|
||||
},
|
||||
);
|
||||
my $PendingTimeSetings = $PendingTimeObject->Get();
|
||||
|
||||
# set pending time
|
||||
my $Success = $Kernel::OM->Get('Kernel::System::Ticket')->TicketPendingTimeSet(
|
||||
%{$PendingTimeSetings},
|
||||
TicketID => $Param{TicketID},
|
||||
UserID => 1,
|
||||
);
|
||||
|
||||
return $Success;
|
||||
}
|
||||
|
||||
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