gravitypdf / gravity-pdf

Gravity PDF is a GPLv2-licensed WordPress plugin that allows you to automatically generate, email and download PDF documents using Gravity Forms.

Gravity PDF

Gravity PDF is a GPLv2-licensed WordPress plugin that allows you to automatically generate, email and download PDF documents using the popular form-builder plugin, Gravity Forms (affiliate link). Find out more about Gravity PDF at https://gravitypdf.com.

About

This Git repository is for developers who want to contribute to Gravity PDF. Don't use it in production. For production use, download Gravity PDF from the WordPress Plugin Directory.

The development branch is considered our bleeding edge branch, with all new changes pushed to it. The master branch is our latest stable version of Gravity PDF.

Installation

Prerequisites

• Git
• Yarn
• Docker Desktop (Windows or Mac) / Docker Toolbox or Composer

Setup for Docker

The Docker setup will create a fully functional development environment preconfigured for Gravity PDF.

1. Clone the repository using git clone https://github.com/GravityPDF/gravity-pdf/ from the terminal
2. Copy and rename .env.example to .env, then replace 00000000000000000000000000000000 with a valid Gravity Forms license key
3. Run yarn && yarn build:production
4. Start Docker and then run yarn env:install to setup the local development environment
5. Access a local development site at http://localhost:8888 with the login admin and password.

If you shut down Docker and want to fire up the environment later, use yarn wp-env start. You can reset the database back to its original state with yarn wp-env clean all. When all else fails, delete everything and start again with yarn wp-env destroy.

See the WordPress Developer Handbook for more details about managing the docker environment.

Enable X-Debug

X-Debug is enabled by default for step debugging and profiling. If you need to use other X-Debug modes you can manually start the environment and pass the appropriate modes in: yarn wp-env start --xdebug=profile,trace,debug.

Switch PHP Versions

The default version that will be configured is PHP8.0. If you want to change this you can adjust the phpVersion value in the .wp-env.json file and then stop and start the environment with yarn wp-env start.

Setup without Docker

If you would rather use your own development environment, you can build Gravity PDF using the following commands.

1. Clone the repository using git clone https://github.com/GravityPDF/gravity-pdf/
2. Run yarn && yarn build:production
3. Run composer install
4. Run composer run prefix

Building JavaScript

If you are making changes to any of the JavaScript or CSS, run yarn build:dev to ensure the files automatically gets built when you make changes on the file system.

Linting

To lint your JS code use yarn lint:js, and to try automatically fix it use yarn lint:js:fix.

To lint your PHP code, use composer lint, and to try automatically fix it use composer lint:fix.

Automated Tests

The automated test suite can only be run using Docker.

E2E

Useful commands include:

yarn test:e2e
yarn test:e2e:headless

PHPUnit

Run full suite of tests using yarn test:php or yarn test:php:multisite.

JavaScript

The JavaScript unit tests can be run with yarn test:js

Documentation

All documentation can be found at https://docs.gravitypdf.com.

gravity-pdf's Issues

Remove filters within filters

Running apply_filters() inside apply_filters() makes the code harder to read. Fix this.

Automatically Set font styles based on PDF Settings

At the moment font styles are manually added to PDF templates like custom PDF settings. To make it easier when custom templating let's automatically set up these before the PDF is loaded.

Automatically Cleanup old 'output' directory

The 'output' directory holds the PDFs from v3. We moved to a 'tmp' directory for 4.0. Let's look at cleaning up the v3 folder.

View / Download Links Fail when "Download" is default option

Custom Fonts not saving permanently

There are reports that custom fonts aren't saving permanently. They just seem to disappear for an unknown reason.

Will need to research the hows and whys of this issue and attempt to replicate it before creating a patch.

Add Loading Spinner when duplicating / deleting PDF settings

We use AJAX to process these particular actions but the user gets no indication anything happens when clicked.

Redefine "Show Hidden Fields" Setting as it's ambiguous

Custom Paper Size Bug

Ensure only positive numbers are permitted in the width and height fields, otherwise throw validation error.

Include Bengali Font Face

