# --
# 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::Console::Command::Maint::Ticket::FulltextIndex;
use strict;
use warnings;
use parent qw(Kernel::System::Console::BaseCommand);
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::System::Ticket::Article',
);
sub Configure {
my ( $Self, %Param ) = @_;
$Self->Description(
'Flag articles to automatically rebuild the article search index or displays the index status. Please use --status or --rebuild option, not both!'
);
$Self->AddOption(
Name => 'status',
Description => "Display the current status of the index.",
Required => 0,
HasValue => 0,
);
$Self->AddOption(
Name => 'rebuild',
Description => "Flag articles to automatically rebuild the article search index.",
Required => 0,
HasValue => 0,
);
return;
}
sub PreRun {
my ( $Self, %Param ) = @_;
if ( !$Self->GetOption('status') && !$Self->GetOption('rebuild') ) {
$Self->Print( $Self->GetUsageHelp() );
die "Either --status or --rebuild must be given!\n";
}
if ( $Self->GetOption('status') && $Self->GetOption('rebuild') ) {
$Self->Print( $Self->GetUsageHelp() );
die "Either --status or --rebuild must be given, not both!\n";
}
return;
}
sub Run {
my ( $Self, %Param ) = @_;
if ( $Self->GetOption('status') ) {
$Self->Status();
}
elsif ( $Self->GetOption('rebuild') ) {
$Self->Rebuild();
}
return $Self->ExitCodeOk();
}
sub Status {
my ( $Self, %Param ) = @_;
my %Status = $Kernel::OM->Get('Kernel::System::Ticket::Article')->ArticleSearchIndexStatus();
my $Percentage = $Status{ArticlesIndexed} / $Status{ArticlesTotal} * 100;
my $Color = $Percentage == 100 ? 'green' : 'yellow';
my $Output = sprintf(
"Indexed Articles: <$Color>%.1f%%$Color> (<$Color>%d/%d$Color>)",
$Percentage,
$Status{ArticlesIndexed},
$Status{ArticlesTotal}
);
$Self->Print("$Output\n");
return 1;
}
sub Rebuild {
my ( $Self, %Param ) = @_;
$Self->Print("Marking all articles for reindexing...\n");
$Kernel::OM->Get('Kernel::System::Ticket::Article')->ArticleSearchIndexRebuildFlagSet(
All => 1,
Value => 1,
);
$Self->Print("Done.\n");
return 1;
}
1;