Changeset 2661

Timestamp:

11/13/06 11:43:43 (2 years ago)

Author:

fabien

Message:

moved symfony core filters to filters.yml to allow greater flexibility in filter registration and ordering

Files:

• trunk/data/config/factories.yml (modified) (1 diff)
• trunk/data/config/filters.yml (added)
• trunk/data/skeleton/app/app/config/filters.yml (modified) (1 diff)
• trunk/data/tasks/sfPakeUpgrade.php (modified) (4 diffs)
• trunk/lib/config/sfFactoryConfigHandler.class.php (modified) (2 diffs)
• trunk/lib/config/sfFilterConfigHandler.class.php (modified) (5 diffs)
• trunk/lib/controller/sfController.class.php (modified) (1 diff)
• trunk/lib/util/sfBrowser.class.php (modified) (1 diff)
• trunk/test/functional/fixtures/project/apps/backend/config/filters.yml (modified) (1 diff)
• trunk/test/functional/fixtures/project/apps/cache/config/filters.yml (modified) (1 diff)
• trunk/test/functional/fixtures/project/apps/crud/config/filters.yml (modified) (1 diff)
• trunk/test/functional/fixtures/project/apps/frontend/config/filters.yml (modified) (1 diff)
• trunk/test/functional/fixtures/project/apps/frontend/modules/configFiltersSimpleFilter/config/filters.yml (modified) (1 diff)
• trunk/test/unit/config/fixtures/sfFilterConfigHandler/condition.yml (added)
• trunk/test/unit/config/fixtures/sfFilterConfigHandler/default_filters.yml (modified) (1 diff)
• trunk/test/unit/config/fixtures/sfFilterConfigHandler/disable.yml (added)
• trunk/test/unit/config/fixtures/sfFilterConfigHandler/filters.yml (modified) (1 diff)
• trunk/test/unit/config/fixtures/sfFilterConfigHandler/no_execution.yml (added)
• trunk/test/unit/config/fixtures/sfFilterConfigHandler/no_rendering.yml (added)
• trunk/test/unit/config/fixtures/sfFilterConfigHandler/not_disabled.yml (added)
• trunk/test/unit/config/fixtures/sfFilterConfigHandler/result.php (modified) (1 diff)
• trunk/test/unit/config/sfFilterConfigHandlerTest.php (modified) (4 diffs)

trunk/data/config/factories.yml

@@ -17 +17 @@
-      session_name: symfony
-
-  execution_filter:
-    class: sfExecutionFilter
-
-  rendering_filter:
-    class: sfRenderingFilter
-
-  security_filter:
-    class: sfBasicSecurityFilter
-
-  view_cache:
-    class: sfFileCache

trunk/data/skeleton/app/app/config/filters.yml

@@ +1 @@
+rendering: ~
+web_debug: ~
+security:  ~
+
+# generally, you will want to insert your own filters here
+
+cache:     ~
+common:    ~
+flash:     ~
+execution: ~

trunk/data/tasks/sfPakeUpgrade.php

