1. sfFilterConfigHandler.class.php
  2. /**
 * sfFilterConfigHandler allows you to register filters with the system.
 *
 * @package    symfony
 * @subpackage config
 * @author     Fabien Potencier 
 * @author     Sean Kerr 
 * @version    SVN: $Id: sfFilterConfigHandler.class.php 23810 2009-11-12 11:07:44Z Kris.Wallsmith $
 */
  3. class sfFilterConfigHandler extends sfYamlConfigHandler
  4. {
  5.   /**
  6.    * Executes this configuration handler
  7.    *
  8.    * @param array $configFiles An array of absolute filesystem path to a configuration file
  9.    *
  10.    * @return string Data to be written to a cache file
  11.    *
  12.    * @throws sfConfigurationException If a requested configuration file does not exist or is not readable
  13.    * @throws sfParseException If a requested configuration file is improperly formatted
  14.    */
  15.   public function execute($configFiles)
  16.   {
  17.     // parse the yaml
  18.     $config = self::getConfiguration($configFiles);
  20.     // init our data and includes arrays
  21.     $data     = array();
  22.     $includes = array();
  24.     $execution = false;
  25.     $rendering = false;
  27.     // let's do our fancy work
  28.     foreach ($config as $category => $keys)
  29.     {
  30.       if (isset($keys['enabled']) && !$keys['enabled'])
  31.       {
  32.         continue;
  33.       }
  35.       if (!isset($keys['class']))
  36.       {
  37.         // missing class key
  38.         throw new sfParseException(sprintf('Configuration file "%s" specifies category "%s" with missing class key.', $configFiles[0], $category));
  39.       }
  41.       $class = $keys['class'];
  43.       if (isset($keys['file']))
  44.       {
  45.         if (!is_readable($keys['file']))
  46.         {
  47.           // filter file doesn't exist
  48.           throw new sfParseException(sprintf('Configuration file "%s" specifies class "%s" with nonexistent or unreadable file "%s".', $configFiles[0], $class, $keys['file']));
  49.         }
  51.         // append our data
  52.         $includes[] = sprintf("require_once('%s');\n", $keys['file']);
  53.       }
  55.       $condition = true;
  56.       if (isset($keys['param']['condition']))
  57.       {
  58.         $condition = $keys['param']['condition'];
  59.         unset($keys['param']['condition']);
  60.       }
  62.       $type = isset($keys['param']['type']) ? $keys['param']['type'] : null;
  63.       unset($keys['param']['type']);
  65.       if ($condition)
  66.       {
  67.         // parse parameters
  68.         $parameters = isset($keys['param']) ? var_export($keys['param'], true) : 'null';
  70.         // append new data
  71.         if ('security' == $type)
  72.         {
  73.           $data[] = $this->addSecurityFilter($category, $class, $parameters);
  74.         }
  75.         else
  76.         {
  77.           $data[] = $this->addFilter($category, $class, $parameters);
  78.         }
  80.         if ('rendering' == $type)
  81.         {
  82.           $rendering = true;
  83.         }
  85.         if ('execution' == $type)
  86.         {
  87.           $execution = true;
  88.         }
  89.       }
  90.     }
  92.     if (!$rendering)
  93.     {
  94.       throw new sfParseException(sprintf('Configuration file "%s" must register a filter of type "rendering".', $configFiles[0]));
  95.     }
  97.     if (!$execution)
  98.     {
  99.       throw new sfParseException(sprintf('Configuration file "%s" must register a filter of type "execution".', $configFiles[0]));
  100.     }
  102.     // compile data
  103.     $retval = sprintf("<?php\n".
  104.                       "// auto-generated by sfFilterConfigHandler\n".
  105.                       "// date: %s\n%s\n%s\n\n", date('Y/m/d H:i:s'),
  106.                       implode("\n", $includes), implode("\n", $data));
  108.     return $retval;
  109.   }
  111.   /**
  112.    * Adds a filter statement to the data.
  113.    *
  114.    * @param string $category   The category name
  115.    * @param string $class      The filter class name
  116.    * @param array  $parameters Filter default parameters
  117.    *
  118.    * @return string The PHP statement
  119.    */
  120.   protected function addFilter($category, $class, $parameters)
  121.   {
  122.     return sprintf("\nlist(\$class, \$parameters) = (array) sfConfig::get('sf_%s_filter', array('%s', %s));\n".
  123.                       "\$filter = new \$class(sfContext::getInstance(), \$parameters);\n".
  124.                       "\$this->register(\$filter);",
  125.                       $category, $class, $parameters);
  126.   }
  128.   /**
  129.    * Adds a security filter statement to the data.
  130.    *
  131.    * @param string $category   The category name
  132.    * @param string $class      The filter class name
  133.    * @param array  $parameters Filter default parameters
  134.    *
  135.    * @return string The PHP statement
  136.    */
  137.   protected function addSecurityFilter($category, $class, $parameters)
  138.   {
  139.     return <<<EOF
  141. // does this action require security?
  142. if (\$actionInstance->isSecure())
  143. {
  144.   {$this->addFilter($category, $class, $parameters)}
  145. }
  146. EOF;
  147.   }
  149.   /**
  150.    * @see sfConfigHandler
  151.    */
  152.   static public function getConfiguration(array $configFiles)
  153.   {
  154.     $config = self::parseYaml($configFiles[0]);
  155.     foreach (array_slice($configFiles, 1) as $i => $configFile)
  156.     {
  157.       // we get the order of the new file and merge with the previous configurations
  158.       $previous = $config;
  160.       $config = array();
  161.       foreach (self::parseYaml($configFile) as $key => $value)
  162.       {
  163.         $value = (array) $value;
  164.         $config[$key] = isset($previous[$key]) ? sfToolkit::arrayDeepMerge($previous[$key], $value) : $value;
  165.       }
  167.       // check that every key in previous array is still present (to avoid problem when upgrading)
  168.       foreach (array_keys($previous) as $key)
  169.       {
  170.         if (!isset($config[$key]))
  171.         {
  172.           throw new sfConfigurationException(sprintf('The filter name "%s" is defined in "%s" but not present in "%s" file. To disable a filter, add a "enabled" key with a false value.', $key, $configFiles[$i], $configFile));
  173.         }
  174.       }
  175.     }
  177.     $config = self::replaceConstants($config);
  179.     foreach ($config as $category => $keys)
  180.     {
  181.       if (isset($keys['file']))
  182.       {
  183.         $config[$category]['file'] = self::replacePath($keys['file']);
  184.       }
  185.     }
  187.     return $config;
  188.   }
  189. }
Debug toolbar