Integrate GPLv2 Mukti (Freedom) font from http://www.nongnu.org/freebangfont/downloads.html

Refractor all __constructs() in our MVC to include DOCBLOCKS

Remove "?" from our settings

While it may be a question, these are unnessisary for fields and should be removed.

[Request] Filter for using site name in directory structure

As of version 3.6.0, for a specific site of a multi-site installation, the PDF templates reside in /%uploads%/PDF_EXTENDED_TEMPLATES/%site_name%/.
It would be great to be able to disable this easily, and make the templates live in /%uploads%/PDF_EXTENDED_TEMPLATES/ (just like it was before, inside the theme).

A real-life scenario where this filter is needed:
Suppose you are working together with a number of developers on a project using some sort of version control. Each developer is having an individual local testing environment. Then there is a testing and a productive server. As the site name is part of the directory structure (by default), sooner or later, the project repository will have multiple (redundant) entries, like so:

• /%uploads%/PDF_EXTENDED_TEMPLATES/localhost_project_x/*
• /%uploads%/PDF_EXTENDED_TEMPLATES/project_x_dev/*
• /%uploads%/PDF_EXTENDED_TEMPLATES/project_x_testsystem_com/*
• /%uploads%/PDF_EXTENDED_TEMPLATES/project_x_com/*

In all of these folders, you find the same templates.

If one were able to exclude the site name (meaning that all sites use the exact same templates), there would only be a single folder /%uploads%/PDF_EXTENDED_TEMPLATES/ containing these files.

I will commit a simple fix (as well as the according pull request) containing a filter gfpdf_use_site_name_in_directory_structure to decide if one would like to use the site names or not. By default, I will leave the functionality as it is now. And not using the site names in the directory structure is as simple as this:

add_filter( 'gfpdf_use_site_name_in_directory_structure', '__return_false' );

Conditional Logic - Allow enable or disable logic

Currently conditional logic only has an "Enable" option. Users will want to add conditional logic on a "Disable" basis as well.

Pre-transform Header and Footer settings with `$gfpdf->misc->fix_header_footer()`

Before the core header/footer settings hit the template we should pre-transform them so custom template users don't have to.

PDF not displayed when security enabled

PDF not showing when security enabled. I have enabled security to Yes & chose password from a field value. It does not showing the PDF file.

We've had the above report. Will need to investigate further.

Add "no preview available" image

When a template is selected that doesn't have a preview image fallback to a "no preview available" image instead.

Nginx Security

The .htaccess option only works with Apache-compatible web servers. Look at how one would protect the same directory when running alternate web servers like Nginx.

View & Download PDF always regenerates PDF

The part of pdf-render.php at the bottom of this message isn't working properly, resulting in unnecessary regeneration of already existing PDF files (located in the output folder).

$pdf_creator is always empty, because it never gets defined after it's created on line 44.
Therefore the conditions of the IF-statement never return true, so PDFs are always being regenerated despite the fact that the file might already be present in the output folder.

I forced the IF-statement to return true, but the returned value still doesn't load the existing PDF in the opening browser tab.

Any solution to this would be greatly appreciated.

        /* 
         * Check if the PDF exists and if this function has already run this season 
         */ 
        if(in_array($lead_id, $pdf_creator) && file_exists($gfpdfe_data->template_save_location . $id . '/' . $filename))
        {                   
            /* 
             * Don't generate a new PDF, use the existing one 
             */

            return $gfpdfe_data->template_save_location . $id . '/' . $filename;    
        }

Handle Core Header, Footer and Background independant of PDF template

Removes a step in the user custom template development to including header/footer/backgrounds

Allow Users to change the /tmp/ directory

Add gfpdf_tmp_directory_location filter allowing users to change the tmp directory location

Add @version support to PDF templates

In the future we'll look at notifying users of a version conflict between the core PDF and their copy in PDF_EXTENDED_TEMPLATES. The first step to supporting this is adding version numbers to all new 4.0 PDFs.

Legacy Config should check "conditional logic"

Currently we're only checking if the matched PDF setting is active. To bring this inline with the 4.0 endpoint, the legacy endpoint should also check if there is any conditional logic active.

