/usr/sbin/rt-setup-fulltext-index-4 is in request-tracker4 4.4.2-2.
This file is owned by root:root, with mode 0o755.
The actual contents of the file can be viewed below.
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 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 | #!/usr/bin/perl
# BEGIN BPS TAGGED BLOCK {{{
#
# COPYRIGHT:
#
# This software is Copyright (c) 1996-2017 Best Practical Solutions, LLC
# <sales@bestpractical.com>
#
# (Except where explicitly superseded by other copyright notices)
#
#
# LICENSE:
#
# This work is made available to you under the terms of Version 2 of
# the GNU General Public License. A copy of that license should have
# been provided with this software, but in any event can be snarfed
# from www.gnu.org.
#
# This work is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 or visit their web page on the internet at
# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
#
#
# CONTRIBUTION SUBMISSION POLICY:
#
# (The following paragraph is not intended to limit the rights granted
# to you to modify and distribute this software under the terms of
# the GNU General Public License and is only of importance to you if
# you choose to contribute your changes and enhancements to the
# community by submitting them to Best Practical Solutions, LLC.)
#
# By intentionally submitting any modifications, corrections or
# derivatives to this work, or any other work intended for use with
# Request Tracker, to Best Practical Solutions, LLC, you confirm that
# you are the copyright holder for those contributions and you grant
# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
# royalty-free, perpetual, license to use, copy, create derivative
# works based on those contributions, and sublicense and distribute
# those contributions and any derivatives thereof.
#
# END BPS TAGGED BLOCK }}}
use strict;
use warnings;
no warnings 'once';
# fix lib paths, some may be relative
BEGIN { # BEGIN RT CMD BOILERPLATE
require File::Spec;
require Cwd;
my @libs = ("/usr/share/request-tracker4/lib", "/usr/local/share/request-tracker4/lib");
my $bin_path;
for my $lib (@libs) {
unless ( File::Spec->file_name_is_absolute($lib) ) {
$bin_path ||= ( File::Spec->splitpath(Cwd::abs_path(__FILE__)) )[1];
$lib = File::Spec->catfile( $bin_path, File::Spec->updir, $lib );
}
unshift @INC, $lib;
}
}
BEGIN {
use RT;
RT::LoadConfig();
RT::Init();
};
use RT::Interface::CLI ();
my %DB = (
type => scalar RT->Config->Get('DatabaseType'),
user => scalar RT->Config->Get('DatabaseUser'),
admin => scalar RT->Config->Get('DatabaseAdmin'),
admin_password => undef,
);
my %OPT = (
help => 0,
ask => 1,
dryrun => 0,
attachments => 1,
);
my %DEFAULT;
if ( $DB{'type'} eq 'Pg' ) {
%DEFAULT = (
table => 'AttachmentsIndex',
column => 'ContentIndex',
);
}
elsif ( $DB{'type'} eq 'mysql' ) {
%DEFAULT = (
table => 'AttachmentsIndex',
);
}
elsif ( $DB{'type'} eq 'Oracle' ) {
%DEFAULT = (
prefix => 'rt_fts_',
);
}
use Getopt::Long qw(GetOptions);
GetOptions(
'h|help!' => \$OPT{'help'},
'ask!' => \$OPT{'ask'},
'dry-run!' => \$OPT{'dryrun'},
'attachments!' => \$OPT{'attachments'},
'table=s' => \$OPT{'table'},
'column=s' => \$OPT{'column'},
'url=s' => \$OPT{'url'},
'maxmatches=i' => \$OPT{'maxmatches'},
'index-type=s' => \$OPT{'index-type'},
'dba=s' => \$DB{'admin'},
'dba-password=s' => \$DB{'admin_password'},
'limit=i' => \$DB{'batch-size'},
) or show_help();
if ( $OPT{'help'} || (!$DB{'admin'} && $DB{'type'} eq 'Oracle' ) ) {
show_help( !$OPT{'help'} );
}
my $dbh = $RT::Handle->dbh;
$dbh->{'RaiseError'} = 1;
$dbh->{'PrintError'} = 1;
# MySQL could either be native of sphinx; find out which
if ($DB{'type'} eq "mysql") {
my $index_type = lc($OPT{'index-type'} || '');
# Default to sphinx on < 5.6, and error if they provided mysql
my $msg;
if ($RT::Handle->dbh->{mysql_serverversion} < 50600) {
$msg = "Complete support for full-text search requires MySQL 5.6 or higher. For prior\n"
."versions such as yours, full-text indexing can either be provided using MyISAM\n"
."tables, or the external Sphinx indexer. Using MyISAM tables requires that your\n"
."database be tuned to support them, as RT uses InnoDB tables for all other content.\n"
."Using Sphinx will require recompiling MySQL. Which indexing solution would you\n"
."prefer?"
} else {
$msg = "MySQL 5.6 and above support native full-text indexing; for compatibility\n"
."with earlier versions of RT, the external Sphinx indexer is still supported.\n"
."Which indexing solution would you prefer?"
}
while ( $index_type ne 'sphinx' and $index_type ne 'mysql' ) {
$index_type = lc prompt(
message => $msg,
default => 'mysql',
silent => !$OPT{'ask'},
);
};
$DB{'type'} = $index_type;
}
if ( $DB{'type'} eq 'mysql' ) {
# MySQL 5.6 has FTS on InnoDB "text" columns -- which the
# Attachments table doesn't have, but we can make it have.
my $table = $OPT{'table'} || prompt(
message => "Enter the name of a new MySQL table that will be used to store the\n"
. "full-text content and indexes:",
default => $DEFAULT{'table'},
silent => !$OPT{'ask'},
);
do_error_is_ok( dba_handle() => "DROP TABLE $table" )
unless $OPT{'dryrun'};
my $engine = $RT::Handle->dbh->{mysql_serverversion} < 50600 ? "MyISAM" : "InnoDB";
my $schema = "CREATE TABLE $table ( "
."id INT UNSIGNED AUTO_INCREMENT NOT NULL PRIMARY KEY,"
."Content LONGTEXT ) ENGINE=$engine CHARACTER SET utf8";
insert_schema( $schema );
insert_data( Table => $table, Engine => $engine );
insert_schema( "CREATE FULLTEXT INDEX $table ON $table(Content)" );
print_rt_config( Table => $table );
} elsif ($DB{'type'} eq 'sphinx') {
check_sphinx();
my $table = $OPT{'table'} || prompt(
message => "Enter name of a new MySQL table that will be used to connect to the\n"
. "Sphinx server:",
default => $DEFAULT{'table'},
silent => !$OPT{'ask'},
);
my $url = 'sphinx://localhost:3312/rt';
my $version = ($dbh->selectrow_array("show variables like 'version'"))[1];
$url = 'sphinx://127.0.0.1:3312/rt'
if $version and $version =~ /^(\d+\.\d+)/ and $1 >= 5.5;
$url = $OPT{'url'} || prompt(
message => "Enter URL of the sphinx search server; this should be of the form\n"
. "sphinx://<server>:<port>/<index name>",
default => $url,
silent => !$OPT{'ask'},
);
my $maxmatches = $OPT{'maxmatches'} || prompt(
message => "Maximum number of matches to return; this is the maximum number of\n"
. "attachment records returned by the search, not the maximum number\n"
. "of tickets. Both your RT_SiteConfig.pm and your sphinx.conf must\n"
. "agree on this value. Larger values cause your Sphinx server to\n"
. "consume more memory and CPU time per query.",
default => 10000,
silent => !$OPT{'ask'},
);
my $schema = <<END;
CREATE TABLE $table (
id BIGINT NOT NULL,
weight INTEGER NOT NULL,
query VARCHAR(3072) NOT NULL,
INDEX(query)
) ENGINE=SPHINX CONNECTION="$url" CHARACTER SET utf8
END
do_error_is_ok( dba_handle() => "DROP TABLE $table" )
unless $OPT{'dryrun'};
insert_schema( $schema );
print_rt_config( Table => $table, MaxMatches => $maxmatches );
require URI;
my $urlo = URI->new( $url );
my ($host, $port) = split /:/, $urlo->authority;
my $index = $urlo->path;
$index =~ s{^/+}{};
my $var_path = $RT::VarPath;
my %sphinx_conf = ();
$sphinx_conf{'host'} = RT->Config->Get('DatabaseHost');
$sphinx_conf{'db'} = RT->Config->Get('DatabaseName');
$sphinx_conf{'user'} = RT->Config->Get('DatabaseUser');
$sphinx_conf{'pass'} = RT->Config->Get('DatabasePassword');
print <<END
Below is a simple Sphinx configuration which can be used to index all
text/plain attachments in your database. This configuration is not
ideal; you should read the Sphinx documentation to understand how to
configure it to better suit your needs. It assumes that you create the
$var_path/sphinx/ directory, and that is is writable by the sphinx
user.
source rt {
type = mysql
sql_host = $sphinx_conf{'host'}
sql_db = $sphinx_conf{'db'}
sql_user = $sphinx_conf{'user'}
sql_pass = $sphinx_conf{'pass'}
sql_query_pre = SET NAMES utf8
sql_query = \\
SELECT a.id, a.content FROM Attachments a \\
JOIN Transactions txn ON a.TransactionId = txn.id AND txn.ObjectType = 'RT::Ticket' \\
JOIN Tickets t ON txn.ObjectId = t.id \\
WHERE a.ContentType = 'text/plain' AND t.Status != 'deleted'
sql_query_info = SELECT * FROM Attachments WHERE id=\$id
}
index $index {
source = rt
path = $var_path/sphinx/index
docinfo = extern
charset_type = utf-8
}
indexer {
mem_limit = 32M
}
searchd {
port = $port
log = $var_path/sphinx/searchd.log
query_log = $var_path/sphinx/query.log
read_timeout = 5
max_children = 30
pid_file = $var_path/sphinx/searchd.pid
max_matches = $maxmatches
seamless_rotate = 1
preopen_indexes = 0
unlink_old = 1
# For sphinx >= 1.10:
binlog_path = $var_path/sphinx/
}
END
}
elsif ( $DB{'type'} eq 'Pg' ) {
check_tsvalue();
my $table = $OPT{'table'} || prompt(
message => "Enter the name of a DB table that will be used to store the Pg tsvector.\n"
. "You may either use the existing Attachments table, or create a new\n"
. "table. Creating a new table makes initial indexing faster.",
default => $DEFAULT{'table'},
silent => !$OPT{'ask'},
);
my $column = $OPT{'column'} || prompt(
message => 'Enter the name of a column that will be used to store the Pg tsvector:',
default => $DEFAULT{'column'},
silent => !$OPT{'ask'},
);
my @schema;
my $drop;
if ( lc($table) eq 'attachments' ) {
$drop = "ALTER TABLE $table DROP COLUMN $column";
push @schema, "ALTER TABLE $table ADD COLUMN $column tsvector";
} else {
$drop = "DROP TABLE $table";
push @schema, split /;\n+/, <<SCHEMA;
CREATE TABLE $table (
id SERIAL,
$column tsvector
);
GRANT SELECT, INSERT, UPDATE, DELETE ON $table TO "$DB{user}"
SCHEMA
}
my $index_type = lc($OPT{'index-type'} || '');
while ( $index_type ne 'gist' and $index_type ne 'gin' ) {
$index_type = lc prompt(
message => "You may choose between GiST or GIN indexes; the GiST takes less space on\n"
. "disk and is faster to update, but is an order of magnitude slower to query.",
default => 'GIN',
silent => !$OPT{'ask'},
);
}
do_error_is_ok( dba_handle() => $drop )
unless $OPT{'dryrun'};
insert_schema( $_ ) for @schema;
insert_data( Table => $table, Column => $column );
insert_schema( "CREATE INDEX ${column}_idx ON $table USING $index_type($column)" );
print_rt_config( Table => $table, Column => $column );
}
elsif ( $DB{'type'} eq 'Oracle' ) {
{
my $dbah = dba_handle();
do_print_error( $dbah => 'GRANT CTXAPP TO '. $DB{'user'} );
do_print_error( $dbah => 'GRANT EXECUTE ON CTXSYS.CTX_DDL TO '. $DB{'user'} );
}
my %PREFERENCES = (
datastore => {
type => 'DIRECT_DATASTORE',
},
filter => {
type => 'AUTO_FILTER',
# attributes => {
# timeout => 120, # seconds
# timeout_type => 'HEURISTIC', # or 'FIXED'
# },
},
lexer => {
type => 'WORLD_LEXER',
},
word_list => {
type => 'BASIC_WORDLIST',
attributes => {
stemmer => 'AUTO',
fuzzy_match => 'AUTO',
# fuzzy_score => undef,
# fuzzy_numresults => undef,
# substring_index => undef,
# prefix_index => undef,
# prefix_length_min => undef,
# prefix_length_max => undef,
# wlidcard_maxterms => undef,
},
},
'section_group' => {
type => 'NULL_SECTION_GROUP',
},
storage => {
type => 'BASIC_STORAGE',
attributes => {
R_TABLE_CLAUSE => 'lob (data) store as (cache)',
I_INDEX_CLAUSE => 'compress 2',
},
},
);
my @params = ();
push @params, ora_create_datastore( %{ $PREFERENCES{'datastore'} } );
push @params, ora_create_filter( %{ $PREFERENCES{'filter'} } );
push @params, ora_create_lexer( %{ $PREFERENCES{'lexer'} } );
push @params, ora_create_word_list( %{ $PREFERENCES{'word_list'} } );
push @params, ora_create_stop_list();
push @params, ora_create_section_group( %{ $PREFERENCES{'section_group'} } );
push @params, ora_create_storage( %{ $PREFERENCES{'storage'} } );
my $index_params = join "\n", @params;
my $index_name = $DEFAULT{prefix} .'index';
do_error_is_ok( $dbh => "DROP INDEX $index_name" )
unless $OPT{'dryrun'};
$dbh->do(
"CREATE INDEX $index_name ON Attachments(Content)
indextype is ctxsys.context parameters('
$index_params
')",
) unless $OPT{'dryrun'};
print_rt_config( IndexName => $index_name );
}
else {
die "Full-text indexes on $DB{type} are not yet supported";
}
sub check_tsvalue {
my $dbh = $RT::Handle->dbh;
my $fts = ($dbh->selectrow_array(<<EOQ))[0];
SELECT 1 FROM information_schema.routines WHERE routine_name = 'plainto_tsquery'
EOQ
unless ($fts) {
print STDERR <<EOT;
Your PostgreSQL server does not include full-text support. You will
need to upgrade to PostgreSQL version 8.3 or higher to use full-text
indexing.
EOT
exit 1;
}
}
sub check_sphinx {
return if $RT::Handle->CheckSphinxSE;
print STDERR <<EOT;
Your MySQL server has not been compiled with the Sphinx storage engine
(sphinxse). You will need to recompile MySQL according to the
instructions in Sphinx's documentation at
http://sphinxsearch.com/docs/current.html#sphinxse-installing
EOT
exit 1;
}
sub ora_create_datastore {
return sprintf 'datastore %s', ora_create_preference(
@_,
name => 'datastore',
);
}
sub ora_create_filter {
my $res = '';
$res .= sprintf "format column %s\n", ora_create_format_column();
$res .= sprintf 'filter %s', ora_create_preference(
@_,
name => 'filter',
);
return $res;
}
sub ora_create_lexer {
return sprintf 'lexer %s', ora_create_preference(
@_,
name => 'lexer',
);
}
sub ora_create_word_list {
return sprintf 'wordlist %s', ora_create_preference(
@_,
name => 'word_list',
);
}
sub ora_create_stop_list {
my $file = shift || 'etc/stopwords/en.txt';
return '' unless -e $file;
my $name = $DEFAULT{'prefix'} .'stop_list';
unless ($OPT{'dryrun'}) {
do_error_is_ok( $dbh => 'begin ctx_ddl.drop_stoplist(?); end;', $name );
$dbh->do(
'begin ctx_ddl.create_stoplist(?, ?); end;',
undef, $name, 'BASIC_STOPLIST'
);
open( my $fh, '<:utf8', $file )
or die "couldn't open file '$file': $!";
while ( my $word = <$fh> ) {
chomp $word;
$dbh->do(
'begin ctx_ddl.add_stopword(?, ?); end;',
undef, $name, $word
);
}
close $fh;
}
return sprintf 'stoplist %s', $name;
}
sub ora_create_section_group {
my %args = @_;
my $name = $DEFAULT{'prefix'} .'section_group';
unless ($OPT{'dryrun'}) {
do_error_is_ok( $dbh => 'begin ctx_ddl.drop_section_group(?); end;', $name );
$dbh->do(
'begin ctx_ddl.create_section_group(?, ?); end;',
undef, $name, $args{'type'}
);
}
return sprintf 'section group %s', $name;
}
sub ora_create_storage {
return sprintf 'storage %s', ora_create_preference(
@_,
name => 'storage',
);
}
sub ora_create_format_column {
my $column_name = 'ContentOracleFormat';
return $column_name if $OPT{'dryrun'};
unless (
$dbh->column_info(
undef, undef, uc('Attachments'), uc( $column_name )
)->fetchrow_array
) {
$dbh->do(qq{
ALTER TABLE Attachments ADD $column_name VARCHAR2(10)
});
}
my $detect_format = qq{
CREATE OR REPLACE FUNCTION $DEFAULT{prefix}detect_format_simple(
parent IN NUMBER,
type IN VARCHAR2,
encoding IN VARCHAR2,
fname IN VARCHAR2
)
RETURN VARCHAR2
AS
format VARCHAR2(10);
BEGIN
format := CASE
};
unless ( $OPT{'attachments'} ) {
$detect_format .= qq{
WHEN fname IS NOT NULL THEN 'ignore'
};
}
$detect_format .= qq{
WHEN type = 'text' THEN 'text'
WHEN type = 'text/rtf' THEN 'ignore'
WHEN type LIKE 'text/%' THEN 'text'
WHEN type LIKE 'message/%' THEN 'text'
ELSE 'ignore'
END;
RETURN format;
END;
};
ora_create_procedure( $detect_format );
$dbh->do(qq{
UPDATE Attachments
SET $column_name = $DEFAULT{prefix}detect_format_simple(
Parent,
ContentType, ContentEncoding,
Filename
)
WHERE $column_name IS NULL
});
$dbh->do(qq{
CREATE OR REPLACE TRIGGER $DEFAULT{prefix}set_format
BEFORE INSERT
ON Attachments
FOR EACH ROW
BEGIN
:new.$column_name := $DEFAULT{prefix}detect_format_simple(
:new.Parent,
:new.ContentType, :new.ContentEncoding,
:new.Filename
);
END;
});
return $column_name;
}
sub ora_create_preference {
my %info = @_;
my $name = $DEFAULT{'prefix'} . $info{'name'};
return $name if $OPT{'dryrun'};
do_error_is_ok( $dbh => 'begin ctx_ddl.drop_preference(?); end;', $name );
$dbh->do(
'begin ctx_ddl.create_preference(?, ?); end;',
undef, $name, $info{'type'}
);
return $name unless $info{'attributes'};
while ( my ($attr, $value) = each %{ $info{'attributes'} } ) {
$dbh->do(
'begin ctx_ddl.set_attribute(?, ?, ?); end;',
undef, $name, $attr, $value
);
}
return $name;
}
sub ora_create_procedure {
my $text = shift;
return if $OPT{'dryrun'};
my $status = $dbh->do($text, { RaiseError => 0 });
# Statement succeeded
return if $status;
if ( 6550 != $dbh->err ) {
# Utter failure
die $dbh->errstr;
}
else {
my $msg = $dbh->func( 'plsql_errstr' );
die $dbh->errstr if !defined $msg;
die $msg if $msg;
}
}
sub dba_handle {
if ( $DB{'type'} eq 'Oracle' ) {
$ENV{'NLS_LANG'} = "AMERICAN_AMERICA.AL32UTF8";
$ENV{'NLS_NCHAR'} = "AL32UTF8";
}
my $dsn = do { my $h = new RT::Handle; $h->BuildDSN; $h->DSN };
my $dbh = DBI->connect(
$dsn, $DB{admin}, $DB{admin_password},
{ RaiseError => 1, PrintError => 1 },
);
unless ( $dbh ) {
die "Failed to connect to $dsn as user '$DB{admin}': ". $DBI::errstr;
}
return $dbh;
}
sub do_error_is_ok {
my $dbh = shift;
local $dbh->{'RaiseError'} = 0;
local $dbh->{'PrintError'} = 0;
return $dbh->do(shift, undef, @_);
}
sub do_print_error {
my $dbh = shift;
local $dbh->{'RaiseError'} = 0;
local $dbh->{'PrintError'} = 1;
return $dbh->do(shift, undef, @_);
}
sub prompt {
my %args = ( @_ );
return $args{'default'} if $args{'silent'};
local $| = 1;
print $args{'message'};
if ( $args{'default'} ) {
print "\n[". $args{'default'} .']: ';
} else {
print ":\n";
}
my $res = <STDIN>;
chomp $res;
print "\n";
return $args{'default'} if !$res && $args{'default'};
return $res;
}
sub verbose { print @_, "\n" if $OPT{verbose} || $OPT{verbose}; 1 }
sub debug { print @_, "\n" if $OPT{debug}; 1 }
sub error { $RT::Logger->error( @_ ); verbose(@_); 1 }
sub warning { $RT::Logger->warning( @_ ); verbose(@_); 1 }
sub show_help {
my $error = shift;
RT::Interface::CLI->ShowHelp(
ExitValue => $error,
Sections => 'NAME|DESCRIPTION',
);
}
sub print_rt_config {
my %args = @_;
my $config = <<END;
You can now configure RT to use the newly-created full-text index by
adding the following to your RT_SiteConfig.pm:
Set( %FullTextSearch,
Enable => 1,
Indexed => 1,
END
$config .= sprintf(" %-10s => '$args{$_}',\n",$_)
foreach grep defined $args{$_}, keys %args;
$config .= ");\n";
print $config;
}
sub insert_schema {
my $dbh = dba_handle();
my $message = "Going to run the following in the DB:";
my $schema = shift;
print "$message\n";
my $disp = $schema;
$disp =~ s/^/ /mg;
print "$disp\n\n";
return if $OPT{'dryrun'};
my $res = $dbh->do( $schema );
unless ( $res ) {
die "Couldn't run DDL query: ". $dbh->errstr;
}
}
sub insert_data {
return if $OPT{dryrun};
print "Indexing existing data...\n";
$ENV{RT_FTS_CONFIG} = JSON::to_json( {Enable => 1, Indexed => 1, @_});
system( "$RT::SbinPath/rt-fulltext-indexer", "--all",
($DB{'batch-size'} ? ("--limit", $DB{'batch-size'}) : ()));
}
=head1 NAME
rt-setup-fulltext-index - Create indexes for full text search
=head1 DESCRIPTION
This script creates the appropriate tables, columns, functions, and / or
views necessary for full-text searching for your database type. It will
drop any existing indexes in the process.
Please read F<docs/full_text_indexing.pod> for complete documentation on
full-text indexing for your database type.
If you have a non-standard database administrator user or password, you
may use the C<--dba> and C<--dba-password> parameters to set them
explicitly:
rt-setup-fulltext-index --dba sysdba --dba-password 'secret'
To test what will happen without running any DDL, pass the C<--dryrun>
flag.
The Oracle index determines which content-types it will index at
creation time. By default, textual message bodies and textual uploaded
attachments (attachments with filenames) are indexed; to ignore textual
attachments, pass the C<--no-attachments> flag when the index is
created.
=head1 AUTHOR
Ruslan Zakirov E<lt>ruz@bestpractical.comE<gt>,
Alex Vandiver E<lt>alexmv@bestpractical.comE<gt>
=cut
|