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
|
# --
# Copyright (C) 2001-2021 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::Console::Command::Maint::Config::Rebuild;
use strict;
use warnings;
use parent qw(Kernel::System::Console::BaseCommand);
use Time::HiRes qw(sleep);
our @ObjectDependencies = (
'Kernel::System::Cache',
'Kernel::System::PID',
'Kernel::System::SysConfig',
);
sub Configure {
my ( $Self, %Param ) = @_;
$Self->Description('Rebuild the system configuration of OTRS.');
$Self->AddOption(
Name => 'cleanup',
Description => "Cleanup the database configuration, removing entries not defined in the XML files.",
Required => 0,
HasValue => 0,
);
$Self->AddOption(
Name => 'time',
Description => "Specify how many seconds should this instance wait to unlock PID if there is another " .
"instance of this command running at the same time (in cluster environment). Default: 120.",
Required => 0,
HasValue => 1,
ValueRegex => qr/^\d+$/smx,
);
return;
}
sub PreRun {
my ( $Self, %Param ) = @_;
my $PIDObject = $Kernel::OM->Get('Kernel::System::PID');
my $Time = $Self->GetOption('time') || 120;
my $Locked;
my $WaitedSeconds = 0;
my $Interval = 0.1;
my $ShowMessage = 1;
# Make sure that only one rebuild config command is running at the same time. Wait up to 2 minutes
# until other instances are done (see https://bugs.otrs.org/show_bug.cgi?id=14259).
PID:
while ( $WaitedSeconds <= $Time ) {
my %PID = $PIDObject->PIDGet(
Name => 'RebuildConfig',
);
if ( !%PID ) {
my $Success = $PIDObject->PIDCreate(
Name => 'RebuildConfig',
);
my %PID = $PIDObject->PIDGet(
Name => 'RebuildConfig',
);
$PID{PID} || 0;
# PID created successfully.
if ( $Success && $PID{PID} eq $$ ) {
$Locked = 1;
last PID;
}
}
Time::HiRes::sleep($Interval);
$WaitedSeconds += $Interval;
# Increase waiting interval up to 3 seconds.
if ( $Interval < 3 ) {
$Interval += 0.1;
}
if ($ShowMessage) {
$Self->Print("\nThere is another system configuration rebuild in progress, waiting...\n\n");
$ShowMessage = 0;
}
}
if ( !$Locked ) {
die "System was unable to create PID for RebuildConfig!\n";
}
return;
}
sub Run {
my ( $Self, %Param ) = @_;
$Self->Print("<yellow>Rebuilding the system configuration...</yellow>\n");
my $CacheObject = $Kernel::OM->Get('Kernel::System::Cache');
# Enable in-memory cache to improve SysConfig performance, which is normally disabled for commands.
$CacheObject->Configure(
CacheInMemory => 1,
);
# Get SysConfig object.
my $SysConfigObject = $Kernel::OM->Get('Kernel::System::SysConfig');
if (
!$SysConfigObject->ConfigurationXML2DB(
UserID => 1,
Force => 1,
CleanUp => $Self->GetOption('cleanup'),
)
)
{
# Disable in memory cache.
$CacheObject->Configure(
CacheInMemory => 0,
);
$Self->PrintError("There was a problem writing XML to DB.");
return $Self->ExitCodeError();
}
my %DeploymentResult = $SysConfigObject->ConfigurationDeploy(
Comments => "Configuration Rebuild",
AllSettings => 1,
UserID => 1,
Force => 1,
);
if ( !$DeploymentResult{Success} ) {
# Disable in memory cache.
$CacheObject->Configure(
CacheInMemory => 0,
);
$Self->PrintError("There was a problem writing ZZZAAuto.pm.");
return $Self->ExitCodeError();
}
# Disable in memory cache.
$CacheObject->Configure(
CacheInMemory => 0,
);
$Self->Print("<green>Done.</green>\n");
return $Self->ExitCodeOk();
}
sub PostRun {
my ($Self) = @_;
my $PIDObject = $Kernel::OM->Get('Kernel::System::PID');
my %PID = $PIDObject->PIDGet(
Name => 'RebuildConfig',
);
if (%PID) {
return $PIDObject->PIDDelete( Name => 'RebuildConfig' );
}
return 1;
}
1;
|