Add PHP7 Support

PHP 7 had some issues when run through Travis. Load up a Vagrant box with PHP7 and test and fix all PHP7-related problems.

Allow individual PDF configurations to control owner security

At the moment users have global control over whether entry owner's can access the generated PDF documents. But this is an across the board setting and doesn't give control on a per-PDF basis.

I propose adding the ability for users to control if owners can access a PDF on the document level.

Duplicating PDFs don't update shortcode preview ID

The shortcode ID doesn't get updated when duplicating PDF settings.

Adding/editing PDF Configs turns Form inactive

Wierd bug when updating PDFs. Check why forms are becoming inactive when the PDF data is updated.

Default Shortcode in Notification Doesn't Work

If you copy and paste the shortcode markup to a notification ([gravitypdf id="56134195eaf75" text="Download PDF"]) you get the following error:

No Gravity Form entry ID passed to Gravity PDF. Ensure you pass the entry ID via the confirmation url query string – using either "entry" or "lid" as the query string name – or by passing an ID directly to the shortcode. (Admin Only Message)

However, if you pass in the entry parameter it does work.

[gravitypdf id="56134195eaf75" text="Download PDF" entry="{entry_id}"]

This extra step is cumbersome. Look at auto assigning the entry like we do in the confirmation section.

Tweak PDF Download Link Copy on Entry List page

When a PDF is set up the Gravity Forms entry list page for that form will show the text link "View PDF".

The same text shows up when the global setting "Entry View" is set to Download.

It would be good to have the text "View PDF" changed to "Download PDF" when the above is selected.

Ensure Helper_Data uses the $data variable in our Views

Because of a View variable conflict with $data we've currently using the $plugin_data variable for our Helper_Data class. To prevent confusion we need to fix this.

Add External Links

Once the v4 website has been finalised update the software's links.

Change "Default Font Type" global setting to "Default Font"

Consider changing list field htmlspecialchars to strip_tags to cater for a href links

I'm developing a plugin for Gravity Forms that converts URL's entered into the the 'list field' to clickable links in the back end.

I'm doing this by storing the values in the database as an HTML link.

For example, if the user enters

www.google.com

The plugin will store the value in the database as:

<a href="www.google.com">www.google.com</a>

I need to display the link as a clickable link in the PDF created by this plugin. However I found that pdf-entry-detail.php at line 2002 escapes the HTML before it's put in the PDF. So the code pulled into mPDF is turned into:

<a href="www.google.com">www.google.com</a>

I agree that the HTML needs to be escaped to stop users breaking the PDF by entering in table tags like or - but I would like to ask if you could consider changing this to allow links.

The change would be - pdf-entry-detail.php - line 2002

FROM

$list .= '<td>'.htmlspecialchars($val).'</td>';

TO

$list .= '<td>'.strip_tags($val,'<a>').'</td>';