@@ -77 +77 @@
-  {
-    $app = str_replace(DIRECTORY_SEPARATOR.sfConfig::get('sf_app_module_dir_name'), '', $app_module_dir);
-sprintf('[upgrading application "%s"]', $app
+pakeColor::colorize(sprintf('upgrading application "%s"', $app), array('fg' => 'cyan')
-
-    $app_dir = sfConfig::get('sf_apps_dir_name').'/'.$app;
@@ -83 +83 @@
-    // upgrade config.php
-    _upgrade_0_8_config_php($app_dir);
+
+    // upgrade filters.yml
+    _upgrade_0_8_filters_yml($app_dir);
-
-    // upgrade all modules
@@ -118 +121 @@
-  }
-
-you can now
-model
-
+Now, you must
+your model classes
+the 
-}
-
@@ -369 +372 @@
-}
-
+function _upgrade_0_8_filters_yml($app_dir)
+{
+  pake_echo_action('upgrade 0.8', 'upgrading filters.yml');
+
+  $configFile = $app_dir.DIRECTORY_SEPARATOR.sfConfig::get('sf_config_dir_name').DIRECTORY_SEPARATOR.'filters.yml';
+  $content = file_get_contents($configFile);
+
+  // default symfony filters
+  $default = file_get_contents(sfConfig::get('sf_symfony_data_dir').'/skeleton/app/app/config/filters.yml');
+
+  $placeholder = '# generally, you will want to insert your own filters here';
+
+  // upgrade module filters.yml
+  $seen = false;
+  $yml_files = pakeFinder::type('file')->name('filters.yml')->in($app_dir.DIRECTORY_SEPARATOR.'modules');
+  foreach ($yml_files as $yml_file)
+  {
+    $module_content = file_get_contents($yml_file);
+
+    if (false === strpos($module_content, 'rendering:'))
+    {
+      $module_content = str_replace($placeholder, $placeholder."\n".$content."\n".$module_content, $default);
+
+      file_put_contents($yml_file, $module_content);
+
+      if (!$seen)
+      {
+        pake_echo_comment('filters.yml now contains core symfony filters');
+      }
+
+      $seen = true;
+    }
+  }
+
+  // upgrade app filters.yml
+  if (false === strpos($content, 'rendering:'))
+  {
+    $content = str_replace($placeholder, $placeholder."\n".$content, $default);
+
+    file_put_contents($configFile, $content);
+
+    if (!$seen)
+    {
+      pake_echo_comment('filters.yml now contains core symfony filters');
+    }
+  }
+}
+
-function _upgrade_0_8_main_config_php()
-{

trunk/lib/config/sfFactoryConfigHandler.class.php

@@ -49 +49 @@
-
-    // available list of factories
-security_filter', 'execution_filter', 'rendering_filter', '
+
-
-    // let's do our fancy work
@@ -128 +128 @@
-          $inits[] = sprintf("  \$this->user->initialize(\$this, %s);", $parameters);
-          break;
-
-        case 'security_filter':
-          // append creation/initialization in one swipe
-          $inits[] = sprintf("\n  if (sfConfig::get('sf_use_security'))\n  {\n".
-                             "    sfConfig::set('sf_factory_security_filter', array('%s', %s));\n  }\n",
-                             $class, $parameters);
-          break;
-
-        case 'execution_filter':
-          // append execution filter class name
-          $inits[] = sprintf("  sfConfig::set('sf_factory_execution_filter', array('%s', %s));", $class, $parameters);
-          break;
-
-        case 'rendering_filter':
-          // append rendering filter class name
-          $inits[] = sprintf("  sfConfig::set('sf_factory_rendering_filter', array('%s', %s));", $class, $parameters);
-          break;
-
-        case 'view_cache':
-          // append view cache class name

trunk/lib/config/sfFilterConfigHandler.class.php

@@ -34 +34 @@
-  {
-    // parse the yaml
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    // init our data and includes arrays
@@ -40 +61 @@
-    $includes = array();
-
+    $execution = false;
+    $rendering = false;
+
-    // let's do our fancy work
-    foreach ($config as $category => $keys)
-    {
+      if (isset($keys['enabled']) && !$keys['enabled'])
+      {
+        continue;
+      }
+
-      if (!isset($keys['class']))
-      {
@@ -64 +93 @@
-          // filter file doesn't exist
-          $error = sprintf('Configuration file "%s" specifies class "%s" with nonexistent or unreadable file "%s"', $configFiles[0], $class, $file);
+
-          throw new sfParseException($error);
-        }
@@ -71 +101 @@
-      }
-
+      $condition = true;
+      if (isset($keys['param']['condition']))
+      {
+        $condition = $this->replaceConstants($keys['param']['condition']);
+        unset($keys['param']['condition']);
+      }
+
+      $type = isset($keys['param']['type']) ? $keys['param']['type'] : null;
+      unset($keys['param']['type']);
+
-      // parse parameters
-(isset($keys['param']) ? var_export($keys['param'], true) : 'null')
+isset($keys['param']) ? var_export($keys['param'], true) : 'null'
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    }
-
@@ -89 +160 @@
-    return $retval;
-  }
+
+  protected function addFilter($category, $class, $parameters)
+  {
+    return sprintf("\nlist(\$class, \$parameters) = (array) sfConfig::get('sf_%s_filter', array('%s', %s));\n".
+                      "\$filter = new \$class();\n".
+                      "\$filter->initialize(\$this->context, \$parameters);\n".
+                      "\$filterChain->register(\$filter);",
+                      $category, $class, $parameters);
+  }
+
+  protected function addSecurityFilter($category, $class, $parameters)
+  {
+    return <<<EOF
+
+// does this action require security?
+if (\$actionInstance->isSecure())
+{
+  if (!in_array('sfSecurityUser', class_implements(\$this->context->getUser())))
+  {
+    \$error = 'Security is enabled, but your sfUser implementation does not implement sfSecurityUser interface';
+    throw new sfSecurityException(\$error);
+  }
+  {$this->addFilter($category, $class, $parameters)}
-}
+EOF;
+  }
+}

trunk/lib/controller/sfController.class.php

@@ -529 +529 @@
-  public function loadFilters($filterChain, $actionInstance)
-  {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-  }
-}

trunk/lib/util/sfBrowser.class.php

@@ -127 +127 @@
-
-    // we register a fake rendering filter
-factory_
+
-
-    // dispatch our request

trunk/test/functional/fixtures/project/apps/backend/config/filters.yml

@@ +1 @@
+rendering: ~
+web_debug: ~
+security:  ~
+
+# generally, you will want to insert your own filters here
+
+
+cache:     ~
+common:    ~
+flash:     ~
+execution: ~

trunk/test/functional/fixtures/project/apps/cache/config/filters.yml

@@ +1 @@
+rendering: ~
+web_debug: ~
+security:  ~
+
+# generally, you will want to insert your own filters here
+
+
+cache:     ~
+common:    ~
+flash:     ~
+execution: ~

