/
MasterSlave.pm
696 lines (560 loc) · 20.6 KB
/
MasterSlave.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
# --
# 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::DynamicField::Driver::MasterSlave;
use strict;
use warnings;
use Kernel::System::VariableCheck qw(:all);
use parent qw(Kernel::System::DynamicField::Driver::BaseSelect);
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::Language',
'Kernel::Output::HTML::Layout',
'Kernel::System::DynamicFieldValue',
'Kernel::System::LinkObject',
'Kernel::System::Log',
'Kernel::System::Main',
'Kernel::System::Ticket',
);
=head1 NAME
Kernel::System::DynamicField::Driver::MasterSlave
=head1 SYNOPSIS
DynamicFields MasterSlave Driver delegate
=head1 PUBLIC INTERFACE
This module implements the public interface of L<Kernel::System::DynamicField::Backend>.
Please look there for a detailed reference of the functions.
=head2 new()
usually, you want to create an instance of this
by using Kernel::System::DynamicField::Backend->new();
=cut
sub new {
my ( $Type, %Param ) = @_;
# allocate new hash for object
my $Self = {};
bless( $Self, $Type );
# set field behaviors
$Self->{Behaviors} = {
'IsACLReducible' => 0,
'IsNotificationEventCondition' => 1,
'IsSortable' => 1,
'IsFiltrable' => 1,
'IsStatsCondition' => 1,
'IsCustomerInterfaceCapable' => 0,
};
# get the Dynamic Field Backend custom extensions
my $DynamicFieldDriverExtensions
= $Kernel::OM->Get('Kernel::Config')->Get('DynamicFields::Extension::Driver::MasterSlave');
EXTENSION:
for my $ExtensionKey ( sort keys %{$DynamicFieldDriverExtensions} ) {
# skip invalid extensions
next EXTENSION if !IsHashRefWithData( $DynamicFieldDriverExtensions->{$ExtensionKey} );
# create a extension config shortcut
my $Extension = $DynamicFieldDriverExtensions->{$ExtensionKey};
# check if extension has a new module
if ( $Extension->{Module} ) {
# check if module can be loaded
if (
!$Kernel::OM->Get('Kernel::System::Main')->RequireBaseClass( $Extension->{Module} )
)
{
die "Can't load dynamic fields backend module"
. " $Extension->{Module}! $@";
}
}
# check if extension contains more behaviors
if ( IsHashRefWithData( $Extension->{Behaviors} ) ) {
%{ $Self->{Behaviors} } = (
%{ $Self->{Behaviors} },
%{ $Extension->{Behaviors} }
);
}
}
return $Self;
}
sub ValueSet {
my ( $Self, %Param ) = @_;
my $Success = $Self->_HandleLinks(
FieldName => $Param{DynamicFieldConfig}->{Name},
FieldValue => $Param{Value},
TicketID => $Param{ObjectID},
UserID => $Param{UserID},
);
if ( !$Success ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "There was an error handling the links for master/slave, value could not be set",
);
return;
}
my $Value = $Param{Value} !~ /^(?:UnsetMaster|UnsetSlave)$/ ? $Param{Value} : '';
$Success = $Kernel::OM->Get('Kernel::System::DynamicFieldValue')->ValueSet(
FieldID => $Param{DynamicFieldConfig}->{ID},
ObjectID => $Param{ObjectID},
Value => [
{
ValueText => $Value,
},
],
UserID => $Param{UserID},
);
return $Success;
}
sub EditFieldValueValidate {
my ( $Self, %Param ) = @_;
# get the field value from the http request
my $Value = $Self->EditFieldValueGet(
DynamicFieldConfig => $Param{DynamicFieldConfig},
ParamObject => $Param{ParamObject},
# not necessary for this Driver but place it for consistency reasons
ReturnValueStructure => 1,
);
my $ServerError;
my $ErrorMessage;
# perform necessary validations
if ( $Param{Mandatory} && !$Value ) {
return {
ServerError => 1,
};
}
else {
my $PossibleValues;
# use PossibleValuesFilter if sent
if ( defined $Param{PossibleValuesFilter} ) {
$PossibleValues = $Param{PossibleValuesFilter};
}
else {
# get possible values list
$PossibleValues = $Self->PossibleValuesGet(
%Param,
);
}
# validate if value is in possible values list (but let pass empty values)
if ( $Value && !$PossibleValues->{$Value} ) {
$ServerError = 1;
$ErrorMessage = 'The field content is invalid';
}
}
# create resulting structure
my $Result = {
ServerError => $ServerError,
ErrorMessage => $ErrorMessage,
};
return $Result;
}
sub DisplayValueRender {
my ( $Self, %Param ) = @_;
# set HTMLOutput as default if not specified
if ( !defined $Param{HTMLOutput} ) {
$Param{HTMLOutput} = 1;
}
# get raw Value strings from field value
my $Value = defined $Param{Value} ? $Param{Value} : '';
# get real value
if ( $Param{DynamicFieldConfig}->{Config}->{PossibleValues}->{$Value} ) {
# get readable value
$Value = $Param{DynamicFieldConfig}->{Config}->{PossibleValues}->{$Value};
}
if ( $Value eq 'Master' ) {
$Value = $Param{LayoutObject}->{LanguageObject}->Translate('Master');
}
elsif ( $Value =~ m{SlaveOf:(\d+)}msx ) {
my $TicketNumber = $1;
if ($TicketNumber) {
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
my $TicketHook = $ConfigObject->Get('Ticket::Hook');
my $TicketHookDivider = $ConfigObject->Get('Ticket::HookDivider');
$Value = $Param{LayoutObject}->{LanguageObject}->Translate(
'Slave of %s%s%s',
$TicketHook,
$TicketHookDivider,
$TicketNumber,
);
}
}
# set title as value after update and before limit
my $Title = $Value;
# HTMLOutput transformations
if ( $Param{HTMLOutput} ) {
$Value = $Param{LayoutObject}->Ascii2Html(
Text => $Value,
Max => $Param{ValueMaxChars} || '',
);
$Title = $Param{LayoutObject}->Ascii2Html(
Text => $Title,
Max => $Param{TitleMaxChars} || '',
);
}
else {
if ( $Param{ValueMaxChars} && length($Value) > $Param{ValueMaxChars} ) {
$Value = substr( $Value, 0, $Param{ValueMaxChars} ) . '...';
}
if ( $Param{TitleMaxChars} && length($Title) > $Param{TitleMaxChars} ) {
$Title = substr( $Title, 0, $Param{TitleMaxChars} ) . '...';
}
}
# set field link from config
my $Link = $Param{DynamicFieldConfig}->{Config}->{Link} || '';
my $LinkPreview = $Param{DynamicFieldConfig}->{Config}->{LinkPreview} || '';
my $Data = {
Value => $Value,
Title => $Title,
Link => $Link,
LinkPreview => $LinkPreview,
};
return $Data;
}
sub PossibleValuesGet {
my ( $Self, %Param ) = @_;
# to store the possible values
my %PossibleValues = (
'' => '-',
);
# get needed objects
my $TicketObject = $Kernel::OM->Get('Kernel::System::Ticket');
my $LayoutObject = $Kernel::OM->Get('Kernel::Output::HTML::Layout');
# find all current open master slave tickets
my @TicketIDs = $TicketObject->TicketSearch(
Result => 'ARRAY',
# master slave dynamic field
'DynamicField_' . $Param{DynamicFieldConfig}->{Name} => {
Equals => 'Master',
},
StateType => 'Open',
Limit => 60,
UserID => $LayoutObject->{UserID},
Permission => 'ro',
);
# set dynamic field possible values
$PossibleValues{Master} = $LayoutObject->{LanguageObject}->Translate('New Master Ticket');
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
my $TicketHook = $ConfigObject->Get('Ticket::Hook');
my $TicketHookDivider = $ConfigObject->Get('Ticket::HookDivider');
TICKET:
for my $TicketID (@TicketIDs) {
my %CurrentTicket = $TicketObject->TicketGet(
TicketID => $TicketID,
DynamicFields => 1,
);
next TICKET if !%CurrentTicket;
# set dynamic field possible values
$PossibleValues{"SlaveOf:$CurrentTicket{TicketNumber}"} = $LayoutObject->{LanguageObject}->Translate(
'Slave of %s%s%s: %s',
$TicketHook,
$TicketHookDivider,
$CurrentTicket{TicketNumber},
$CurrentTicket{Title},
);
}
# return the possible values hash as a reference
return \%PossibleValues;
}
sub _HandleLinks {
my ( $Self, %Param ) = @_;
# check needed stuff
for my $Needed (qw(FieldName FieldValue TicketID UserID)) {
if ( !$Param{$Needed} ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "Need $Needed!",
);
return;
}
}
# get ticket object
my $TicketObject = $Kernel::OM->Get('Kernel::System::Ticket');
my $FieldName = $Param{FieldName};
my %Ticket = $Param{Ticket}
? %{ $Param{Ticket} }
: $TicketObject->TicketGet(
TicketID => $Param{TicketID},
DynamicFields => 1,
);
my $OldValue = $Ticket{ 'DynamicField_' . $FieldName };
# get config object
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
# get master slave config
my $MasterSlaveKeepParentChildAfterUnset = $ConfigObject->Get('MasterSlave::KeepParentChildAfterUnset') || 0;
my $MasterSlaveFollowUpdatedMaster = $ConfigObject->Get('MasterSlave::FollowUpdatedMaster') || 0;
my $MasterSlaveKeepParentChildAfterUpdate = $ConfigObject->Get('MasterSlave::KeepParentChildAfterUpdate') || 0;
my $NewValue = $Param{FieldValue};
# get link object
my $LinkObject = $Kernel::OM->Get('Kernel::System::LinkObject');
# set a new master ticket
# check if it is already a master ticket
if (
$NewValue eq 'Master'
&& ( !$OldValue || $OldValue ne $NewValue )
)
{
# check if it was a slave ticket before and if we have to delete
# the old parent child link (MasterSlaveKeepParentChildAfterUnset)
if (
$OldValue
&& $OldValue =~ /^SlaveOf:(.*?)$/
&& !$MasterSlaveKeepParentChildAfterUnset
)
{
my $SourceKey = $TicketObject->TicketIDLookup(
TicketNumber => $1,
UserID => $Param{UserID},
);
$LinkObject->LinkDelete(
Object1 => 'Ticket',
Key1 => $SourceKey,
Object2 => 'Ticket',
Key2 => $Param{TicketID},
Type => 'ParentChild',
UserID => $Param{UserID},
);
}
}
# set a new slave ticket
# check if it's already the slave of the wished master ticket
elsif (
$NewValue =~ /^SlaveOf:(.*?)$/
&& ( !$OldValue || $OldValue ne $NewValue )
)
{
my $SourceKey = $TicketObject->TicketIDLookup(
TicketNumber => $1,
UserID => $Param{UserID},
);
$LinkObject->LinkAdd(
SourceObject => 'Ticket',
SourceKey => $SourceKey,
TargetObject => 'Ticket',
TargetKey => $Param{TicketID},
Type => 'ParentChild',
State => 'Valid',
UserID => $Param{UserID},
);
my %Links = $LinkObject->LinkKeyList(
Object1 => 'Ticket',
Key1 => $Param{TicketID},
Object2 => 'Ticket',
State => 'Valid',
Type => 'ParentChild', # (optional)
Direction => 'Target', # (optional) default Both (Source|Target|Both)
UserID => $Param{UserID},
);
my @SlaveTicketIDs;
LINKEDTICKETID:
for my $LinkedTicketID ( sort keys %Links ) {
next LINKEDTICKETID if !$Links{$LinkedTicketID};
# just take ticket with slave attributes for action
my %LinkedTicket = $TicketObject->TicketGet(
TicketID => $LinkedTicketID,
DynamicFields => 1,
);
my $LinkedTicketValue = $Ticket{ 'DynamicField_' . $FieldName };
next LINKEDTICKETID if !$LinkedTicketValue;
next LINKEDTICKETID if $LinkedTicketValue !~ /^SlaveOf:(.*?)$/;
# remember linked ticket id
push @SlaveTicketIDs, $LinkedTicketID;
}
if ( $OldValue && $OldValue eq 'Master' ) {
if ( $MasterSlaveFollowUpdatedMaster && @SlaveTicketIDs ) {
for my $LinkedTicketID (@SlaveTicketIDs) {
$LinkObject->LinkAdd(
SourceObject => 'Ticket',
SourceKey => $SourceKey,
TargetObject => 'Ticket',
TargetKey => $LinkedTicketID,
Type => 'ParentChild',
State => 'Valid',
UserID => $Param{UserID},
);
}
}
if ( !$MasterSlaveKeepParentChildAfterUnset ) {
for my $LinkedTicketID (@SlaveTicketIDs) {
$LinkObject->LinkDelete(
Object1 => 'Ticket',
Key1 => $Param{TicketID},
Object2 => 'Ticket',
Key2 => $LinkedTicketID,
Type => 'ParentChild',
UserID => $Param{UserID},
);
}
}
}
elsif (
$OldValue
&& $OldValue =~ /^SlaveOf:(.*?)$/
&& !$MasterSlaveKeepParentChildAfterUpdate
)
{
my $SourceKey = $TicketObject->TicketIDLookup(
TicketNumber => $1,
UserID => $Param{UserID},
);
$LinkObject->LinkDelete(
Object1 => 'Ticket',
Key1 => $SourceKey,
Object2 => 'Ticket',
Key2 => $Param{TicketID},
Type => 'ParentChild',
UserID => $Param{UserID},
);
}
}
elsif ( $NewValue =~ /^(?:UnsetMaster|UnsetSlave)$/ && $OldValue ) {
if ( $NewValue eq 'UnsetMaster' && !$MasterSlaveKeepParentChildAfterUnset ) {
my %Links = $LinkObject->LinkKeyList(
Object1 => 'Ticket',
Key1 => $Param{TicketID},
Object2 => 'Ticket',
State => 'Valid',
Type => 'ParentChild', # (optional)
Direction => 'Target', # (optional) default Both (Source|Target|Both)
UserID => $Param{UserID},
);
my @SlaveTicketIDs;
LINKEDTICKETID:
for my $LinkedTicketID ( sort keys %Links ) {
next LINKEDTICKETID if !$Links{$LinkedTicketID};
# just take ticket with slave attributes for action
my %LinkedTicket = $TicketObject->TicketGet(
TicketID => $LinkedTicketID,
DynamicFields => 1,
);
my $LinkedTicketValue = $Ticket{ 'DynamicField_' . $FieldName };
next LINKEDTICKETID if !$LinkedTicketValue;
next LINKEDTICKETID if $LinkedTicketValue !~ /^SlaveOf:(.*?)$/;
# remember ticket id
push @SlaveTicketIDs, $LinkedTicketID;
}
for my $LinkedTicketID (@SlaveTicketIDs) {
$LinkObject->LinkDelete(
Object1 => 'Ticket',
Key1 => $Param{TicketID},
Object2 => 'Ticket',
Key2 => $LinkedTicketID,
Type => 'ParentChild',
UserID => $Param{UserID},
);
}
}
elsif (
$NewValue eq 'UnsetSlave'
&& !$MasterSlaveKeepParentChildAfterUnset
&& $OldValue =~ /^SlaveOf:(.*?)$/
)
{
my $SourceKey = $TicketObject->TicketIDLookup(
TicketNumber => $1,
UserID => $Param{UserID},
);
$LinkObject->LinkDelete(
Object1 => 'Ticket',
Key1 => $SourceKey,
Object2 => 'Ticket',
Key2 => $Param{TicketID},
Type => 'ParentChild',
UserID => $Param{UserID},
);
}
}
return 1;
}
sub SearchFieldRender {
my ( $Self, %Param ) = @_;
# take config from field config
my $FieldConfig = $Param{DynamicFieldConfig}->{Config};
my $FieldName = 'Search_DynamicField_' . $Param{DynamicFieldConfig}->{Name};
my $FieldLabel = $Param{DynamicFieldConfig}->{Label};
my $Value;
my @DefaultValue;
if ( defined $Param{DefaultValue} ) {
@DefaultValue = split /;/, $Param{DefaultValue};
}
# set the field value
if (@DefaultValue) {
$Value = \@DefaultValue;
}
# get the field value, this function is always called after the profile is loaded
my $FieldValues = $Self->SearchFieldValueGet(
%Param,
);
if ( defined $FieldValues ) {
$Value = $FieldValues;
}
# check and set class if necessary
my $FieldClass = 'DynamicFieldMultiSelect Modernize';
# set TreeView class
if ( $FieldConfig->{TreeView} ) {
$FieldClass .= ' DynamicFieldWithTreeView';
}
my $LanguageObject = $Kernel::OM->Get('Kernel::Language');
# set PossibleValues (master should be always an option)
my $SelectionData = {
Master => $LanguageObject->Translate('Master Ticket'),
};
# get historical values from database
my $HistoricalValues = $Self->HistoricalValuesGet(%Param);
my $TicketObject = $Kernel::OM->Get('Kernel::System::Ticket');
if ( IsHashRefWithData($HistoricalValues) ) {
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
my $TicketHook = $ConfigObject->Get('Ticket::Hook');
my $TicketHookDivider = $ConfigObject->Get('Ticket::HookDivider');
# Recreate the display value from the already set tickets.
VALUE:
for my $ValueKey ( sort keys %{$HistoricalValues} ) {
if ( $ValueKey =~ m{SlaveOf:(.*)}gmx ) {
my $TicketNumber = $1;
my $TicketID = $TicketObject->TicketIDLookup(
TicketNumber => $TicketNumber,
UserID => 1,
);
my %Ticket;
if ($TicketID) {
%Ticket = $TicketObject->TicketGet(
TicketID => $TicketID
);
}
next VALUE if !%Ticket;
$SelectionData->{$ValueKey} = $LanguageObject->Translate(
'Slave of %s%s%s: %s',
$TicketHook,
$TicketHookDivider,
$Ticket{TicketNumber},
$Ticket{Title},
);
}
}
}
# use PossibleValuesFilter if defined
$SelectionData = $Param{PossibleValuesFilter} // $SelectionData;
my $HTMLString = $Param{LayoutObject}->BuildSelection(
Data => $SelectionData,
Name => $FieldName,
SelectedID => $Value,
Translation => 0,
PossibleNone => 0,
Class => $FieldClass,
Multiple => 1,
HTMLQuote => 1,
);
# call EditLabelRender on the common Driver
my $LabelString = $Self->EditLabelRender(
%Param,
FieldName => $FieldName,
);
my $Data = {
Field => $HTMLString,
Label => $LabelString,
};
return $Data;
}
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