Please let me know if this is a possibility, otherwise I will need to consider my options (other ways of creating PDF's, customising the plugin after each update/providing instructions on how to modify the plugin).

Thanks,

Remove hardcoded styles for lists and the product table

The font size property is hardcoded into lists from Gravity Forms which makes it hard to override using standard styles.

Enable Public Access

Sometimes site owners want to enable public access to a specific PDF configuration for a given form. Currently this feature exists but is hidden - unless a filter is used to manually enable it.

I propose to make the option to enabled public access shown by default in the advanced tab of the PDF configuration. It would need to have appropriate copy to highlight just how open users would be if they enabled this option (anyone globally could potentially access the PDF document).

I feel the benefit out ways the potential risk of mis-configuration.

Convert PDF Template Doctype to HTML5

Replace <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> doctype with <!DOCTYPE html>.

Change our core `background` field to `background_image`

Background by itself is ambiguous. Let's be more descriptive. It also allows us to add a core background_color option without creating confusion.

"Failed Write Permissions Check" in Loggly Logs

Loggly logs are showing the following across a number of sites:

function: create_folder_structures
file: /var/www/html/recruit/wp-content/plugins/gravity-forms-pdf-extended/src/model/Model_Install.php
line: 236
class: GFPDF\Model\Model_Install

dir: /var/www/html/wp-content/uploads/PDF_EXTENDED_TEMPLATES/fonts/

message: Failed Write Permissions Check.
level_name: ERROR

Investigate if this is a problem or not.

AJAX Notice "There was an error processing request" when navigating away from page

During an AJAX request if you navigate away from the page an alert box will pop up saying there is an error. This is disorientating and hopefully can be hidden.

Add Captain Paws to Action Messages

I like the way Ninja Forms includes their logo in their notice prompts. Toy around with the idea of including our new mascot in the actions notice UI.

WP_MEMORY_LIMIT and WP_MAX_MEMORY_LIMIT conflict

PDFs are rendered on the front end so when we display the memory_limit setting in the backend we need to get the front-end memory limit and not the backend limit.

WordPress attempts to set a 256MB memory limit while in the backend which could throw off the actual memory limit when generating PDFs.

Fatal Error When cURL not installed

Gravity PDF 4.0-Beta:

Fatal error: Uncaught exception 'LogicException' with message 'The curl extension is needed to use the LogglyHandler' in /var/www/mysite/wp-content/plugins/gravity-forms-pdf-extended/vendor/monolog/monolog/src/Monolog/Handler/LogglyHandler.php:37 Stack trace: #0 /var/www/mysite/wp-content/plugins/gravity-forms-pdf-extended/src/bootstrap.php(285): Monolog\Handler\LogglyHandler->__construct('8ad317ed-213d-4...', 200) #1 /var/www/mysite/wp-content/plugins/gravity-forms-pdf-extended/src/bootstrap.php(227): GFPDF\Router->maybe_run_remote_logging() #2 /var/www/mysite/wp-content/plugins/gravity-forms-pdf-extended/src/bootstrap.php(129): GFPDF\Router->setup_logger() #3 /var/www/mysite/wp-content/plugins/gravity-forms-pdf-extended/src/depreciated.php(81): GFPDF\Router->init() #4 /var/www/mysite/wp-content/plugins/gravity-forms-pdf-extended/src/bootstrap.php(710): GFPDF_Core->__construct() #5 /var/www/mysite/wp-content/plugins/gravity-forms-pdf-extended/pdf.php(152): require_once('/var/www/recrui...') #6 [internal function]: GFPDF_ in /var/www/mysite/wp-content/plugins/gravity-forms-pdf-extended/vendor/monolog/monolog/src/Monolog/Handler/LogglyHandler.php on line 37

Add ability to more easily remove our security middleware filters

Our middleware is set within our Controller_PDF class and references $this->model which makes it harder for users to remove.

Will likely add an action before the middleware is run so users can remove, add or change the security.

Add ability to generate and save PDF to disk via API (and in Model_PDF)

Make this process simpler and return the path to file or WP_Error.

Also tidy up a lot of the duplicate loops and checks when creating PDFs.

Pass `$gfpdf` directly to PDF Templates

Prevent the need for global $gfpdf and pass in the variable straight to templates.

Add custom CSS classes and field type to outputted fields

Hi,

I'm not all that familiar with using GitHub, but would like to suggest a change that would add the field type and any front end custom CSS classes to the outputted field.

Example can be seen here:

https://github.com/ovann86/gravity-forms-pdf-extended/pull/1

Include PDF Name in Shortcode Sample

It's hard to tell which PDF shortcode is being displayed on a confirmation / notification page. Let's add a faux attribute "name" (which doesn't effect the shortcode in any way) so users can more easily distinguish which PDF the shortcode refers too.

Include $form object in our GPDFAPI Class

Make this accessible without having to access $gfpdf directly

Deleting PDF from List shows blank

When you delete the last PDF from the PDF list it shows an empty table. This should show the "No PDFs here...create one." message instead.

Speed up unit tests

At the moment the unit tests take a long time to run due to all the Gravity Forms database calls. In the future I would like to optimise this dramatically so the tests can be run much faster.

Add core `background_color` option to templates

Once #40 is fixed we can add a background colour option for core use in our templates.