class ExtractorQueue in Search API attachments 9.0.x

Processes Tasks for Search API Attachments.

Plugin annotation

@QueueWorker(
  id = "search_api_attachments",
  title = @Translation("Extractor Queue"),
  cron = {"time" = 180}
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Queue\QueueWorkerBase implements QueueWorkerInterface
    • class \Drupal\search_api_attachments\Plugin\QueueWorker\ExtractorQueue implements ContainerFactoryPluginInterface

File

src/Plugin/QueueWorker/ExtractorQueue.php, line 27

Namespace

Drupal\search_api_attachments\Plugin\QueueWorker

class ExtractorQueue extends QueueWorkerBase implements ContainerFactoryPluginInterface {

  /**
   * Text extractor service.
   *
   * @var \Drupal\search_api_attachments\TextExtractorPluginManager
   */
  protected $textExtractorPluginManager;

  /**
   * Entity type manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Key value service.
   *
   * @var \Drupal\Core\KeyValueStore\KeyValueFactoryInterface
   */
  protected $keyValue;

  /**
   * The logger service.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * Module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, TextExtractorPluginManager $text_extractor_plugin_manager, EntityTypeManagerInterface $entity_type_manager, KeyValueFactoryInterface $key_value, LoggerInterface $logger, ModuleHandlerInterface $module_handler) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->textExtractorPluginManager = $text_extractor_plugin_manager;
    $this->entityTypeManager = $entity_type_manager;
    $this->keyValue = $key_value;
    $this->logger = $logger;
    $this->moduleHandler = $module_handler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('plugin.manager.search_api_attachments.text_extractor'), $container
      ->get('entity_type.manager'), $container
      ->get('keyvalue'), $container
      ->get('logger.channel.search_api_attachments'), $container
      ->get('module_handler'));
  }

  /**
   * Get the extractor plugin.
   *
   * @return object
   *   The plugin.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   */
  protected function getExtractorPlugin() {

    // Get extractor configuration.
    $config = \Drupal::config(FilesExtractor::CONFIGNAME);
    $extractor_plugin_id = $config
      ->get('extraction_method');
    $configuration = $config
      ->get($extractor_plugin_id . '_configuration');

    // Get extractor plugin.
    return $this->textExtractorPluginManager
      ->createInstance($extractor_plugin_id, $configuration);
  }

  /**
   * {@inheritdoc}
   */
  public function processItem($data) {
    $extractor_plugin = $this
      ->getExtractorPlugin();
    if (!isset($data->fid)) {
      return;
    }

    // Load file from queue item.
    $file = $this->entityTypeManager
      ->getStorage('file')
      ->load($data->fid);
    if ($file === NULL) {
      return;
    }
    try {
      $collection = 'search_api_attachments';
      $key = $collection . ':' . $file
        ->id();

      // Skip file if element is found in key_value collection.
      $extracted_data = $this->keyValue
        ->get($collection)
        ->get($key);
      if (empty($extracted_data)) {

        // Extract file and save it in key_value collection.
        $extracted_data = $extractor_plugin
          ->extract($file);
        $this->keyValue
          ->get($collection)
          ->set($key, $extracted_data);
      }
      $fallback_collection = $this->keyValue
        ->get(FilesExtractor::FALLBACK_QUEUE_KV);
      $fallback_collection
        ->delete($data->entity_type . ':' . $data->entity_id);
      $entity = $this->entityTypeManager
        ->getStorage($data->entity_type)
        ->load($data->entity_id);
      if (!$entity) {
        return;
      }
      $indexes = ContentEntity::getIndexesForEntity($entity);
      $item_ids = [];
      if (is_a($entity, TranslatableInterface::class)) {
        $translations = $entity
          ->getTranslationLanguages();
        foreach ($translations as $translation_id => $translation) {
          $item_ids[] = $entity
            ->id() . ':' . $translation_id;
        }
      }
      $datasource_id = 'entity:' . $data->entity_type;
      foreach ($indexes as $index) {
        $index
          ->trackItemsUpdated($datasource_id, $item_ids);
      }
      $this->moduleHandler
        ->invokeAll('search_api_attachments_content_extracted', [
        $file,
        $entity,
      ]);
    } catch (\Exception $exception) {
      if ($data->extract_attempts < 5) {
        $data->extract_attempts++;
        \Drupal::queue('search_api_attachments')
          ->createItem($data);
      }
      else {
        $message_params = [
          '@file_id' => $data->fid,
          '@entity_id' => $data->entity_id,
          '@entity_type' => $data->entity_type,
        ];
        $this->logger
          ->log(LogLevel::ERROR, 'Text extraction failed after 5 attempts @file_id for @entity_type @entity_id.', $message_params);
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ExtractorQueue::$entityTypeManager	protected	property	Entity type manager service.
ExtractorQueue::$keyValue	protected	property	Key value service.
ExtractorQueue::$logger	protected	property	The logger service.
ExtractorQueue::$moduleHandler	protected	property	Module handler service.
ExtractorQueue::$textExtractorPluginManager	protected	property	Text extractor service.
ExtractorQueue::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ExtractorQueue::getExtractorPlugin	protected	function	Get the extractor plugin.
ExtractorQueue::processItem	public	function	Works on a single queue item. Overrides QueueWorkerInterface::processItem
ExtractorQueue::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.