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
|
<?php
namespace SMW\Maintenance;
use Onoi\MessageReporter\MessageReporterFactory;
use SMW\SQLStore\QueryEngine\FulltextSearchTableFactory;
use SMW\ApplicationFactory;
use SMWDataItem as DataItem;
use SMW\Setup;
$basePath = getenv( 'MW_INSTALL_PATH' ) !== false ? getenv( 'MW_INSTALL_PATH' ) : __DIR__ . '/../../..';
require_once $basePath . '/maintenance/Maintenance.php';
/**
* @license GNU GPL v2+
* @since 2.5
*
* @author mwjames
*/
class RebuildFulltextSearchTable extends \Maintenance {
public function __construct() {
$this->mDescription = 'Rebuild the fulltext search index (only works with SQLStore)';
$this->addOption( 'report-runtime', 'Report execution time and memory usage', false );
$this->addOption( 'with-maintenance-log', 'Add log entry to `Special:Log` about the maintenance run.', false );
$this->addOption( 'optimize', 'Run possible table optimization (support depends on the SQL back-end) ', false );
$this->addOption( 'v', 'Show additional (verbose) information about the progress', false );
$this->addOption( 'quick', 'Suppress abort operation', false );
parent::__construct();
}
/**
* @see Maintenance::addDefaultParams
*
* @since 2.5
*/
protected function addDefaultParams() {
parent::addDefaultParams();
}
/**
* @see Maintenance::execute
*/
public function execute() {
if ( !Setup::isEnabled() ) {
$this->reportMessage( "\nYou need to have SMW enabled in order to run the maintenance script!\n" );
exit;
}
if ( !Setup::isValid( true ) ) {
$this->reportMessage( "\nYou need to run `update.php` or `setupStore.php` first before continuing\nwith any maintenance tasks!\n" );
exit;
}
$applicationFactory = ApplicationFactory::getInstance();
$maintenanceFactory = $applicationFactory->newMaintenanceFactory();
$fulltextSearchTableFactory = new FulltextSearchTableFactory();
// Only the SQLStore is supported
$searchTableRebuilder = $fulltextSearchTableFactory->newSearchTableRebuilder(
$applicationFactory->getStore( '\SMW\SQLStore\SQLStore' )
);
$textSanitizer = $fulltextSearchTableFactory->newTextSanitizer();
$searchTableRebuilder->reportVerbose(
$this->hasOption( 'v' )
);
$searchTableRebuilder->requestOptimization(
$this->hasOption( 'optimize' )
);
$this->reportMessage(
"\nThe script rebuilds the search index from property tables that\n" .
"support a fulltext search. Any change of the index rules (altered\n".
"stopwords, new stemmer etc.) and/or a newly added or altered table\n".
"requires to run this script again to ensure that the index complies\n".
"with the rules set forth by the SQL back-end or Sanitizer.\n"
);
$this->reportConfiguration(
$searchTableRebuilder,
$textSanitizer
);
if ( !$this->hasOption( 'quick' ) ) {
$this->reportMessage( "\n" . 'Abort the rebuild with control-c in the next five seconds ... ' );
swfCountDown( 5 );
}
$maintenanceHelper = $maintenanceFactory->newMaintenanceHelper();
$maintenanceHelper->initRuntimeValues();
// Need to instantiate an extra object here since we cannot make this class itself
// into a MessageReporter since the maintenance script does not load the interface in time.
$reporter = MessageReporterFactory::getInstance()->newObservableMessageReporter();
$reporter->registerReporterCallback( [ $this, 'reportMessage' ] );
$searchTableRebuilder->setMessageReporter( $reporter );
$result = $searchTableRebuilder->rebuild();
if ( $result && $this->hasOption( 'report-runtime' ) ) {
$this->reportMessage( "\n" . "Runtime report ..." . "\n" );
$this->reportMessage( $maintenanceHelper->getFormattedRuntimeValues( ' ...' ) . "\n" );
}
if ( $this->hasOption( 'with-maintenance-log' ) ) {
$maintenanceLogger = $maintenanceFactory->newMaintenanceLogger( 'RebuildFulltextSearchTableLogger' );
$maintenanceLogger->log( $maintenanceHelper->getFormattedRuntimeValues() );
}
$maintenanceHelper->reset();
return $result;
}
private function reportConfiguration( $searchTableRebuilder, $textSanitizer ) {
$this->reportMessage( "\nConfiguration ..." );
foreach ( $textSanitizer->getVersions() as $key => $value ) {
$this->reportMessage( "\n" . sprintf( "%-36s%s", " ... {$key}", $value ) );
}
$searchTable = $searchTableRebuilder->getSearchTable();
$indexableDataTypes = [];
$dataTypes = [
DataItem::TYPE_BLOB => 'BLOB',
DataItem::TYPE_URI => 'URI',
DataItem::TYPE_WIKIPAGE => 'WIKIPAGE'
];
foreach ( $dataTypes as $key => $value ) {
if ( $searchTable->isValidByType( $key ) ) {
$indexableDataTypes[] = $value;
}
}
$this->reportMessage( "\n" . sprintf( "%-36s%s", " ... DataTypes (indexable)", implode( ', ', $indexableDataTypes ) ) );
$this->reportMessage( "\n\nExempted properties (not indexable) ..." );
$exemptionList = '';
foreach ( $searchTable->getPropertyExemptionList() as $prop ) {
$exemptionList .= ( $exemptionList === '' ? '' : ', ' ) . $prop;
if ( strlen( $exemptionList ) > 50 ) {
$this->reportMessage( "\n ... " . $exemptionList );
$exemptionList = '';
}
}
$this->reportMessage( "\n ... " . $exemptionList . "\n" );
}
/**
* @see Maintenance::reportMessage
*
* @since 2.5
*
* @param string $message
*/
public function reportMessage( $message ) {
$this->output( $message );
}
}
$maintClass = 'SMW\Maintenance\RebuildFulltextSearchTable';
require_once ( RUN_MAINTENANCE_IF_MAIN );
|
