pdf-configuration-indexer.php

<?php

/**
 * Class: FPPDFGenerator
 * Plugin: Formidable Pro PDF Extended
 * Usage: assign options from user configuration file, automatically attach PDFs to specified Formidable Pro, and view PDF from admin area.
 */
 
 class FPPDFGenerator
 {
	
	/*
	 * Set default values for forms not assigned a PDF 
	 */
	public static $default = array(
		'template' 		=> 'default-template.php',
		'pdf_size' 		=> 'a4',
		'orientation' 	=> 'portrait',
		'rtf'			=> false,
		'security' 		=> false
	);
	
	public static $allowed_privileges = array('copy', 'print', 'modify', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-highres');
	
	public $configuration = array();
	
	/*
	 * Switch to verify if configuration file exists.
	 * If not, user is using old functions.php method and we 
	 * don't want to interfere with it.
	 */ 
	public $disabled = false;	
	
	/*
	 * The index holds the form_id and configuration key in $this->configuration 
	 * so each form knows 
	 */
	public $index = array();
	
	public function __construct()
	{
		 
		 /* 
		  * Do configuration pre-processing
		  */
		  
		  /*
		   * Check if user configuration file exists
		   * If not disable $configuration and $index.
		   */ 		   
		  if(!file_exists(FP_PDF_TEMPLATE_LOCATION.'configuration.php'))
		  {
			  $this->disabled = true;
			  return;
		  }
		  else
		  {
				/*
				 * Include the configuration file and set up the configuration variable.
				 */  
				 require(FP_PDF_TEMPLATE_LOCATION.'configuration.php');				
				 /*
				  * $fp_pdf_config included from configuration.php file
				  */				 
				 $this->configuration = (isset($fp_pdf_config)) ? $fp_pdf_config : array();

				 /*
				  * Merge down the default configuration options
				  */
				 foreach($this->configuration as &$node)
				 {
				 	$node = $this->merge_defaults($node);
				 }					 
		  }
		  
		  $this->pdf_config();
	}

	/**
	 * Merge the configuration node with the default options, ensuring the config node takes precendent
	 * @param  array $config the configuration node from $gfpdf->configuration()
	 * @return array         Merged default/node configuration options 
	 */
	private function merge_defaults($config)
	{
		global $fp_pdf_default_configuration;

		/*
		 * If the default settings are set we'll merge them into the configuration index
		 */
		if(is_array($fp_pdf_default_configuration) && sizeof($fp_pdf_default_configuration) > 0 && FPPDF_SET_DEFAULT_TEMPLATE === true)
		{
			$config = array_replace_recursive($fp_pdf_default_configuration, $config);
		}

		return $config;		
	}	
	
	/*
	 * Run through user configuration and set PDF options
	 */		
	private function pdf_config()
	{
		if(sizeof($this->configuration) == 0)
		{
			return;
		}
		
		$this->set_form_pdfs();		
	}
	
	
	/*
	 * Set the configuration index so it's faster to access template configuration information
	 */			
	private function set_form_pdfs() {
		foreach ( $this->configuration as $key => $config ) {
			foreach ( (array) $config['form_id'] as $id ) {
				$this->assign_index( $id, $key );
			}
		}
	}	
	
	/*
	 * Check to see if ID is valid
	 * If so, assign ID => key to index 
	 */	
	public function assign_index($id, $key)
	{
		$id = (int) $id;
		if($id !== 0)
		{
			/*
			 * Assign the outter array with the form ID and the value as the configuration key
			 */
			$this->index[$id][] = $key;
		}
	}
	
	/*
	 * Searches the index for the configuration key
	 * Return: form PDF configuration
	 */ 
	public function get_config($id)
	{	
		return (isset($this->index[$id])) ? $this->index[$id] : false;
	}
	
	/*
	 * Searches the index for the configuration key and once found return the real configuration
	 * Return: form PDF configuration
	 */ 
	public function get_config_data($form_id, $return_all = false)
	{
		if(!isset($this->index[$form_id]))
		{
			return false;	
		}

		$index = $this->index[$form_id];
		/* 
		 * Because we now allow multiple PDF templates per form we need a way to get the correct PDF settings
		 * To do this we use the $_GET variable 'aid'
		 * If 'aid' is not found we will pull the first entry
		 * Note: 'aid' has been incremented by 1 so 'aid' === 0 is never found
		 */
		 if(isset($_GET['aid']) && (int) $_GET['aid'] > 0)
		 {
			$aid = (int) $_GET['aid'] - 1;
			return $this->configuration[$index[$aid]]; 
		 }
		 
		 /*
		  * No valid configuration file found so pull the default
		  */
		 return $this->configuration[$index[0]];
	}	

	/**
	 * Get the configuration information based on the form ID
	 * If multiple nodes assigned to form look for $_GET['aid']
	 * @param  integer $form_id ID of the form
	 * @return array          configuration node
	 */
	private function pull_config_data($form_id)
	{
		if(!isset($this->index[$form_id]))
		{
			return false;	
		}

		$index = $this->index[$form_id];
		/* 
		 * Because we now allow multiple PDF templates per form we need a way to get the correct PDF settings
		 * To do this we use the $_GET variable 'aid'
		 * If 'aid' is not found we will pull the first entry
		 * Note: 'aid' has been incremented by 1 so 'aid' === 0 is never found
		 */
		 if(isset($_GET['aid']) && (int) $_GET['aid'] > 0)
		 {
			$aid = (int) $_GET['aid'] - 1;
			return $this->configuration[$index[$aid]]; 
		 }
		 
		 /*
		  * No valid configuration file found so pull the default
		  */
		 return $this->configuration[$index[0]];		
	}

	
	/*
	 * Search for the template from a given form id
	 * Return: the first template found for the form
	 * TODO: return all PDFs
	 */ 
	public function get_template($form_id, $return_all = false)
	{
		global $fp_pdf_default_configuration;

		$template = '';
		
		/* Set the default template based on if the default is set */
		$default_template = self::$default['template'];

		if(is_array($fp_pdf_default_configuration) && sizeof($fp_pdf_default_configuration) > 0 && isset($fp_pdf_default_configuration['template']) )
		{
			$default_template = $fp_pdf_default_configuration['template'];
		}		

		if(isset($this->index[$form_id]))
		{

			/* 
			 * Show all PDF nodes
			 */	
			 if($return_all === true && sizeof($this->index[$form_id]) > 1)
			 {

				$templates = array();
				foreach($this->index[$form_id] as $id)
				{					
					$templates[$id] =	array(
											'template' => (isset($this->configuration[$id]['template'])) ? $this->configuration[$id]['template'] : $default_template,
											'filename' => (isset($this->configuration[$id]['filename'])) ? $this->configuration[$id]['filename'] : FPPDF_Common::get_pdf_filename($form_id, '{entry_id}')
										);
				}
				return $templates;
			 }			
			
			/*
			 * Check if PDF template is avaliable
			 */ 
			 if(isset($this->configuration[$this->index[$form_id][0]]['template']))
			 {
					$user_template = (isset($_GET['template'])) ? $_GET['template'] : '';
					$match = false;

					foreach($this->index[$form_id] as $index)
					{
						if($this->configuration[$index]['template'] === $user_template)
						{
							$match = true;			
						}
					}
					
					$template = ($match === true) ? $user_template : $this->configuration[$this->index[$form_id][0]]['template'];
			 }
			
			 if(strlen($template) == 0)
			 {
				$template = $default_template;
			 }
			 return $template;
		}
		
		if( (strlen($template) == 0) && (FPPDF_SET_DEFAULT_TEMPLATE === true))
		{			

			/*
			 * Check if a default configuration is defined
			 */			
			return $default_template;
		}			
		else
		{
			return false;	
		}

	}	
	
	public function get_pdf_name($index, $form_id = false, $lead_id = false)
	{
		if(isset($this->configuration[$index]['filename']))
		{
			return FPPDF_Common::validate_pdf_name($this->configuration[$index]['filename'], $form_id, $lead_id);		
		}
		else
		{
			return FPPDF_Common::validate_pdf_name(FPPDF_Common::get_pdf_filename($form_id, $lead_id), $form_id, $lead_id);		
		}		
	}
	
	public function validate_privileges($privs)
	{ 
		if(!is_array($privs))
		{
			return array();
		}

		$new_privs = array_filter($privs, array($this, 'array_filter_privilages'));
		
		return $new_privs;
	}
	
	private function array_filter_privilages($i)
	{
		if(in_array($i, FPPDFGenerator::$allowed_privileges))
		{
			return true;
		}
		return false;		
	}
	 
 }