trunk/test/functional/fixtures/project/apps/crud/config/filters.yml

@@ +1 @@
+rendering: ~
+web_debug: ~
+security:  ~
+
+# generally, you will want to insert your own filters here
+
+
+cache:     ~
+common:    ~
+flash:     ~
+execution: ~

trunk/test/functional/fixtures/project/apps/frontend/config/filters.yml

@@ +1 @@
+rendering: ~
+web_debug: ~
+security:  ~
+
+# generally, you will want to insert your own filters here
-myFilter:
-  class: myFilter
+
+
+cache:     ~
+common:    ~
+flash:     ~
+execution: ~

trunk/test/functional/fixtures/project/apps/frontend/modules/configFiltersSimpleFilter/config/filters.yml

@@ +1 @@
+rendering: ~
+web_debug: ~
+security:  ~
+
+# generally, you will want to insert your own filters here
+myFilter:
+  class: myFilter
+
-simpleFilter:
-  class: configFiltersSimpleFilterFilter
+
+
+cache:     ~
+common:    ~
+flash:     ~
+execution: ~

trunk/test/unit/config/fixtures/sfFilterConfigHandler/default_filters.yml

@@ -1 @@
-
+
+
+
+
+
+
-  class: defaultFilterClass
-
-
-
+
+
+
+

trunk/test/unit/config/fixtures/sfFilterConfigHandler/filters.yml

@@ -1 @@
-
+
+
+
+
-  class: newFilterClass
+  param:
+    key: value
-
-
-
+
+
+

trunk/test/unit/config/fixtures/sfFilterConfigHandler/result.php

@@ -3 +3 @@
-// 
-
-
-
+
+
+
+
-$filterChain->register($filter);
-
-
-
+
+
+
-$filterChain->register($filter);
-
-
-
+
+
+
+
+
-$filterChain->register($filter);
-
+list($class, $parameters) = (array) sfConfig::get('sf_rendering_filter', array('sfRenderingFilter', array (
+  'key' => 'value',
+)));
+$filter = new $class();
+$filter->initialize($this->context, $parameters);
+$filterChain->register($filter);
+

trunk/test/unit/config/sfFilterConfigHandlerTest.php

@@ -11 +11 @@
-require_once(dirname(__FILE__).'/../../bootstrap/unit.php');
-
-2
+8
-
-$handler = new sfFilterConfigHandler();
@@ -18 +18 @@
-$dir = dirname(__FILE__).DIRECTORY_SEPARATOR.'fixtures'.DIRECTORY_SEPARATOR.'sfFilterConfigHandler'.DIRECTORY_SEPARATOR;
-
+// parse errors
-$t->diag('parse errors');
-$files = array(
@@ -33 +34 @@
-}
-
+// no execution/rendering filter
+foreach (array('execution', 'rendering') as $key)
+{
+  $files = array(
+    $dir.sprintf('no_%s.yml', $key),
+  );
+
+  try
+  {
+    $data = $handler->execute($files);
+    $t->fail(sprintf('filters.yml must have a filter of type "%s"', $key));
+  }
+  catch (sfParseException $e)
+  {
+    $t->like($e->getMessage(), sprintf('/must register a filter of type "%s"/', $key), sprintf('filters.yml must have a filter of type "%s"', $key));
+  }
+}
+
+// filter inheritance
+$t->diag('filter inheritance');
+$files = array(
+  $dir.'default_filters.yml',
+  $dir.'not_disabled.yml',
+);
+
+try
+{
+  $data = $handler->execute($files);
+  $t->fail('filters.yml must keep all filters when inheriting from a master filters configuration file');
+}
+catch (sfConfigurationException $e)
+{
+  $t->like($e->getMessage(), '/but not present/', 'filters.yml must keep all filters when inheriting from a master filters configuration file');
+}
+
+// disabling a filter
+$t->diag('disabling a filter');
+$files = array(
+  $dir.'disable.yml',
+);
+
+$t->unlike($handler->execute($files), '/defaultFilterClass/', 'you can disable a filter by settings "enabled" to false');
+
+// condition support
+$t->diag('condition support');
+$files = array(
+  $dir.'condition.yml',
+);
+
+sfConfig::set('default_test', true);
+$t->like($handler->execute($files), '/defaultFilterClass/', 'you can add a "condition" key to the filter parameters');
+
+sfConfig::set('default_test', false);
+$t->unlike($handler->execute($files), '/defaultFilterClass/', 'you can add a "condition" key to the filter parameters');
+
+// usual configuration
+$t->diag('usual configuration');
-$files = array(
-  $dir.'default_filters.yml',
@@ -40 +98 @@
-$data = $handler->execute($files);
-$data = preg_replace('#date\: \d+/\d+/\d+ \d+\:\d+\:\d+#', '', $data);
-
-$t->is($data, str_replace("\r\n", "\n", file_get_contents($dir.'result.php')), 'core filters.yml can be overriden');