TweetFollow Us on Twitter

Fill Online PDF Forms Using HTML Forms

Volume Number: 20 (2004)
Issue Number: 11
Column Tag: Programming

Fill Online PDF Forms Using HTML Forms

by Sid Steward

Collect data using an HTML form, To deliver a filled-out PDF form that works in Preview

Adobe's Portable Document Format (PDF) is really only as portable as the viewer used to read or print it. This has become an issue in recent years as the Adobe Reader (nee Acrobat Reader) has evolved to support some platforms better than others. Web publishers who desire maximum portability must now take stock: would this work on OS X or Linux as well as Windows? This issue is complicated by the rise of alternative PDF viewers such as Apple's Preview and alternative web browsers such as Konqueror.

Basic PDF viewing and printing is generally okay. Interactive PDF forms, however, are a different story. Adobe Reader on Windows integrates closely with popular web browsers, allowing a web developer to drive an interactive PDF form filling session using the web server (e.g., http://pdfhacks.com/form_session/form_session-1.1/). OS X users, however, won't have the same experience, nor will many Linux users.

One solution is to use HTML form features instead of PDF form features when collecting data. The web server can manage this data collection session, providing data validation and any necessary database access. When the form is complete, the web server can load the PDF form with the user's data, flatten the form, and then serve it to the user. "Flattening" makes the dynamic form data a permanent part of the page, so the resulting PDF will display properly using any PDF viewer.

Collecting data online using HTML forms is old hat. We'll discuss the part where you pack this data into the PDF form for delivery to your user. We'll also talk about how you can automatically convert a PDF form into an HTML form. My free, command-line tool, pdftk, makes both of these possible. We'll need to discuss how to get pdftk working on OS X (it also works on FreeBSD, Linux, Solaris and Windows). We should also touch on PDF forms.

PDF Forms

Using Adobe Acrobat 4, 5, or Acrobat 6.0 Pro (but not 6.0 Standard), you can add interactive form fields to PDF documents. PDF form fields closely resemble the form fields available to HTML form programmers. You have text boxes, check boxes, radio buttons, combo boxes, list boxes, and buttons. These can be further configured to suit your needs. For example, a text box can be configured to be multi-line or to mask password input, and buttons can be configured to submit the form data to a web server.

You can even program PDF forms using JavaScript, although the PDF document object model is quite different than the DOM familiar to web developers. To learn more about programming PDF using JavaScript, see the Acrobat JavaScript Object Specification (http://partners.adobe.com/asn/ developer/pdfs/tn/5186AcroJS.pdf) and the Acrobat JavaScript Scripting Guide (http://partners.adobe. com/asn/acrobat/sdk/public/docs/AcroJSGuide.pdf). We won't discuss using JavaScript with PDF forms, here. Though, I will mention the site http://www.math.uakron.edu/~dpstory/acrotex. html, where you will find JavaScript powered PDF games, such as Tic-Tac-Toe and Naval Battle.

For our purposes, the important thing about PDF forms is that you can permanently merge them with form data. You can do this using Acrobat, or you can use the free, command-line PDF Toolkit, pdftk.

Pdftk, the PDF Toolkit

Pdftk is a command-line program for manipulating PDF documents; it is free software. I created it one year ago to fulfill my own requirements. Since then, I have added features that I believed this free, general-purpose PDF tool should provide. It can:

  • Merge PDF Documents
  • Split PDF Pages into a New Document
  • Decrypt Input as Necessary (Password Required)
  • Encrypt Output as Desired
  • Fill PDF Forms with FDF Data and/or Flatten Forms
  • Apply a Background Watermark
  • Report on PDF Metrics such as Metadata, Bookmarks, and Page Labels
  • Update PDF Metadata
  • Attach Files to PDF Pages or the PDF Document
  • Unpack PDF Attachments
  • Burst a PDF Document into Single Pages
  • Uncompress and Re-Compress Page Streams
  • Repair Corrupted PDF (Where Possible)

The pdftk web site (http://www.pdftk.com) describes these features and explains how to get pdftk working on your system. Pdftk does not require Acrobat or Java. An OS X 10.3 installer is available for pdftk 1.11 from the site. Alternatively, you can build pdftk yourself, a non-trivial task described below. You must have version 1.11 if you want to automatically create an HTML form from a PDF form.

Under pdftk's hood, the iText PDF library does all the heavy lifting. iText is written in Java, but I prefer programming in C++. So I used GCJ, the Java compiler maintained as part of GNU GCC. GCJ allows me to compile iText and then link it with my C++ program. The result is a stand-alone binary that does not need Java. Very cool.

The problem is that your OS X system probably doesn't have GCJ. You must build GCJ (along with GCC) before you can build pdftk on OS X. Happily, John M. Gabriele provides instructions at: http://users.bestweb.net/~john3g/ gcj_osx/gcj_on_osx.html. Brian D. Foy documents his experience building GCJ and pdftk at: http://www.oreillynet.com/pub/wlg/5500.

After building and installing GCC/GCJ, download and unpack the latest version of pdftk (currently 1.11) from http://www.pdftk.com. If you configured GCC/GCJ with --prefix=/usr/local/gcj as John describes, then you won't need to edit the OS X Makefile. Otherwise you will need to edit Makefile.MacOSX so that TOOLPATH matches your location of GCC/GCJ.

After unpacking pdftk 1.11, change into the pdftk-1.11/pdftk directory and run make -f Makefile.MacOSX. It will take awhile to finish compiling. When it is done, move the resulting pdftk program to a convenient location in your $PATH, such as /usr/bin. Test pdftk by displaying its help page:

pdftk --help
and merging a couple PDFs together:
pdftk 1.pdf 2.pdf cat output 12.pdf

Note that you cannot name pdftk's output PDF so it overwrites an input PDF. Also, upon success, pdftk will overwrite files with its output without warning. Change this latter behavior by appending do_ask to the end of the command line, or change the ASK_ABOUT_WARNINGS setting in Makefile.MacOSX and recompile pdftk.

Before we begin using pdftk to fill PDF forms with data, let's talk about FDF.

Store Form Data Using FDF

FDF is Adobe's Forms Data Format, a file format for storing and managing PDF form data. FDF is usually plain text, so you can create it pretty easily using a text editor or your favorite scripting language. FDF is fully documented in section 8.6.6 of the PDF Reference, fourth edition. You can download the latest version of the PDF Reference from: http://partners.adobe.com/asn/tech/ pdf/specifications.jsp. Here is an example of an FDF file that assigns the value "San Francisco" to the PDF field named city:

%FDF-1.2
%aaIO
1 0 obj
<< /FDF << /Fields [	<< /T (city)  /V (San Francisco) >>
                                 << /T (state) /V (California) >> ] >>
>>
endobj
trailer << /Root 1 0 R >>
%%EOF

To simplify FDF creation, I created a PHP program called forge_fdf. It takes form data as name/value pairs and then spins out the matching FDF. The program logic should be easy to reproduce in any language. Visit http://www.pdfhacks.com/forge_fdf/ to download the latest version. In PHP, you would use forge_fdf like so:

<?
require_once( 'forge_fdf.php' );

// use this array for text fields, combo box, and list box form field values
$fdf_data_strings= array( 'city'  => 'San Francisco',
                          'state' => 'California' );

// use this array for check box and radio button values
$fdf_data_names= array();

// these aren't used in this example
$fields_hidden= array();
$fields_readonly= array();

$fdf= forge_fdf(	'',
                        $fdf_data_strings,
                        $fdf_data_names,
                        $fields_hidden,
                        $fields_readonly );

$fdf_fn= tempnam( '.', 'fdf' );
$fp= fopen( $fdf_fn, 'w' );
if( $fp ) {
   fwrite( $fp, $fdf );
   fclose( $fp );

   // serve PDF, but prompt the user to save it to disk
   header( 'Content-type: application/pdf' );
   header(	'Content-disposition: attachment; '.
                'filename=filled_form.pdf' );

   // our pdftk magic; "flatten" merges data with the page
   passthru(   'pdftk form.pdf fill_form '. $fdf_fn.
                                         ' output - flatten' );
	
   unlink( $fdf_fn ); // delete temp file
}
else { // error
   echo 'Error: unable to write temp fdf file: '. $fdf_fn;
}
?>

One FDF peculiarity is that text field, combo box and list box form field values are represented as PDF "strings," where check box and radio button values are represented as PDF "names." For our purposes, names and strings are the same; they are just encoded a little differently in the FDF. That is why forge_fdf takes two arrays of data: fdf_data_strings and fdf_data_names; pack them appropriately. By default, check boxes and radio buttons use the values "Yes" and "Off" to represent their true and false states, respectively. The form designer can choose an alternative to "Yes," but "Off" always means false.

The arrays fields_hidden and fields_readonly have no role in this discussion, so you can ignore them.

Now things are beginning to come together. We have a PDF form, we have an FDF data file, and we can also see, above, that pdftk can merge these two files into a single, non-interactive PDF. Let's talk about that.

PDF Form Filling and Flattening with Pdftk

The pdftk command for filling a PDF form looks like this:

pdftk <input PDF form> fill_form <input FDF data> output <output PDF file> [flatten]

The PDF input, the FDF input, and the PDF output can be a filename, a hyphen (-), or "PROMPT." Passing a hyphen into pdftk instead of an input filename causes pdftk to look for data on stdin. Similarly, passing a hyphen into pdftk instead of an output filename causes pdftk to return data on stdout. You can see we used this latter technique in the snippet, above. Finally, you can pass "PROMPT" into pdftk if you would like pdftk to ask you for the necessary filename at run time.

If you include the flatten output option, then all form field data is converted into static page elements. All of the interactive form features are removed, so the result is a plain old PDF that any viewer can handle. If you omit the flatten option, then form fields are filled to match your input data, but they also remain interactive. You can flatten a PDF form at any time by running:

pdftk filled_form.pdf output flattened_form.pdf flatten

So, these are the back-end pieces to our workaround for online PDF forms. We can take form data, cast it into FDF, merge it with the PDF form, and then serve it to the user. Now let's look into creating the front-end HTML form. To help us along the way, we'll use pdftk to discover PDF form field information.

PDF Form Field Discovery with Pdftk

A PDF form can have dozens of interactive fields. Manually mirroring these fields in HTML would be cumbersome and error-prone. Instead, let's use one of pdftk's reporting features. You can learn everything you need to know about your PDF's interactive form fields by running:

pdftk form.pdf dump_data_fields > form.pdf.fields

This will create an easily parsible plain text report on your form's fields. The output might look like this:

---
FieldType: Text
FieldName: name_last
FieldNameAlt: Last Name
FieldFlags: 8392706
FieldValue:				
FieldJustification: Left
FieldMaxLength: 200
---
FieldType: Button
FieldName: previous1
FieldFlags: 0
FieldJustification: Left
FieldStateOption: Off
FieldStateOption: Yes
---
FieldType: Choice
FieldName: select_one
FieldFlags: 4587520
FieldValue: a
FieldValueDefault: c
FieldStateOption: a
FieldStateOption: b
FieldStateOption: c
---

You can see that the field named title has a maximum length of 200 characters, that a button named previous1 has two possible states: Off and Yes, and a combo box named select_one has three possible states: a, b, and c. Note that push buttons, check boxes and radio buttons all have a FieldType of Button. To tell them apart, you must consult the FieldFlags. Similarly, list boxes and combo boxes both have a FieldType of Choice. See section 8.6 of the PDF Reference for details on field flags and their meanings. We won't be bothering with them, here.

This plain text report should provide you with all the information you need to create an HTML interface to your form. For fun, let's use PHP to do this automatically. Here's a script that reads this text report and generates an HTML form to suit. If you added a "Short Description" to each field in Acrobat, then that text will appear as the FieldNameAlt entry in our report. Our script will use this information, if present, to label the HTML field.

<?php

// this function loads a data file created using pdftk dump_data_fields
function
load_field_data( $field_report_fn )
{
   $ret_val= array();

   $fp= fopen( $field_report_fn, "r" );
   if( $fp ) {
      $line= '';
      $rec= array();
      while( ($line= fgets($fp, 2048))!== FALSE ) {
         $line= rtrim( $line ); // remove trailing whitespace
         if( $line== '---' ) {
            if( 0< count($rec) ) { // end of record
               $ret_val[]= $rec;
               $rec= array();
            }
            continue; // skip to next line
         }

         // split line into name and value
         $data_pos= strpos( $line, ':' );
         $name= substr( $line, 0, $data_pos+ 1 );
         $value= substr( $line, $data_pos+ 2 );

         if( $name== 'FieldStateOption:' ) {
            // pack state options into their own sub-array
            if( !array_key_exists('FieldStateOption:',$rec) ) {
               $rec['FieldStateOption:']= array();
            }
            $rec['FieldStateOption:'][]= $value;
         }
         else {
            $rec[ $name ]= $value;
         }
         }
      if( 0< count($rec)) { // pack final record
         $ret_val[]= $rec;
      }

      fclose( $fp );
   }

   return $ret_val;
}
// open our web page; the form action is a script we provide, below
echo '<html>
<head>
</head>
<body>
<form method="POST" action="pdf_form_fill.php">
<table>';
// create the file form.pdf.fields using pdftk's dump_data_fields
$field_arr= load_field_data( 'form.pdf.fields' );
foreach( $field_arr as $field ) { // iterate form fields
   echo '<tr><td>'; // one row per field
   if(array_key_exists('FieldNameAlt:', $field)) {
      // use human readable name, if available; you can add these in Acrobat
      echo $field['FieldNameAlt:'];
   }
   else {
      echo $field['FieldName:'];
   }
   echo '</td><td>';

   if( $field['FieldType:']== 'Text' ) {
      // construct an HTML text form field to match our PDF text form field;
      // cannot use periods in field names with PHP, so translate them to tildes
      echo   '<input type="text" name="'.
            strtr($field['FieldName:'],'.','~'). '" ';
      // text field default value
      if(array_key_exists('FieldValueDefault:', $field)) {
         echo 'value="'. $field['FieldValueDefault:']. '" ';
      }
      // text field size and maxlength
      if(array_key_exists('FieldMaxLength:', $field)) {
         echo 'maxlength="'. $field['FieldMaxLength:']. '" ';
         if( $field['FieldMaxLength:']< 80 ) {
            echo 'size="'. $field['FieldMaxLength:']. '" ';
         }
         else {
            echo 'size="80" ';
         }
      }
      echo '>';
   }
   else if(array_key_exists('FieldStateOption:', $field)) {
      // use an HTML selection field for all other PDF form fields
      // (check boxes, radio buttons, list boxes, combo boxes);
      // cannot use periods in field names with PHP, so translate them to tildes
      echo   '<select name="'.
            strtr($field['FieldName:'], '.', '~'). '">';
      foreach( $field['FieldStateOption:'] as $option ) {
         echo '<option>'.$option.'</option>';
      }
      echo '</select>';
   }
   echo "</td></tr>\n";
}
// close our table and our HTML page; don't forget the submit button
echo '</table>
<input type="submit" value="Create PDF">
</form>
</body>
</html>';
?>

Now, we need a companion script that takes this submitted data, packs it into the PDF form and serves it to the user. This script is the pdf_form_fill.php action in our above HTML form. It looks much like our earlier form filling example:

<?php
require_once( 'forge_fdf.php' );

$fdf_data_strings= array();
$fdf_data_names= array();

// funny thing; for our purpose, we can get away with packing everything
// everything into fdf_data_strings; that's handy
foreach( $_POST as $key => $value ) {
   // translate tildes back to periods
   $fdf_data_strings[ strtr($key, '~', '.') ]= $value;
}
// ignore these in this example
$fields_hidden= array();
$fields_readonly= array();

$fdf= forge_fdf( '',
                        $fdf_data_strings,
                        $fdf_data_names,
                        $fields_hidden,
                        $fields_readonly );

$fdf_fn= tempnam( '.', 'fdf' );
$fp= fopen( $fdf_fn, 'w' );
if( $fp ) {
   fwrite( $fp, $fdf );
   fclose( $fp );

   header(   'Content-type: application/pdf' );
   header(   'Content-disposition: attachment; '.
             'filename=filled_form.pdf' );

   passthru(   'pdftk form.pdf fill_form '. $fdf_fn.
               ' output - flatten' );
   unlink( $fdf_fn ); // delete temp file
}
else { // error
   echo 'Error: unable to write temp fdf file: '. $fdf_fn;
}
?>

When filling forms this way, it turns out you can pass everything into forge_fdf using the fdf_data_strings array; there's no need to use fdf_data_names. That's handy.

Now the Fun Begins

We have done it! We have created an HTML front-end to filling PDF forms. This is where the fun begins. You can now take everything you know about web programming, such as data validation and database access, and use it to fill PDF forms. Your users will be glad, too, because your resulting PDFs will work in alternative viewers such as Preview, and because you give them a filled-out PDF form for their records (which Adobe Reader does not provide).

To see an online example of these scripts, visit http://www.accesspdf.com/html_pdf_form/. You will also find the code, quoted in this article, available for download.


Sid Steward is a longtime PDF service provider and software developer. He developed the free PDF Toolkit (http://www.AccessPDF.com/pdftk/) and wrote the book PDF Hacks (O'Reilly Media). You can reach him at sid@accesspdf.com.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

How to be a star in Britney Spears: Amer...
If you've ever wanted to be a star, baby, then you've probably already checked out Britney Spears: American Dream and are happily making your way up the charts. But fame doesn't come easy, and everyone needs a helping hand sometimes. So we've got... | Read more »
AppSpy is hiring a part time Staff Write...
| Read more »
How to save lives in ER Surgery Simulato...
A serious earthquake has struck a nearby town in ER Surgery Simulator - Emergency Doctor, and it’s up to you to save the victims. [Read more] | Read more »
Tips and tricks to get a high score in G...
Ketchapp Games loves the endless runner genre. And its newest game, Gravity Switch, is no exception. Gravity Switch takes a fresh approach, though, as you move a block, suspended in zero gravity, safely through a maze of shifting pillars. If the... | Read more »
Tips and tricks to get a high score in S...
Smash Fu is a high-paced tile-tapping game that requires quick reflexes and some practice. You’ll have to smash bricks with the skill of a seasoned black belt to get a high score. To raise the stakes a bit, you’ll also have to avoid tapping any... | Read more »
How to keep the ball rolling in Dropple
If you're new to the minimalist puzzler Dropple, you may find yourself struggling to make it beyond the first couple of steps before your ball falls into the endless abyss below. [Read more] | Read more »
How not to die in Traffic Rider
Traffic Rider, an Out Run-esque game in which your ride a motorcycle recklessly into trffic, might not seem particularly complicated. [Read more] | Read more »
How to adjust your chess game for Regici...
At first glance you might likenWarhammer 40,000: Regicide to Chess - and you'd be right. Regicideputs its own spin on the classic board game though, so some of your tried and true methods may not work quite so well here. [Read more] | Read more »
Rush Rally 2 (Games)
Rush Rally 2 1.0 Device: iOS Universal Category: Games Price: $3.99, Version: 1.0 (iTunes) Description: -- Rush Rally 2 is the most authentic and thrilling rally simulation on your mobile, all running at an astounding 60fps. Console... | Read more »
Warhammer 40000: Regicide (Games)
Warhammer 40000: Regicide 1.0 Device: iOS Universal Category: Games Price: $3.99, Version: 1.0 (iTunes) Description: ++NOTE: Optimized for with iPad Air, iPad mini 2, iPhone 5 and up. ++ "“This game has no right to be as good as it... | Read more »

Price Scanner via MacPrices.net

Textkraft Professional Becomes A Mobile Produ...
The new update 4.1 of Textkraft Professional for the iPad comes with many new and updated features that will be particularly of interest to self-publishers of e-books. Highlights include import and... Read more
SnipNotes 2.0 – Intelligent note-taking for i...
Indie software developer Felix Lisczyk has announced the release and immediate availability of SnipNotes 2.0, the next major version of his productivity app for iOS devices and Apple Watch.... Read more
Pitch Clock – The Entrepreneur’s Wingman Laun...
Grand Rapids, Michigan based Skunk Tank has announced the release and immediate availability of Pitch Clock – The Entrepreneur’s Wingman 1.1, the company’s new business app available exclusively on... Read more
13-inch 2.9GHz Retina MacBook Pro on sale for...
B&H Photo has the 13″ 2.9GHz Retina MacBook Pro (model #MF841LL/A) on sale for $1599 including free shipping plus NY tax only. Their price is $200 off MSRP. Amazon also has the 13″ 3.9GHz Retina... Read more
Apple price trackers, updated continuously
Scan our Apple Price Trackers for the latest information on sales, bundles, and availability on systems from Apple’s authorized internet/catalog resellers. We update the trackers continuously: - 15″... Read more
Clearance 12-inch Retina MacBooks available s...
B&H Photo has dropped prices on leftover 2015 12″ Retina MacBooks with models now available starting at $999. Shipping is free, and B&H charges NY tax only: - 12″ 1.1GHz Gray Retina MacBook... Read more
Check Apple prices on any device with the iTr...
MacPrices is proud to offer readers a free iOS app (iPhones, iPads, & iPod touch) and Android app (Google Play and Amazon App Store) called iTracx, which allows you to glance at today’s lowest... Read more
New 2016 13-inch 256GB MacBook Air on sale fo...
B&H Photo has the new 13″ 1.6GHz/256GB MacBook Air (model MMGG2LL/A) on sale for $1149 including free shipping plus NY sales tax only. Their price is $50 off MSRP. Amazon has the 13″ 1.6GHz/256GB... Read more
Apple refurbished iPad Air 2s available start...
Apple has Certified Refurbished iPad Air 2 available starting at $339. Apple’s one-year warranty is included with each model, and shipping is free: - 128GB Wi-Fi iPad Air 2: $499 - 64GB Wi-Fi iPad... Read more
Accenture and Vatican Opera Romana Pellegrina...
Accenture has announced that the official mobile application for the Extraordinary Jubilee Year of Mercy declared by Pope Francis has been built and launched by Accenture Mobility, part of Accenture... Read more

Jobs Board

ISCS *Apple* ID Site Support Engineer - APP...
…position, we are looking for an individual who has experience supporting customers with Apple ID issues and enjoys this area of support. This person should be Read more
Automotive Sales Consultant - Apple Ford Linc...
…you. The best candidates are smart, technologically savvy and are customer focused. Apple Ford Lincoln Apple Valley is different, because: $30,000 annual salary Read more
*Apple* Support Technician II - Worldventure...
…global, fast growing member based travel company, is currently sourcing for an Apple Support Technician II to be based in our Plano headquarters. WorldVentures is Read more
Restaurant Manager (Neighborhood Captain) - A...
…in every aspect of daily operation. WHY YOU'LL LIKE IT: You'll be the Big Apple . You'll solve problems. You'll get to show your ability to handle the stress and Read more
Editor, *Apple* News - APPLE (United States...
Job Summary The Apple News team is looking for a passionate...a news organization. Description * Program Top Stories in Apple News * Post on Apple News Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.