TYPO3-Solr /
ext-solr
| Total Complexity | 40 |
| Total Lines | 344 |
| Duplicated Lines | 0 % |
| Coverage | 0% |
| Changes | 1 | ||
| Bugs | 0 | Features | 0 |
Complex classes like CoreOptimizationModuleController often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use CoreOptimizationModuleController, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 32 | class CoreOptimizationModuleController extends AbstractModuleController |
||
| 33 | { |
||
| 34 | /** |
||
| 35 | * Set up the doc header properly here |
||
| 36 | * |
||
| 37 | * @param ViewInterface $view |
||
| 38 | * @return void |
||
| 39 | * @throws DBALDriverException |
||
| 40 | * @throws InvalidViewObjectNameException |
||
| 41 | * @throws Throwable |
||
| 42 | * @noinspection PhpUnused |
||
| 43 | */ |
||
| 44 | protected function initializeView($view) |
||
| 45 | { |
||
| 46 | parent::initializeView($view); |
||
| 47 | $this->generateCoreSelectorMenuUsingPageTree(); |
||
| 48 | $coreOptimizationTabs = $this->moduleTemplate->getDynamicTabMenu([], 'coreOptimization'); |
||
| 49 | $this->view->assign('tabs', $coreOptimizationTabs); |
||
| 50 | } |
||
| 51 | |||
| 52 | /** |
||
| 53 | * Gets synonyms and stopwords for the currently selected core |
||
| 54 | * |
||
| 55 | * @return void |
||
| 56 | * @noinspection PhpUnused |
||
| 57 | */ |
||
| 58 | public function indexAction(): ResponseInterface |
||
| 59 | { |
||
| 60 | if ($this->selectedSolrCoreConnection === null) { |
||
| 61 | $this->view->assign('can_not_proceed', true); |
||
| 62 | return $this->htmlResponse(); |
||
|
Bug
Best Practice
introduced
by
|
|||
| 63 | } |
||
| 64 | |||
| 65 | $synonyms = []; |
||
| 66 | $coreAdmin = $this->selectedSolrCoreConnection->getAdminService(); |
||
| 67 | $rawSynonyms = $coreAdmin->getSynonyms(); |
||
| 68 | foreach ($rawSynonyms as $baseWord => $synonymList) { |
||
| 69 | $synonyms[$baseWord] = implode(', ', $synonymList); |
||
| 70 | } |
||
| 71 | |||
| 72 | $stopWords = $coreAdmin->getStopWords(); |
||
| 73 | $this->view->assignMultiple([ |
||
| 74 | 'synonyms' => $synonyms, |
||
| 75 | 'stopWords' => implode(PHP_EOL, $stopWords), |
||
| 76 | 'stopWordsCount' => count($stopWords) |
||
| 77 | ]); |
||
| 78 | $this->moduleTemplate->setContent($this->view->render()); |
||
| 79 | return $this->htmlResponse($this->moduleTemplate->renderContent()); |
||
| 80 | } |
||
| 81 | |||
| 82 | /** |
||
| 83 | * Add synonyms to selected core |
||
| 84 | * |
||
| 85 | * @param string $baseWord |
||
| 86 | * @param string $synonyms |
||
| 87 | * @param bool $overrideExisting |
||
| 88 | * @return ResponseInterface |
||
| 89 | * @noinspection PhpUnused |
||
| 90 | */ |
||
| 91 | public function addSynonymsAction(string $baseWord, string $synonyms, bool $overrideExisting): ResponseInterface |
||
| 92 | { |
||
| 93 | if (empty($baseWord) || empty($synonyms)) { |
||
| 94 | $this->addFlashMessage( |
||
| 95 | 'Please provide a base word and synonyms.', |
||
| 96 | 'Missing parameter', |
||
| 97 | FlashMessage::ERROR |
||
| 98 | ); |
||
| 99 | } else { |
||
| 100 | $baseWord = mb_strtolower($baseWord); |
||
| 101 | $synonyms = mb_strtolower($synonyms); |
||
| 102 | |||
| 103 | $coreAdmin = $this->selectedSolrCoreConnection->getAdminService(); |
||
| 104 | if ($overrideExisting && $coreAdmin->getSynonyms($baseWord)) { |
||
| 105 | $coreAdmin->deleteSynonym($baseWord); |
||
| 106 | } |
||
| 107 | $coreAdmin->addSynonym($baseWord, GeneralUtility::trimExplode(',', $synonyms, true)); |
||
| 108 | $coreAdmin->reloadCore(); |
||
| 109 | |||
| 110 | $this->addFlashMessage( |
||
| 111 | '"' . $synonyms . '" added as synonyms for base word "' . $baseWord . '"' |
||
| 112 | ); |
||
| 113 | } |
||
| 114 | |||
| 115 | return new RedirectResponse($this->uriBuilder->uriFor('index'), 303); |
||
| 116 | } |
||
| 117 | |||
| 118 | /** |
||
| 119 | * @param string $fileFormat |
||
| 120 | * @return ResponseInterface |
||
| 121 | * @noinspection PhpUnused |
||
| 122 | */ |
||
| 123 | public function exportStopWordsAction(string $fileFormat = 'txt'): ResponseInterface |
||
| 124 | { |
||
| 125 | $coreAdmin = $this->selectedSolrCoreConnection->getAdminService(); |
||
| 126 | return $this->exportFile( |
||
| 127 | implode(PHP_EOL, $coreAdmin->getStopWords()), |
||
| 128 | 'stopwords', |
||
| 129 | $fileFormat |
||
| 130 | ); |
||
| 131 | } |
||
| 132 | |||
| 133 | /** |
||
| 134 | * Exports synonyms to a download file. |
||
| 135 | * |
||
| 136 | * @param string $fileFormat |
||
| 137 | * @return ResponseInterface |
||
| 138 | * @noinspection PhpUnused |
||
| 139 | */ |
||
| 140 | public function exportSynonymsAction(string $fileFormat = 'txt'): ResponseInterface |
||
| 141 | { |
||
| 142 | $coreAdmin = $this->selectedSolrCoreConnection->getAdminService(); |
||
| 143 | $synonyms = $coreAdmin->getSynonyms(); |
||
| 144 | return $this->exportFile(ManagedResourcesUtility::exportSynonymsToTxt($synonyms), 'synonyms', $fileFormat); |
||
| 145 | } |
||
| 146 | |||
| 147 | /** |
||
| 148 | * @param array $synonymFileUpload |
||
| 149 | * @param bool $overrideExisting |
||
| 150 | * @param bool $deleteSynonymsBefore |
||
| 151 | * @return ResponseInterface |
||
| 152 | * @noinspection PhpUnused |
||
| 153 | */ |
||
| 154 | public function importSynonymListAction(array $synonymFileUpload, bool $overrideExisting = false, bool $deleteSynonymsBefore = false): ResponseInterface |
||
| 178 | } |
||
| 179 | |||
| 180 | /** |
||
| 181 | * @param array $stopwordsFileUpload |
||
| 182 | * @param bool $replaceStopwords |
||
| 183 | * |
||
| 184 | * @return ResponseInterface |
||
| 185 | * @noinspection PhpUnused |
||
| 186 | */ |
||
| 187 | public function importStopWordListAction(array $stopwordsFileUpload, bool $replaceStopwords): ResponseInterface |
||
| 188 | { |
||
| 189 | $this->saveStopWordsAction( |
||
| 190 | ManagedResourcesUtility::importStopwordsFromPlainTextContents($stopwordsFileUpload), |
||
| 191 | $replaceStopwords |
||
| 192 | ); |
||
| 193 | return new RedirectResponse($this->uriBuilder->uriFor('index'), 303); |
||
| 194 | } |
||
| 195 | |||
| 196 | /** |
||
| 197 | * Delete complete synonym list |
||
| 198 | * |
||
| 199 | * @return ResponseInterface |
||
| 200 | * @noinspection PhpUnused |
||
| 201 | */ |
||
| 202 | public function deleteAllSynonymsAction(): ResponseInterface |
||
| 203 | { |
||
| 204 | $allSynonymsCouldBeDeleted = $this->deleteAllSynonyms(); |
||
| 205 | |||
| 206 | $coreAdmin = $this->selectedSolrCoreConnection->getAdminService(); |
||
| 207 | $reloadResponse = $coreAdmin->reloadCore(); |
||
| 208 | |||
| 209 | if ($allSynonymsCouldBeDeleted |
||
| 210 | && $reloadResponse->getHttpStatus() == 200 |
||
| 211 | ) { |
||
| 212 | $this->addFlashMessage( |
||
| 213 | 'All synonym removed.' |
||
| 214 | ); |
||
| 215 | } else { |
||
| 216 | $this->addFlashMessage( |
||
| 217 | 'Failed to remove all synonyms.', |
||
| 218 | 'An error occurred', |
||
| 219 | FlashMessage::ERROR |
||
| 220 | ); |
||
| 221 | } |
||
| 222 | return new RedirectResponse($this->uriBuilder->uriFor('index'), 303); |
||
| 223 | } |
||
| 224 | |||
| 225 | /** |
||
| 226 | * Deletes a synonym mapping by its base word. |
||
| 227 | * |
||
| 228 | * @param string $baseWord Synonym mapping base word |
||
| 229 | * @noinspection PhpUnused |
||
| 230 | */ |
||
| 231 | public function deleteSynonymsAction(string $baseWord): ResponseInterface |
||
| 232 | { |
||
| 233 | $coreAdmin = $this->selectedSolrCoreConnection->getAdminService(); |
||
| 234 | $deleteResponse = $coreAdmin->deleteSynonym($baseWord); |
||
| 235 | $reloadResponse = $coreAdmin->reloadCore(); |
||
| 236 | |||
| 237 | if ($deleteResponse->getHttpStatus() == 200 |
||
| 238 | && $reloadResponse->getHttpStatus() == 200 |
||
| 239 | ) { |
||
| 240 | $this->addFlashMessage( |
||
| 241 | 'Synonym removed.' |
||
| 242 | ); |
||
| 243 | } else { |
||
| 244 | $this->addFlashMessage( |
||
| 245 | 'Failed to remove synonym.', |
||
| 246 | 'An error occurred', |
||
| 247 | FlashMessage::ERROR |
||
| 248 | ); |
||
| 249 | } |
||
| 250 | |||
| 251 | return new RedirectResponse($this->uriBuilder->uriFor('index'), 303); |
||
| 252 | } |
||
| 253 | |||
| 254 | /** |
||
| 255 | * Saves the edited stop word list to Solr |
||
| 256 | * |
||
| 257 | * @param string $stopWords |
||
| 258 | * @param bool $replaceStopwords |
||
| 259 | * |
||
| 260 | * @return ResponseInterface |
||
| 261 | */ |
||
| 262 | public function saveStopWordsAction(string $stopWords, bool $replaceStopwords = true): ResponseInterface |
||
| 263 | { |
||
| 264 | // lowercase stopword before saving because terms get lowercased before stopword filtering |
||
| 265 | $newStopWords = mb_strtolower($stopWords); |
||
| 266 | $newStopWords = GeneralUtility::trimExplode("\n", $newStopWords, true); |
||
| 267 | |||
| 268 | $coreAdmin = $this->selectedSolrCoreConnection->getAdminService(); |
||
| 269 | $oldStopWords = $coreAdmin->getStopWords(); |
||
| 270 | |||
| 271 | if ($replaceStopwords) { |
||
| 272 | $removedStopWords = array_diff($oldStopWords, $newStopWords); |
||
| 273 | $wordsRemoved = $this->removeStopsWordsFromIndex($removedStopWords); |
||
| 274 | } else { |
||
| 275 | $wordsRemoved = true; |
||
| 276 | } |
||
| 277 | |||
| 278 | $wordsAdded = true; |
||
| 279 | $addedStopWords = array_diff($newStopWords, $oldStopWords); |
||
| 280 | if (!empty($addedStopWords)) { |
||
| 281 | $wordsAddedResponse = $coreAdmin->addStopWords($addedStopWords); |
||
| 282 | $wordsAdded = ($wordsAddedResponse->getHttpStatus() == 200); |
||
| 283 | } |
||
| 284 | |||
| 285 | $reloadResponse = $coreAdmin->reloadCore(); |
||
| 286 | if ($wordsRemoved && $wordsAdded && $reloadResponse->getHttpStatus() == 200) { |
||
| 287 | $this->addFlashMessage( |
||
| 288 | 'Stop Words Updated.' |
||
| 289 | ); |
||
| 290 | } |
||
| 291 | |||
| 292 | return new RedirectResponse($this->uriBuilder->uriFor('index'), 303); |
||
| 293 | } |
||
| 294 | |||
| 295 | /** |
||
| 296 | * @param string $content |
||
| 297 | * @param string $type |
||
| 298 | * @param string $fileExtension |
||
| 299 | * |
||
| 300 | * @return ResponseInterface |
||
| 301 | */ |
||
| 302 | protected function exportFile(string $content, string $type = 'synonyms', string $fileExtension = 'txt'): ResponseInterface |
||
| 303 | { |
||
| 304 | $coreAdmin = $this->selectedSolrCoreConnection->getAdminService(); |
||
| 305 | return $this->responseFactory->createResponse() |
||
| 306 | ->withHeader('Content-Type', 'text/plain; charset=utf-8') |
||
| 307 | ->withHeader('Cache-control', 'public') |
||
| 308 | ->withHeader('Content-Description', 'File transfer') |
||
| 309 | ->withHeader('Content-Description', 'File transfer') |
||
| 310 | ->withHeader( |
||
| 311 | 'Content-disposition', |
||
| 312 | 'attachment; filename =' . $type . '_' . $coreAdmin->getPrimaryEndpoint()->getCore() . '.' . $fileExtension |
||
| 313 | ) |
||
| 314 | ->withBody($this->streamFactory->createStream($content)); |
||
| 315 | } |
||
| 316 | |||
| 317 | /** |
||
| 318 | * Delete complete synonym list form solr |
||
| 319 | * |
||
| 320 | * @return bool |
||
| 321 | */ |
||
| 322 | protected function deleteAllSynonyms(): bool |
||
| 323 | { |
||
| 324 | $coreAdmin = $this->selectedSolrCoreConnection->getAdminService(); |
||
| 325 | $synonyms = $coreAdmin->getSynonyms(); |
||
| 326 | $allSynonymsCouldBeDeleted = true; |
||
| 327 | |||
| 328 | foreach ($synonyms as $baseWord => $synonym) { |
||
| 329 | $deleteResponse = $coreAdmin->deleteSynonym($baseWord); |
||
| 330 | $allSynonymsCouldBeDeleted = $allSynonymsCouldBeDeleted && $deleteResponse->getHttpStatus() == 200; |
||
| 331 | } |
||
| 332 | |||
| 333 | return $allSynonymsCouldBeDeleted; |
||
| 334 | } |
||
| 335 | |||
| 336 | /** |
||
| 337 | * @param $stopwordsToRemove |
||
| 338 | * @return bool |
||
| 339 | */ |
||
| 340 | protected function removeStopsWordsFromIndex($stopwordsToRemove): bool |
||
| 359 | } |
||
| 360 | |||
| 361 | /** |
||
| 362 | * Delete synonym entry if selected before |
||
| 363 | * @param bool $overrideExisting |
||
| 364 | * @param bool $deleteSynonymsBefore |
||
| 365 | * @param string $baseWord |
||
| 366 | */ |
||
| 367 | protected function deleteExistingSynonym(bool $overrideExisting, bool $deleteSynonymsBefore, string $baseWord) |
||
| 376 | } |
||
| 377 | } |
||
| 378 | } |
||
| 379 |
Loading history...
