function fillpdf_execute_parse in FillPDF 6

Same name and namespace in other branches

1. 7.2 fillpdf.module \fillpdf_execute_parse()
2. 7 fillpdf.module \fillpdf_execute_parse()

Utility function to allow other functions to parse PDFs with the various methods in a consistent way.

Parameters

string $method The service or program being used. Possible values: local, remote, pdftk. Currently, only pdftk is supported.:

mixed $fillpdf When in URL mode, this is the filename to the PDF to parse. When in Stream mode, this is the PDF data.:

string $mode A special flag to control the behavior of this function. URL mode merges using a PDF on the: file system and Stream mode merges using the value of $fillpdf directly. Possible values: url, stream.

1 call to fillpdf_execute_parse()

fillpdf_parse_pdf in ./fillpdf.module

This function generates the form fields from the specified PDF. It (1) sends a request to the iText servlet to parse the specified PDF, (2) iText returns an XML response with fields-mappings, this module parses the XML response & contsructs the…

File

./fillpdf.module, line 598

Allows mappings of PDFs to site content

Code

function fillpdf_execute_parse($method, $fillpdf, $mode = 'url') {
  switch ($mode) {
    case 'url':
      $filename = $fillpdf;
      break;
    case 'stream':
      $filename = file_save_data($fillpdf, file_directory_temp() . '/pdf_data.pdf', FILE_EXISTS_RENAME);
      break;
  }

  // Use exec() to call pdftk (because it will be easier to go line-by-line parsing the output) and pass $content via stdin. Retrieve the fields with dump_data_fields.
  $output = array();
  $status = NULL;
  exec('pdftk ' . escapeshellarg($filename) . ' dump_data_fields', $output, $status);
  if (in_array($status, array(
    126,
    127,
  ))) {
    drupal_set_message(t('pdftk not properly installed.'), 'error');
    return array();
  }
  elseif (count($output) === 0) {
    drupal_set_message(t('PDF does not contain fillable fields.'), 'warning');
    return array();
  }

  // Build a simple map of dump_data_fields keys to our own array keys
  $data_fields_map = array(
    'FieldType' => 'type',
    'FieldName' => 'name',
    'FieldFlags' => 'flags',
    'FieldJustification' => 'justification',
  );

  // Build the fields array
  $fields = array();
  $fieldindex = -1;
  foreach ($output as $line => $lineitem) {
    if ($lineitem == '---') {
      $fieldindex++;
      continue;
    }

    // Separate the data key from the data value
    $linedata = explode(':', $lineitem);
    if (in_array($linedata[0], array_keys($data_fields_map))) {
      $fields[$fieldindex][$data_fields_map[$linedata[0]]] = trim($linedata[1]);
    }
  }
  if ($mode == 'stream') {
    file_delete($filename);
  }
  return $fields;
}