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
|
# --
# 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::Admin::Article::StorageSwitch;
use strict;
use warnings;
use parent qw(Kernel::System::Console::BaseCommand);
use Time::HiRes qw(usleep);
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::System::DateTime',
'Kernel::System::PID',
'Kernel::System::Ticket',
);
sub Configure {
my ( $Self, %Param ) = @_;
$Self->Description('Migrate article files from one storage backend to another on the fly.');
$Self->AddOption(
Name => 'target',
Description => "Specify the target backend to migrate to (ArticleStorageDB|ArticleStorageFS).",
Required => 1,
HasValue => 1,
ValueRegex => qr/^(?:ArticleStorageDB|ArticleStorageFS)$/smx,
);
$Self->AddOption(
Name => 'tickets-closed-before-date',
Description => "Only process tickets closed before given ISO date.",
Required => 0,
HasValue => 1,
ValueRegex => qr/^\d{4}-\d{2}-\d{2}[ ]\d{2}:\d{2}:\d{2}$/smx,
);
$Self->AddOption(
Name => 'tickets-closed-before-days',
Description => "Only process tickets closed more than ... days ago.",
Required => 0,
HasValue => 1,
ValueRegex => qr/^\d+$/smx,
);
$Self->AddOption(
Name => 'tolerant',
Description => "Continue after failures.",
Required => 0,
HasValue => 0,
);
$Self->AddOption(
Name => 'micro-sleep',
Description => "Specify microseconds to sleep after every ticket to reduce system load (e.g. 1000).",
Required => 0,
HasValue => 1,
ValueRegex => qr/^\d+$/smx,
);
$Self->AddOption(
Name => 'force-pid',
Description => "Start even if another process is still registered in the database.",
Required => 0,
HasValue => 0,
);
my $Name = $Self->Name();
$Self->AdditionalHelp(<<"EOF");
The <green>$Name</green> command migrates article data from one storage backend to another on the fly, for example from DB to FS:
<green>otrs.Console.pl $Self->{Name} --target ArticleStorageFS</green>
You can specify limits for the tickets migrated with <yellow>--tickets-closed-before-date</yellow> and <yellow>--tickets-closed-before-days</yellow>.
To reduce load on the database for a running system, you can use the <yellow>--micro-sleep</yellow> parameter. The command will pause for the specified amount of microseconds after each ticket.
<green>otrs.Console.pl $Self->{Name} --target ArticleStorageFS --micro-sleep 1000</green>
EOF
return;
}
sub PreRun {
my ($Self) = @_;
my $PIDCreated = $Kernel::OM->Get('Kernel::System::PID')->PIDCreate(
Name => $Self->Name(),
Force => $Self->GetOption('force-pid'),
TTL => 60 * 60 * 24 * 3,
);
if ( !$PIDCreated ) {
my $Error = "Unable to register the process in the database. Is another instance still running?\n";
$Error .= "You can use --force-pid to override this check.\n";
die $Error;
}
return;
}
sub Run {
my ($Self) = @_;
# disable ticket events
$Kernel::OM->Get('Kernel::Config')->{'Ticket::EventModulePost'} = {};
# extended input validation
my %SearchParams;
if ( $Self->GetOption('tickets-closed-before-date') ) {
%SearchParams = (
StateType => 'Closed',
TicketCloseTimeOlderDate => $Self->GetOption('tickets-closed-before-date'),
);
}
elsif ( $Self->GetOption('tickets-closed-before-days') ) {
my $Seconds = $Self->GetOption('tickets-closed-before-days') * 60 * 60 * 24;
my $OlderDTObject = $Kernel::OM->Create('Kernel::System::DateTime');
$OlderDTObject->Subtract( Seconds => $Seconds );
%SearchParams = (
StateType => 'Closed',
TicketCloseTimeOlderDate => $OlderDTObject->ToString(),
);
}
# If Archive system is enabled, take into account archived tickets as well.
# See bug#13945 (https://bugs.otrs.org/show_bug.cgi?id=13945).
if ( $Kernel::OM->Get('Kernel::Config')->{'Ticket::ArchiveSystem'} ) {
$SearchParams{ArchiveFlags} = [ 'y', 'n' ];
}
my $TicketObject = $Kernel::OM->Get('Kernel::System::Ticket');
my @TicketIDs = $TicketObject->TicketSearch(
%SearchParams,
Result => 'ARRAY',
OrderBy => 'Up',
Limit => 1_000_000_000,
UserID => 1,
Permission => 'ro',
);
my $Count = 0;
my $CountTotal = scalar @TicketIDs;
my $Target = $Self->GetOption('target');
my %Target2Source = (
ArticleStorageFS => 'ArticleStorageDB',
ArticleStorageDB => 'ArticleStorageFS',
);
my $MicroSleep = $Self->GetOption('micro-sleep');
my $Tolerant = $Self->GetOption('tolerant');
TICKETID:
for my $TicketID (@TicketIDs) {
$Count++;
$Self->Print("$Count/$CountTotal (TicketID:$TicketID)\n");
my $Success = $TicketObject->TicketArticleStorageSwitch(
TicketID => $TicketID,
Source => $Target2Source{$Target},
Destination => $Target,
UserID => 1,
);
return $Self->ExitCodeError() if !$Tolerant && !$Success;
Time::HiRes::usleep($MicroSleep) if ($MicroSleep);
}
$Self->Print("<green>Done.</green>\n");
return $Self->ExitCodeOk();
}
sub PostRun {
my ($Self) = @_;
return $Kernel::OM->Get('Kernel::System::PID')->PIDDelete( Name => $Self->Name() );
}
1;
|
