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
|
# --
# Copyright (C) 2001-2017 OTRS AG, http://otrs.com/
# --
# This software comes with ABSOLUTELY NO WARRANTY. For details, see
# the enclosed file COPYING for license information (AGPL). If you
# did not receive this file, see http://www.gnu.org/licenses/agpl.txt.
# --
package Kernel::Output::HTML::NavBar::CustomerTicketProcess;
use strict;
use warnings;
use Kernel::System::VariableCheck qw(:all);
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::System::Cache',
'Kernel::System::Ticket',
'Kernel::System::ProcessManagement::Process',
);
sub new {
my ( $Type, %Param ) = @_;
# allocate new hash for object
my $Self = {};
bless( $Self, $Type );
# get UserID param
$Self->{UserID} = $Param{UserID} || die "Got no UserID!";
return $Self;
}
sub Run {
my ( $Self, %Param ) = @_;
# get config object
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
# get process management configuration
my $FrontendModuleConfig = $ConfigObject->Get('CustomerFrontend::Module')->{CustomerTicketProcess};
# check if the registration config is valid
return if !IsHashRefWithData($FrontendModuleConfig);
return if !IsHashRefWithData( $FrontendModuleConfig->{NavBar}->[0] );
my $NameForID = $FrontendModuleConfig->{NavBar}->[0]->{Name};
my $NameForHidden = $NameForID;
$NameForID =~ s/[ &;]//ig;
# check if the module name is valid
return if !$NameForID;
my $DisplayMenuItem;
# check the cache
my $CacheKey = 'ProcessManagement::UserID' . $Self->{UserID} . '::DisplayMenuItem';
# get cache object
my $CacheObject = $Kernel::OM->Get('Kernel::System::Cache');
my $Cache = $CacheObject->Get(
Type => 'ProcessManagement_Process',
Key => $CacheKey,
);
# set the cache value to show or hide the menu item (if value exists)
if ( $Cache && ref $Cache eq 'SCALAR' ) {
$DisplayMenuItem = ${$Cache};
}
# otherwise determine the value by quering the process object
else {
$DisplayMenuItem = 0;
my $Processes = $ConfigObject->Get('Process');
# avoid error messages when there is no processes and call ProcessList
if ( IsHashRefWithData($Processes) ) {
# get process list
my $ProcessList = $Kernel::OM->Get('Kernel::System::ProcessManagement::Process')->ProcessList(
ProcessState => ['Active'],
Interface => ['CustomerInterface'],
);
# prepare process list for ACLs, use only entities instead of names, convert from
# P1 => Name to P1 => P1. As ACLs should work only against entities
my %ProcessListACL = map { $_ => $_ } sort keys %{$ProcessList};
# get ticket object
my $TicketObject = $Kernel::OM->Get('Kernel::System::Ticket');
# validate the ProcessList with stored ACLs
my $ACL = $TicketObject->TicketAcl(
ReturnType => 'Process',
ReturnSubType => '-',
Data => \%ProcessListACL,
CustomerUserID => $Self->{UserID},
);
if ( IsHashRefWithData($ProcessList) && $ACL ) {
# get ACL results
my %ACLData = $TicketObject->TicketAclData();
# recover process names
my %ReducedProcessList = map { $_ => $ProcessList->{$_} } sort keys %ACLData;
# replace original process list with the reduced one
$ProcessList = \%ReducedProcessList;
}
# set the value to show or hide the menu item (based in process list)
if ( IsHashRefWithData($ProcessList) ) {
$DisplayMenuItem = 1;
}
}
# get the cache TTL (in seconds)
my $CacheTTL = int( $Kernel::OM->Get('Kernel::Config')->Get('Process::NavBar::CacheTTL') || 900 );
# set cache
$CacheObject->Set(
Type => 'ProcessManagement_Process',
Key => $CacheKey,
Value => \$DisplayMenuItem,
TTL => $CacheTTL,
);
}
# return nothing to display the menu item
return if $DisplayMenuItem;
# frontend module is enabled but there is no selectable process, then remove the menu entry
my $NavBarName = $FrontendModuleConfig->{NavBarName};
my $Priority = sprintf( "%07d", $FrontendModuleConfig->{NavBar}->[0]->{Prio} );
my %Return = %{ $Param{NavBarModule}->{Sub} };
# remove CustomerTicketProcess from the TicketMenu
delete $Return{$NavBarName}->{$Priority};
# remove CustomerTicketProcess from the Menu if set outside of the TicketMenu, see bug #11393
delete $Param{NavBarModule}->{$Priority};
return ( Sub => \%Return );
}
1;
|
