TYPO3-Solr /
ext-solr
Complex classes like Queue 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. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
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 Queue, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 44 | class Queue |
||
| 45 | { |
||
| 46 | /** |
||
| 47 | * @var RootPageResolver |
||
| 48 | */ |
||
| 49 | protected $rootPageResolver; |
||
| 50 | |||
| 51 | /** |
||
| 52 | * @var ConfigurationAwareRecordService |
||
| 53 | */ |
||
| 54 | protected $recordService; |
||
| 55 | |||
| 56 | /** |
||
| 57 | * @var \ApacheSolrForTypo3\Solr\System\Logging\SolrLogManager |
||
| 58 | */ |
||
| 59 | protected $logger = null; |
||
| 60 | |||
| 61 | /** |
||
| 62 | * Queue constructor. |
||
| 63 | * @param RootPageResolver|null $rootPageResolver |
||
| 64 | * @param ConfigurationAwareRecordService|null $recordService |
||
| 65 | */ |
||
| 66 | 89 | public function __construct(RootPageResolver $rootPageResolver = null, ConfigurationAwareRecordService $recordService = null) |
|
| 72 | |||
| 73 | // FIXME some of the methods should be renamed to plural forms |
||
| 74 | // FIXME singular form methods should deal with exactly one item only |
||
| 75 | |||
| 76 | /** |
||
| 77 | * Returns the timestamp of the last indexing run. |
||
| 78 | * |
||
| 79 | * @param int $rootPageId The root page uid for which to get |
||
| 80 | * the last indexed item id |
||
| 81 | * @return int Timestamp of last index run. |
||
| 82 | */ |
||
| 83 | 2 | public function getLastIndexTime($rootPageId) |
|
| 84 | { |
||
| 85 | 2 | $lastIndexTime = 0; |
|
| 86 | |||
| 87 | 2 | $lastIndexedRow = $this->getLastIndexedRow($rootPageId); |
|
| 88 | |||
| 89 | 2 | if ($lastIndexedRow[0]['indexed']) { |
|
| 90 | 1 | $lastIndexTime = $lastIndexedRow[0]['indexed']; |
|
| 91 | } |
||
| 92 | |||
| 93 | 2 | return $lastIndexTime; |
|
| 94 | } |
||
| 95 | |||
| 96 | /** |
||
| 97 | * Returns the uid of the last indexed item in the queue |
||
| 98 | * |
||
| 99 | * @param int $rootPageId The root page uid for which to get |
||
| 100 | * the last indexed item id |
||
| 101 | * @return int The last indexed item's ID. |
||
| 102 | */ |
||
| 103 | 3 | public function getLastIndexedItemId($rootPageId) |
|
| 104 | { |
||
| 105 | 3 | $lastIndexedItemId = 0; |
|
| 106 | |||
| 107 | 3 | $lastIndexedItemRow = $this->getLastIndexedRow($rootPageId); |
|
| 108 | 3 | if ($lastIndexedItemRow[0]['uid']) { |
|
| 109 | 2 | $lastIndexedItemId = $lastIndexedItemRow[0]['uid']; |
|
| 110 | } |
||
| 111 | |||
| 112 | 3 | return $lastIndexedItemId; |
|
| 113 | } |
||
| 114 | |||
| 115 | /** |
||
| 116 | * Fetches the last indexed row |
||
| 117 | * |
||
| 118 | * @param int $rootPageId The root page uid for which to get the last indexed row |
||
| 119 | * @return array |
||
| 120 | */ |
||
| 121 | 5 | protected function getLastIndexedRow($rootPageId) |
|
| 138 | |||
| 139 | /** |
||
| 140 | * Truncate and rebuild the tx_solr_indexqueue_item table. This is the most |
||
| 141 | * complete way to force reindexing, or to build the Index Queue for the |
||
| 142 | * first time. The Index Queue initialization is site-specific. |
||
| 143 | * |
||
| 144 | * @param Site $site The site to initialize |
||
| 145 | * @param string $indexingConfigurationName Name of a specific |
||
| 146 | * indexing configuration |
||
| 147 | * @return array An array of booleans, each representing whether the |
||
| 148 | * initialization for an indexing configuration was successful |
||
| 149 | */ |
||
| 150 | 6 | public function initialize(Site $site, $indexingConfigurationName = '') |
|
| 151 | { |
||
| 152 | 6 | $indexingConfigurations = []; |
|
| 153 | 6 | $initializationStatus = []; |
|
| 154 | |||
| 155 | 6 | if (empty($indexingConfigurationName)) { |
|
| 156 | 1 | $solrConfiguration = $site->getSolrConfiguration(); |
|
| 157 | 1 | $indexingConfigurations = $solrConfiguration->getEnabledIndexQueueConfigurationNames(); |
|
| 158 | } else { |
||
| 159 | 5 | $indexingConfigurations[] = $indexingConfigurationName; |
|
| 160 | } |
||
| 161 | |||
| 162 | 6 | foreach ($indexingConfigurations as $indexingConfigurationName) { |
|
| 163 | 6 | $initializationStatus[$indexingConfigurationName] = $this->initializeIndexingConfiguration( |
|
| 164 | $site, |
||
| 165 | 6 | $indexingConfigurationName |
|
| 166 | ); |
||
| 167 | } |
||
| 168 | |||
| 169 | 6 | if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['postProcessIndexQueueInitialization'])) { |
|
| 170 | foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['postProcessIndexQueueInitialization'] as $classReference) { |
||
| 171 | $indexQueueInitializationPostProcessor = GeneralUtility::getUserObj($classReference); |
||
| 172 | |||
| 173 | if ($indexQueueInitializationPostProcessor instanceof InitializationPostProcessor) { |
||
| 174 | $indexQueueInitializationPostProcessor->postProcessIndexQueueInitialization( |
||
| 175 | $site, |
||
| 176 | $indexingConfigurations, |
||
| 177 | $initializationStatus |
||
| 178 | ); |
||
| 179 | } else { |
||
| 180 | throw new \UnexpectedValueException( |
||
| 181 | get_class($indexQueueInitializationPostProcessor) . |
||
| 182 | ' must implement interface ' . InitializationPostProcessor::class, |
||
| 183 | 1345815561 |
||
| 184 | ); |
||
| 185 | } |
||
| 186 | } |
||
| 187 | } |
||
| 188 | |||
| 189 | 6 | return $initializationStatus; |
|
| 190 | } |
||
| 191 | |||
| 192 | /** |
||
| 193 | * Initializes the Index Queue for a specific indexing configuration. |
||
| 194 | * |
||
| 195 | * @param Site $site The site to initialize |
||
| 196 | * @param string $indexingConfigurationName name of a specific |
||
| 197 | * indexing configuration |
||
| 198 | * @return bool TRUE if the initialization was successful, FALSE otherwise |
||
| 199 | */ |
||
| 200 | 6 | protected function initializeIndexingConfiguration( |
|
| 223 | |||
| 224 | /** |
||
| 225 | * Marks an item as needing (re)indexing. |
||
| 226 | * |
||
| 227 | * Like with Solr itself, there's no add method, just a simple update method |
||
| 228 | * that handles the adds, too. |
||
| 229 | * |
||
| 230 | * The method creates or updates the index queue items for all related rootPageIds. |
||
| 231 | * |
||
| 232 | * @param string $itemType The item's type, usually a table name. |
||
| 233 | * @param string $itemUid The item's uid, usually an integer uid, could be a |
||
| 234 | * different value for non-database-record types. |
||
| 235 | * @param int $forcedChangeTime The change time for the item if set, otherwise |
||
| 236 | * value from getItemChangedTime() is used. |
||
| 237 | */ |
||
| 238 | 50 | public function updateItem($itemType, $itemUid, $forcedChangeTime = 0) |
|
| 259 | |||
| 260 | /** |
||
| 261 | * Finds indexing errors for the current site |
||
| 262 | * |
||
| 263 | * @param Site $site |
||
| 264 | * @return array Error items for the current site's Index Queue |
||
| 265 | */ |
||
| 266 | public function getErrorsBySite(Site $site) |
||
| 274 | |||
| 275 | /** |
||
| 276 | * Resets all the errors for all index queue items. |
||
| 277 | * |
||
| 278 | * @return mixed |
||
| 279 | */ |
||
| 280 | public function resetAllErrors() |
||
| 288 | |||
| 289 | /** |
||
| 290 | * Updates an existing queue entry by $itemType $itemUid and $rootPageId. |
||
| 291 | * |
||
| 292 | * @param string $itemType The item's type, usually a table name. |
||
| 293 | * @param int $itemUid The item's uid, usually an integer uid, could be a |
||
| 294 | * different value for non-database-record types. |
||
| 295 | * @param string $indexingConfiguration The name of the related indexConfiguration |
||
| 296 | * @param int $rootPageId The uid of the rootPage |
||
| 297 | * @param int $forcedChangeTime The forced change time that should be used for updating |
||
| 298 | */ |
||
| 299 | 10 | protected function updateExistingItem($itemType, $itemUid, $indexingConfiguration, $rootPageId, $forcedChangeTime) |
|
| 300 | { |
||
| 301 | // update if that item is in the queue already |
||
| 302 | $changes = [ |
||
| 303 | 10 | 'changed' => ($forcedChangeTime > 0) ? $forcedChangeTime : $this->getItemChangedTime($itemType, $itemUid) |
|
| 304 | ]; |
||
| 305 | |||
| 306 | 10 | if (!empty($indexingConfiguration)) { |
|
| 307 | 10 | $changes['indexing_configuration'] = $indexingConfiguration; |
|
| 308 | } |
||
| 309 | |||
| 310 | 10 | $GLOBALS['TYPO3_DB']->exec_UPDATEquery( |
|
| 311 | 10 | 'tx_solr_indexqueue_item', |
|
| 312 | 10 | 'item_type = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr($itemType, 'tx_solr_indexqueue_item') . |
|
| 313 | 10 | ' AND item_uid = ' . (int)$itemUid . ' AND root = ' . (int)$rootPageId, |
|
| 314 | 10 | $changes); |
|
| 315 | 10 | } |
|
| 316 | |||
| 317 | /** |
||
| 318 | * Adds an item to the index queue. |
||
| 319 | * |
||
| 320 | * Not meant for public use. |
||
| 321 | * |
||
| 322 | * @param string $itemType The item's type, usually a table name. |
||
| 323 | * @param string $itemUid The item's uid, usually an integer uid, could be a |
||
| 324 | * different value for non-database-record types. |
||
| 325 | * @param string $indexingConfiguration The item's indexing configuration to use. |
||
| 326 | * Optional, overwrites existing / determined configuration. |
||
| 327 | * @return void |
||
| 328 | */ |
||
| 329 | 43 | private function addNewItem($itemType, $itemUid, $indexingConfiguration, $rootPageId) |
|
| 354 | |||
| 355 | /** |
||
| 356 | * Get record to be added in addNewItem |
||
| 357 | * |
||
| 358 | * @param string $itemType The item's type, usually a table name. |
||
| 359 | * @param string $itemUid The item's uid, usually an integer uid, could be a |
||
| 360 | * different value for non-database-record types. |
||
| 361 | * @param string $additionalRecordFields for sql-query |
||
| 362 | * |
||
| 363 | * @return array|NULL |
||
| 364 | */ |
||
| 365 | 43 | protected function getRecordCached($itemType, $itemUid, $additionalRecordFields) |
|
| 378 | |||
| 379 | /** |
||
| 380 | * Determines the time for when an item should be indexed. This timestamp |
||
| 381 | * is then stored in the changed column in the Index Queue. |
||
| 382 | * |
||
| 383 | * The changed timestamp usually is now - time(). For records which are set |
||
| 384 | * to published at a later time, this timestamp is the start time. So if a |
||
| 385 | * future start time has been set, that will be used to delay indexing |
||
| 386 | * of an item. |
||
| 387 | * |
||
| 388 | * @param string $itemType The item's table name. |
||
| 389 | * @param string $itemUid The item's uid, usually an integer uid, could be a |
||
| 390 | * different value for non-database-record types. |
||
| 391 | * @return int Timestamp of the item's changed time or future start time |
||
| 392 | */ |
||
| 393 | 48 | protected function getItemChangedTime($itemType, $itemUid) |
|
| 394 | { |
||
| 395 | 48 | $itemTypeHasStartTimeColumn = false; |
|
| 396 | 48 | $changedTimeColumns = $GLOBALS['TCA'][$itemType]['ctrl']['tstamp']; |
|
| 397 | 48 | $startTime = 0; |
|
| 398 | 48 | $pageChangedTime = 0; |
|
| 399 | |||
| 400 | 48 | if (!empty($GLOBALS['TCA'][$itemType]['ctrl']['enablecolumns']['starttime'])) { |
|
| 401 | 48 | $itemTypeHasStartTimeColumn = true; |
|
| 402 | 48 | $changedTimeColumns .= ', ' . $GLOBALS['TCA'][$itemType]['ctrl']['enablecolumns']['starttime']; |
|
| 403 | } |
||
| 404 | 48 | if ($itemType == 'pages') { |
|
| 405 | // does not carry time information directly, but needed to support |
||
| 406 | // canonical pages |
||
| 407 | 35 | $changedTimeColumns .= ', content_from_pid'; |
|
| 408 | } |
||
| 409 | |||
| 410 | 48 | $record = BackendUtility::getRecord($itemType, $itemUid, $changedTimeColumns); |
|
| 411 | 48 | $itemChangedTime = $record[$GLOBALS['TCA'][$itemType]['ctrl']['tstamp']]; |
|
| 412 | |||
| 413 | 48 | if ($itemTypeHasStartTimeColumn) { |
|
| 414 | 48 | $startTime = $record[$GLOBALS['TCA'][$itemType]['ctrl']['enablecolumns']['starttime']]; |
|
| 415 | } |
||
| 416 | |||
| 417 | 48 | if ($itemType == 'pages') { |
|
| 418 | 35 | $record['uid'] = $itemUid; |
|
| 419 | // overrule the page's last changed time with the most recent |
||
| 420 | //content element change |
||
| 421 | 35 | $pageChangedTime = $this->getPageItemChangedTime($record); |
|
| 422 | } |
||
| 423 | |||
| 424 | 48 | $localizationsChangedTime = $this->getLocalizableItemChangedTime($itemType, $itemUid); |
|
| 425 | |||
| 426 | // if start time exists and start time is higher than last changed timestamp |
||
| 427 | // then set changed to the future start time to make the item |
||
| 428 | // indexed at a later time |
||
| 429 | 48 | $changedTime = max( |
|
| 430 | $itemChangedTime, |
||
| 431 | $pageChangedTime, |
||
| 432 | $localizationsChangedTime, |
||
| 433 | 48 | $startTime |
|
| 434 | ); |
||
| 435 | |||
| 436 | 48 | return $changedTime; |
|
| 437 | } |
||
| 438 | |||
| 439 | /** |
||
| 440 | * Gets the most recent changed time of a page's content elements |
||
| 441 | * |
||
| 442 | * @param array $page Partial page record |
||
| 443 | * @return int Timestamp of the most recent content element change |
||
| 444 | */ |
||
| 445 | 35 | protected function getPageItemChangedTime(array $page) |
|
| 461 | |||
| 462 | /** |
||
| 463 | * Gets the most recent changed time for an item taking into account |
||
| 464 | * localized records. |
||
| 465 | * |
||
| 466 | * @param string $itemType The item's type, usually a table name. |
||
| 467 | * @param string $itemUid The item's uid, usually an integer uid, could be a |
||
| 468 | * different value for non-database-record types. |
||
| 469 | * @return int Timestamp of the most recent content element change |
||
| 470 | */ |
||
| 471 | 48 | protected function getLocalizableItemChangedTime($itemType, $itemUid) |
|
| 472 | { |
||
| 473 | 48 | $localizedChangedTime = 0; |
|
| 474 | |||
| 475 | 48 | if (isset($GLOBALS['TCA'][$itemType]['ctrl']['transOrigPointerField'])) { |
|
| 476 | // table is localizable |
||
| 477 | 13 | $translationOriginalPointerField = $GLOBALS['TCA'][$itemType]['ctrl']['transOrigPointerField']; |
|
| 478 | |||
| 479 | 13 | $itemUid = intval($itemUid); |
|
| 480 | 13 | $localizedChangedTime = $GLOBALS['TYPO3_DB']->exec_SELECTgetSingleRow( |
|
| 481 | 13 | 'MAX(tstamp) AS changed_time', |
|
| 482 | $itemType, |
||
| 483 | 13 | "uid = $itemUid OR $translationOriginalPointerField = $itemUid" |
|
| 484 | ); |
||
| 485 | 13 | $localizedChangedTime = $localizedChangedTime['changed_time']; |
|
| 486 | } |
||
| 487 | |||
| 488 | 48 | return $localizedChangedTime; |
|
| 489 | } |
||
| 490 | |||
| 491 | /** |
||
| 492 | * Checks whether the Index Queue contains a specific item. |
||
| 493 | * |
||
| 494 | * @param string $itemType The item's type, usually a table name. |
||
| 495 | * @param string $itemUid The item's uid, usually an integer uid, could be a |
||
| 496 | * different value for non-database-record types. |
||
| 497 | * @return bool TRUE if the item is found in the queue, FALSE otherwise |
||
| 498 | */ |
||
| 499 | 3 | public function containsItem($itemType, $itemUid) |
|
| 511 | |||
| 512 | /** |
||
| 513 | * Checks whether the Index Queue contains a specific item. |
||
| 514 | * |
||
| 515 | * @param string $itemType The item's type, usually a table name. |
||
| 516 | * @param string $itemUid The item's uid, usually an integer uid, could be a |
||
| 517 | * different value for non-database-record types. |
||
| 518 | * @param integer $rootPageId |
||
| 519 | * @return bool TRUE if the item is found in the queue, FALSE otherwise |
||
| 520 | */ |
||
| 521 | 49 | public function containsItemWithRootPageId($itemType, $itemUid, $rootPageId) |
|
| 533 | |||
| 534 | /** |
||
| 535 | * Checks whether the Index Queue contains a specific item that has been |
||
| 536 | * marked as indexed. |
||
| 537 | * |
||
| 538 | * @param string $itemType The item's type, usually a table name. |
||
| 539 | * @param string $itemUid The item's uid, usually an integer uid, could be a |
||
| 540 | * different value for non-database-record types. |
||
| 541 | * @return bool TRUE if the item is found in the queue and marked as |
||
| 542 | * indexed, FALSE otherwise |
||
| 543 | */ |
||
| 544 | 3 | public function containsIndexedItem($itemType, $itemUid) |
|
| 557 | |||
| 558 | /** |
||
| 559 | * Removes an item from the Index Queue. |
||
| 560 | * |
||
| 561 | * @param string $itemType The type of the item to remove, usually a table name. |
||
| 562 | * @param int $itemUid The uid of the item to remove |
||
| 563 | */ |
||
| 564 | 29 | public function deleteItem($itemType, $itemUid) |
|
| 592 | |||
| 593 | /** |
||
| 594 | * Removes all items of a certain type from the Index Queue. |
||
| 595 | * |
||
| 596 | * @param string $itemType The type of items to remove, usually a table name. |
||
| 597 | */ |
||
| 598 | 1 | public function deleteItemsByType($itemType) |
|
| 599 | { |
||
| 600 | 1 | $uidList = []; |
|
| 601 | |||
| 602 | // get the item uids to use them in the deletes afterwards |
||
| 603 | 1 | $items = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows( |
|
| 604 | 1 | 'uid', |
|
| 605 | 1 | 'tx_solr_indexqueue_item', |
|
| 606 | 1 | 'item_type = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr( |
|
| 607 | $itemType, |
||
| 608 | 1 | 'tx_solr_indexqueue_item' |
|
| 609 | ) |
||
| 610 | ); |
||
| 611 | |||
| 612 | 1 | if (count($items)) { |
|
| 613 | 1 | foreach ($items as $item) { |
|
| 614 | 1 | $uidList[] = $item['uid']; |
|
| 615 | } |
||
| 616 | |||
| 617 | 1 | $GLOBALS['TYPO3_DB']->exec_DELETEquery( |
|
| 618 | 1 | 'tx_solr_indexqueue_item', |
|
| 619 | 1 | 'uid IN(' . implode(',', $uidList) . ')' |
|
| 620 | ); |
||
| 621 | 1 | $GLOBALS['TYPO3_DB']->exec_DELETEquery( |
|
| 622 | 1 | 'tx_solr_indexqueue_indexing_property', |
|
| 623 | 1 | 'item_id IN(' . implode(',', $uidList) . ')' |
|
| 624 | ); |
||
| 625 | } |
||
| 626 | 1 | } |
|
| 627 | |||
| 628 | /** |
||
| 629 | * Removes all items of a certain site from the Index Queue. Accepts an |
||
| 630 | * optional parameter to limit the deleted items by indexing configuration. |
||
| 631 | * |
||
| 632 | * @param Site $site The site to remove items for. |
||
| 633 | * @param string $indexingConfigurationName Name of a specific indexing |
||
| 634 | * configuration |
||
| 635 | */ |
||
| 636 | 6 | public function deleteItemsBySite( |
|
| 686 | |||
| 687 | /** |
||
| 688 | * Removes all items from the Index Queue. |
||
| 689 | * |
||
| 690 | */ |
||
| 691 | 1 | public function deleteAllItems() |
|
| 695 | |||
| 696 | /** |
||
| 697 | * Gets a single Index Queue item by its uid. |
||
| 698 | * |
||
| 699 | * @param int $itemId Index Queue item uid |
||
| 700 | * @return Item The request Index Queue item or NULL |
||
| 701 | * if no item with $itemId was found |
||
| 702 | */ |
||
| 703 | 19 | public function getItem($itemId) |
|
| 704 | { |
||
| 705 | 19 | $item = null; |
|
| 706 | |||
| 707 | 19 | $indexQueueItemRecord = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows( |
|
| 708 | 19 | '*', |
|
| 709 | 19 | 'tx_solr_indexqueue_item', |
|
| 710 | 19 | 'uid = ' . intval($itemId) |
|
| 711 | ); |
||
| 712 | |||
| 713 | 19 | if (count($indexQueueItemRecord) == 1) { |
|
| 714 | 16 | $indexQueueItemRecord = $indexQueueItemRecord[0]; |
|
| 715 | 16 | $item = GeneralUtility::makeInstance( |
|
| 716 | 16 | Item::class, |
|
| 717 | 16 | $indexQueueItemRecord |
|
| 718 | ); |
||
| 719 | } |
||
| 720 | |||
| 721 | 19 | return $item; |
|
| 722 | } |
||
| 723 | |||
| 724 | /** |
||
| 725 | * Gets Index Queue items by type and uid. |
||
| 726 | * |
||
| 727 | * @param string $itemType item type, usually the table name |
||
| 728 | * @param int $itemUid item uid |
||
| 729 | * @return Item[] An array of items matching $itemType and $itemUid |
||
| 730 | */ |
||
| 731 | 22 | public function getItems($itemType, $itemUid) |
|
| 743 | |||
| 744 | /** |
||
| 745 | * Returns the number of items for all queues. |
||
| 746 | * |
||
| 747 | * @return int |
||
| 748 | */ |
||
| 749 | 64 | public function getAllItemsCount() |
|
| 753 | |||
| 754 | /** |
||
| 755 | * @param string $where |
||
| 756 | * @return int |
||
| 757 | */ |
||
| 758 | 64 | private function getItemCount($where = '1=1') |
|
| 765 | |||
| 766 | /** |
||
| 767 | * Extracts the number of pending, indexed and erroneous items from the |
||
| 768 | * Index Queue. |
||
| 769 | * |
||
| 770 | * @param Site $site |
||
| 771 | * @param string $indexingConfigurationName |
||
| 772 | * |
||
| 773 | * @return QueueStatistic |
||
| 774 | */ |
||
| 775 | 5 | public function getStatisticsBySite(Site $site, $indexingConfigurationName = '') |
|
| 776 | { |
||
| 777 | 5 | $indexingConfigurationConstraint = $this->buildIndexConfigurationConstraint($indexingConfigurationName); |
|
| 778 | 5 | $where = 'root = ' . (int)$site->getRootPageId() . $indexingConfigurationConstraint; |
|
| 779 | |||
| 780 | 5 | $indexQueueStats = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows( |
|
| 781 | 'indexed < changed as pending,' |
||
| 782 | . '(errors not like "") as failed,' |
||
| 783 | 5 | . 'COUNT(*) as count', |
|
| 784 | 5 | 'tx_solr_indexqueue_item', |
|
| 785 | $where, |
||
| 786 | 5 | 'pending, failed' |
|
| 787 | ); |
||
| 788 | /** @var $statistic QueueStatistic */ |
||
| 789 | 5 | $statistic = GeneralUtility::makeInstance(QueueStatistic::class); |
|
| 790 | |||
| 791 | 5 | foreach ($indexQueueStats as $row) { |
|
| 792 | 5 | if ($row['failed'] == 1) { |
|
| 793 | 1 | $statistic->setFailedCount((int)$row['count']); |
|
| 794 | 5 | } elseif ($row['pending'] == 1) { |
|
| 795 | 5 | $statistic->setPendingCount((int)$row['count']); |
|
| 796 | } else { |
||
| 797 | 3 | $statistic->setSuccessCount((int)$row['count']); |
|
| 798 | } |
||
| 799 | } |
||
| 800 | |||
| 801 | 5 | return $statistic; |
|
| 802 | } |
||
| 803 | |||
| 804 | /** |
||
| 805 | * Build a database constraint that limits to a certain indexConfigurationName |
||
| 806 | * |
||
| 807 | * @param string $indexingConfigurationName |
||
| 808 | * @return string |
||
| 809 | */ |
||
| 810 | 5 | protected function buildIndexConfigurationConstraint($indexingConfigurationName) |
|
| 819 | |||
| 820 | /** |
||
| 821 | * Gets $limit number of items to index for a particular $site. |
||
| 822 | * |
||
| 823 | * @param Site $site TYPO3 site |
||
| 824 | * @param int $limit Number of items to get from the queue |
||
| 825 | * @return Item[] Items to index to the given solr server |
||
| 826 | */ |
||
| 827 | 7 | public function getItemsToIndex(Site $site, $limit = 50) |
|
| 850 | |||
| 851 | /** |
||
| 852 | * Creates an array of ApacheSolrForTypo3\Solr\IndexQueue\Item objects from an array of |
||
| 853 | * index queue records. |
||
| 854 | * |
||
| 855 | * @param array $indexQueueItemRecords Array of plain index queue records |
||
| 856 | * @return array Array of ApacheSolrForTypo3\Solr\IndexQueue\Item objects |
||
| 857 | */ |
||
| 858 | 27 | protected function getIndexQueueItemObjectsFromRecords( |
|
| 859 | array $indexQueueItemRecords |
||
| 860 | ) { |
||
| 861 | 27 | $indexQueueItems = []; |
|
| 862 | 27 | $tableUids = []; |
|
| 863 | 27 | $tableRecords = []; |
|
| 864 | |||
| 865 | // grouping records by table |
||
| 866 | 27 | foreach ($indexQueueItemRecords as $indexQueueItemRecord) { |
|
| 867 | 27 | $tableUids[$indexQueueItemRecord['item_type']][] = $indexQueueItemRecord['item_uid']; |
|
| 868 | } |
||
| 869 | |||
| 870 | // fetching records by table, saves us a lot of single queries |
||
| 871 | 27 | foreach ($tableUids as $table => $uids) { |
|
| 872 | 27 | $uidList = implode(',', $uids); |
|
| 873 | 27 | $records = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows( |
|
| 874 | 27 | '*', |
|
| 875 | $table, |
||
| 876 | 27 | 'uid IN(' . $uidList . ')', |
|
| 877 | 27 | '', '', '', // group, order, limit |
|
| 878 | 27 | 'uid' |
|
| 879 | ); |
||
| 880 | 27 | $tableRecords[$table] = $records; |
|
| 881 | |||
| 882 | 27 | if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['postProcessFetchRecordsForIndexQueueItem'])) { |
|
| 883 | $params = ['table' => $table, 'uids' => $uids, 'tableRecords' => &$tableRecords]; |
||
| 884 | foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['postProcessFetchRecordsForIndexQueueItem'] as $reference) { |
||
| 885 | GeneralUtility::callUserFunction($reference, $params, $this); |
||
| 886 | } |
||
| 887 | unset($params); |
||
| 888 | } |
||
| 889 | } |
||
| 890 | |||
| 891 | // creating index queue item objects and assigning / mapping |
||
| 892 | // records to index queue items |
||
| 893 | 27 | foreach ($indexQueueItemRecords as $indexQueueItemRecord) { |
|
| 894 | 27 | if (isset($tableRecords[$indexQueueItemRecord['item_type']][$indexQueueItemRecord['item_uid']])) { |
|
| 895 | 26 | $indexQueueItems[] = GeneralUtility::makeInstance( |
|
| 896 | 26 | Item::class, |
|
| 897 | $indexQueueItemRecord, |
||
| 898 | 26 | $tableRecords[$indexQueueItemRecord['item_type']][$indexQueueItemRecord['item_uid']] |
|
| 899 | ); |
||
| 900 | } else { |
||
| 901 | 1 | $this->logger->log( |
|
| 902 | 1 | SolrLogManager::ERROR, |
|
| 903 | 1 | 'Record missing for Index Queue item. Item removed.', |
|
| 904 | [ |
||
| 905 | 1 | $indexQueueItemRecord |
|
| 906 | ] |
||
| 907 | ); |
||
| 908 | 1 | $this->deleteItem($indexQueueItemRecord['item_type'], |
|
| 909 | 1 | $indexQueueItemRecord['item_uid']); |
|
| 910 | } |
||
| 911 | } |
||
| 912 | |||
| 913 | 27 | return $indexQueueItems; |
|
| 914 | } |
||
| 915 | |||
| 916 | /** |
||
| 917 | * Marks an item as failed and causes the indexer to skip the item in the |
||
| 918 | * next run. |
||
| 919 | * |
||
| 920 | * @param int|Item $item Either the item's Index Queue uid or the complete item |
||
| 921 | * @param string $errorMessage Error message |
||
| 922 | */ |
||
| 923 | 6 | public function markItemAsFailed($item, $errorMessage = '') |
|
| 944 | |||
| 945 | /** |
||
| 946 | * Sets the timestamp of when an item last has been indexed. |
||
| 947 | * |
||
| 948 | * @param Item $item |
||
| 949 | */ |
||
| 950 | 6 | public function updateIndexTimeByItem(Item $item) |
|
| 958 | } |
||
| 959 |
