class PythonPdf2txtExtractor in Search API attachments 9.0.x

Same name and namespace in other branches

8 src/Plugin/search_api_attachments/PythonPdf2txtExtractor.php \Drupal\search_api_attachments\Plugin\search_api_attachments\PythonPdf2txtExtractor

Provides python pdf2text extractor.

Plugin annotation


@SearchApiAttachmentsTextExtractor(
  id = "python_pdf2txt_extractor",
  label = @Translation("Python Pdf2txt Extractor"),
  description = @Translation("Adds python Pdf2txt extractor support."),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\search_api_attachments\TextExtractorPluginBase implements ContainerFactoryPluginInterface, TextExtractorPluginInterface
    class \Drupal\search_api_attachments\Plugin\search_api_attachments\PythonPdf2txtExtractor

Expanded class hierarchy of PythonPdf2txtExtractor

File

src/Plugin/search_api_attachments/PythonPdf2txtExtractor.php, line 18

Namespace

Drupal\search_api_attachments\Plugin\search_api_attachments

View source

class PythonPdf2txtExtractor extends TextExtractorPluginBase {

  /**
   * Extract file with python Pdf2txt library.
   *
   * @param \Drupal\file\Entity\File $file
   *   A file object.
   *
   * @return string
   *   The text extracted from the file.
   */
  public function extract(File $file) {
    if (in_array($file
      ->getMimeType(), $this
      ->getPdfMimeTypes())) {
      $output = '';
      $filepath = $this
        ->getRealpath($file
        ->getFileUri());

      // Restore the locale.
      $python_path = $this->configuration['python_path'];
      $python_pdf2txt_script = realpath($this->configuration['python_pdf2txt_script']);
      $cmd = escapeshellcmd($python_path) . ' ' . escapeshellarg($python_pdf2txt_script) . ' -C -t text ' . escapeshellarg($filepath);

      // UTF-8 multibyte characters will be stripped by escapeshellargs() for
      // the default C-locale.
      // So temporarily set the locale to UTF-8 so that the filepath remains
      // valid.
      $backup_locale = setlocale(LC_CTYPE, '0');
      setlocale(LC_CTYPE, $backup_locale);

      // Support UTF-8 commands.
      // @see http://www.php.net/manual/en/function.shell-exec.php#85095
      shell_exec("LANG=en_US.utf-8");
      $output = shell_exec($cmd);
      if (is_null($output)) {
        throw new \Exception('Python Pdf2txt Exctractor is not available.');
      }
      return $output;
    }
    else {
      return NULL;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['python_path'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Path to python executable'),
      '#description' => $this
        ->t('Enter the path to python executable. Example: "python".'),
      '#default_value' => $this->configuration['python_path'],
      '#required' => TRUE,
    ];
    $form['python_pdf2txt_script'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Full path to the python pdf2txt script'),
      '#description' => $this
        ->t('Enter the full path to the python pdf2txt script. Example: "/usr/bin/pdf2txt.py".'),
      '#default_value' => $this->configuration['python_pdf2txt_script'],
      '#required' => TRUE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValue([
      'text_extractor_config',
    ]);
    $python_path = $values['python_path'];
    $python_pdf2txt_script = $values['python_pdf2txt_script'];

    // Check that the file exists.
    if (!file_exists($python_pdf2txt_script)) {
      $form_state
        ->setError($form['text_extractor_config']['python_pdf2txt_script'], $this
        ->t('The file %path does not exist.', [
        '%path' => $python_pdf2txt_script,
      ]));
    }
    else {
      $cmd = escapeshellcmd($python_path) . ' ' . escapeshellarg($python_pdf2txt_script);
      exec($cmd, $output, $return_code);

      // $return_code = 1 if it fails. 100 instead.
      if ($return_code != 100) {
        $form_state
          ->setError($form['text_extractor_config']['python_path'], '');
        $form_state
          ->setError($form['text_extractor_config']['python_pdf2txt_script'], $this
          ->t('Python Pdf2txt script file is not executable.'));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration['python_path'] = $form_state
      ->getValue([
      'text_extractor_config',
      'python_path',
    ]);
    $this->configuration['python_pdf2txt_script'] = $form_state
      ->getValue([
      'text_extractor_config',
      'python_pdf2txt_script',
    ]);
    parent::submitConfigurationForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
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.
PythonPdf2txtExtractor::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
PythonPdf2txtExtractor::extract	public	function	Extract file with python Pdf2txt library. Overrides TextExtractorPluginBase::extract
PythonPdf2txtExtractor::submitConfigurationForm	public	function	Form submission handler. Overrides TextExtractorPluginBase::submitConfigurationForm
PythonPdf2txtExtractor::validateConfigurationForm	public	function	Form validation handler. Overrides TextExtractorPluginBase::validateConfigurationForm
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TextExtractorPluginBase::$configFactory	protected	property	Config factory service.
TextExtractorPluginBase::$messenger	protected	property	The messenger. Overrides MessengerTrait::$messenger
TextExtractorPluginBase::$mimeTypeGuesser	protected	property	Mime type guesser service.
TextExtractorPluginBase::$streamWrapperManager	protected	property	Stream wrapper manager service.
TextExtractorPluginBase::calculateDependencies	public	function
TextExtractorPluginBase::CONFIGNAME		constant	Name of the config being edited.
TextExtractorPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	2
TextExtractorPluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
TextExtractorPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
TextExtractorPluginBase::getmessenger	public	function
TextExtractorPluginBase::getPdfMimeTypes	public	function	Helper method to get the PDF MIME types.
TextExtractorPluginBase::getRealpath	public	function	Helper method to get the real path from an uri.
TextExtractorPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
TextExtractorPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	2

You are here

class PythonPdf2txtExtractor in Search API attachments 9.0.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation