Changeset 1477

Timestamp:

01/10/07 13:48:36 (2 years ago)

Author:

david

Message:

more work on execution flow changes, next works now again, security filter forwards etc have been figured out. we still have to eliminate some of the wonkiness with the global response, that's gonna be rather difficult, I imagine. refs #373

Location:

branches/david-execution_flow

Files:

• src/config/AgaviOutputTypeConfigHandler.class.php (modified) (1 diff)
• src/controller/AgaviController.class.php (modified) (8 diffs)
• src/controller/AgaviExecutionContainer.class.php (modified) (9 diffs)
• src/controller/AgaviOutputType.class.php (modified) (1 diff)
• src/core/AgaviContext.class.php (modified) (2 diffs)
• src/exception/AgaviException.class.php (modified) (1 diff)
• src/filter/AgaviDispatchFilter.class.php (modified) (1 diff)
• src/filter/AgaviExecutionFilter.class.php (modified) (3 diffs)
• src/filter/AgaviSecurityFilter.class.php (modified) (2 diffs)
• src/routing/AgaviRouting.class.php (modified) (5 diffs)
• tests2/controller/ControllerTest.php (modified) (1 diff)

branches/david-execution_flow/src/config/AgaviOutputTypeConfigHandler.class.php

@@ -101 +101 @@
       $code[] = implode("\n", array(
         '$ot = new AgaviOutputType();',
-        '$ot->initialize($this->context, ' . var_export($outputType['parameters'], true) . ', ' . var_export($outputType['renderers'], true) . ', ' . var_export($outputType['default_renderer'], true) . ', ' . var_export($outputType['exception_template'], true) . ');',
+        '$ot->initialize($this->context, ' . var_export($outputType['parameters'], true) . ', ' . var_export($outputTypeName, true) . ', ' . var_export($outputType['renderers'], true) . ', ' . var_export($outputType['default_renderer'], true) . ', ' . var_export($outputType['exception_template'], true) . ');',
         '$this->outputTypes["' . $outputTypeName . '"] = $ot;',
       ));

branches/david-execution_flow/src/controller/AgaviController.class.php

@@ -88 +88 @@
     } else {
       // maybe it's a sub-action with the last portion omitted
-      $actionName .= '/Index';
+      $actionName .= ($actionName == '' ? '' : '/') . 'Index';
       $file = AgaviConfig::get('core.module_dir') . '/' . $moduleName . '/actions/' . $actionName . 'Action.class.php';
       if(is_readable($file)) {
@@ -126 +126 @@
    * @since      0.11.0
    */
-  public function createExecutionContainer($moduleName, $actionName, array $parameters = array())
+  public function createExecutionContainer($moduleName = null, $actionName = null, array $parameters = array())
   {
     // create a new filter chain
@@ -152 +152 @@
       $request = $this->context->getRequest();
       
-      // match routes and set matched routes as request attributes
-      $request->setAttribute('matchedRoutes', $this->context->getRouting()->execute(), 'org.agavi.routing');
-    
       $request->setParameters($parameters);
-    
-      // determine our module and action
-      $moduleName = $request->getParameter($request->getModuleAccessor());
-      $actionName = $request->getParameter($request->getActionAccessor());
-    
+      
+      // match routes and assign returned initial execution container
+      $container = $this->context->getRouting()->execute();
+      
+      $moduleName = $container->getModuleName();
+      $actionName = $container->getActionName();
+      
       if($moduleName == null) {
         // no module has been specified
-        $moduleName = AgaviConfig::get('actions.default_module');
-        $request->setParameter($request->getModuleAccessor(), $moduleName);
-      }
-      if($actionName == null) {
-        // no action has been specified
-        if($this->actionExists($moduleName, 'Index')) {
-          // an Index action exists
-          $actionName = 'Index';
-        } else {
-          // use the default action
-          $actionName = AgaviConfig::get('actions.default_action');
-        }
-        $request->setParameter($request->getActionAccessor(), $actionName);
-      }
-      
-      $container = $this->createExecutionContainer($moduleName, $actionName);
+        $container->setModuleName(AgaviConfig::get('actions.default_module'));
+        $container->setActionName(AgaviConfig::get('actions.default_action'));
+      }
       
       // create a new filter chain
@@ -186 +172 @@
       
       $this->loadFilters($filterChain, 'global');
-    
+      
       // register the dispatch filter
       $filterChain->register($this->filters['dispatch']);
-    
+      
       // go, go, go!
       $filterChain->execute($container);
@@ -196 +182 @@
       
     } catch(Exception $e) {
-      if(isset($container) && $container instanceof AgaviExecutionContainer && ($response = $container->getResponse()) instanceof AgaviResponse) {
-        AgaviException::printStackTrace($e, $this->context, $response);
+      if(isset($container) && $container instanceof AgaviExecutionContainer) {
+        AgaviException::printStackTrace($e, $this->context, $container);
       } else {
         AgaviException::printStackTrace($e, $this->context);
@@ -231 +217 @@
    * @since      0.9.0
    */
-  public function getAction($moduleName, $actionName)
+  public function createActionInstance($moduleName, $actionName)
   {
     static $loaded = array();
@@ -293 +279 @@
    * @since      0.9.0
    */
-  public function getView($moduleName, $viewName)
+  public function createViewInstance($moduleName, $viewName)
   {
     static $loaded;
@@ -340 +326 @@
   public function initialize(AgaviResponse $response, array $parameters = array())
   {
-    $this->maxForwards = isset($parameters['max_fowards']) ? $parameters['max_forwards'] : 20;
+    $this->maxExecutions = isset($parameters['max_executions']) ? $parameters['max_executions'] : 20;
     
     $this->response = $response;

branches/david-execution_flow/src/controller/AgaviExecutionContainer.class.php

@@ -15 +15 @@
 
 /**
- * A container used for each forward() call that holds action information, the
- * response etc.
+ * A container used for each action execution that holds neecessary information,
+ * such as the output type, the response etc.
  * 
  * @package    agavi
@@ -75 +75 @@
   
   /**
+   * @var        AgaviExecutionContainer The next container to execute.
+   */
+  protected $next = null;
+  
+  /**
    * Initialize the container. This will create a response instance.
    *
@@ -101 +106 @@
    *
    * This will create an instance of the action and merge in request parameters.
+   *
+   * This method returns a response. It is not necessarily the same response as
+   * the one of this container, but instead the one that contains the actual
+   * content that should be used for output etc, since the container's own
+   * response might be empty or invalid due to a "next" container that has been
+   * set and executed.
+   *
+   * @return     AgaviResponse The "real" response.
    *
    * @author     David Zuelke <dz@bitxtender.com>
@@ -164 +177 @@
     $this->setActionName($actionName);
     
-    $this->actionInstance = $controller->getAction($this->moduleName, $this->actionName);
+    $this->actionInstance = $controller->createActionInstance($this->moduleName, $this->actionName);
     
     // include the module configuration
@@ -250 +263 @@
       
       // TODO. this will be pretty difficult, I guess...
-      $controller->forward($moduleName, $actionName);
+      $this->setNext($controller->createExecutionContainer($moduleName, $actionName));
     }
+    
+    if($this->next !== null) {
+      return $this->next->execute();
+    } else {
+      return $this->getResponse();
+    }
   }
   
@@ -268 +287 @@
   
   /**
-   * Retrieve this container's rendered view presentation.
+   * Retrieve this container's response instance.
    *
    * @return     AgaviResponse The Response instance for this action.
@@ -281 +300 @@
   
   /**
+   * Set a new response.
+   *
+   * @param      AgaviResponse A new Response instance.
+   *
+   * @author     David Zuelke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function setResponse(AgaviResponse $response)
+  {
+    $this->response = $response;
+  }
+  
+  /**
    * Retrieve the output type of this container.
    *
@@ -291 +323 @@
   {
     return $this->outputType;
+  }
+  
+  /**
+   * Set a different output type for this container.
+   *
+   * @param      AgaviOutputType An output type object.
+   *
+   * @author     David Zuelke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function setOutputType(AgaviOutputType $outputType)
+  {
+    $this->outputType = $outputType;
   }
   
@@ -424 +469 @@
     $this->viewName = $viewName;
   }
+  
+   /**
+   * Check if a "next" container has been set.
+   *
+   * @return     bool True, if a container for eventual execution has been set.
+   *
+   * @author     David Zuelke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function hasNext()
+  {
+    return $this->next !== null;
+  }
+  
+  /**
+   * Get the "next" container.
+   *
+   * @return     AgaviExecutionContainer The "next" container, of null if unset.
+   *
+   * @author     David Zuelke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function getNext()
+  {
+    return $this->next;
+  }
+  
+  /**
+   * Set the container that should be executed once this one finished running.
+   *
+   * @param      AgaviExcecutionContainer An execution container instance.
+   *
+   * @author     David Zuelke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function setNext(AgaviExecutionContainer $container)
+  {
+    $this->next = $container;
+  }
+  
+  /**
+   * Remove a possibly set "next" container.
+   *
+   * @return     AgaviExecutionContainer The removed "next" container, or null
+   *                                     if none had been set.
+   *
+   * @author     David Zuelke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function clearNext()
+  {
+    $retval = $this->next;
+    $this->next = null;
+    return $retval;
+  }
 }
 

branches/david-execution_flow/src/controller/AgaviOutputType.class.php

@@ -62 +62 @@
    * @since      0.11.0
    */
-  public function initialize(AgaviContext $context, array $parameters, array $renderers, $defaultRenderer, $exceptionTemplate = null)
+  public function initialize(AgaviContext $context, array $parameters, $name, array $renderers, $defaultRenderer, $exceptionTemplate = null)
   {
     $this->context = $context;
     
     $this->parameters = $parameters;
+    
+    $this->name = $name;
     
     $this->renderers = $renderers;

branches/david-execution_flow/src/core/AgaviContext.class.php

@@ -213 +213 @@
         $profile = AgaviConfig::get('core.default_context');
         if($profile === null) {
-          throw new AgaviException('You must supply an environment name to AgaviContext::getInstance() or set the name of the default environment to be used in the configuration directive "core.default_context".');
+          throw new AgaviException('You must supply a context name to AgaviContext::getInstance() or set the name of the default context to be used in the configuration directive "core.default_context".');
         }
       }
@@ -262 +262 @@
     $this->name = $profile;
     
-    include(AgaviConfigCache::checkConfig(AgaviConfig::get('core.config_dir') . '/factories.xml', $profile));
+    try {
+      include(AgaviConfigCache::checkConfig(AgaviConfig::get('core.config_dir') . '/factories.xml', $profile));
+    } catch(Exception $e) {
+      AgaviException::printStackTrace($e, $this);
+    }
     
     register_shutdown_function(array($this, 'shutdown'));

branches/david-execution_flow/src/exception/AgaviException.class.php

@@ -43 +43 @@
    * @since      0.9.0
    */
-  public static function printStackTrace(Exception $e, AgaviContext $context = null, AgaviResponse $response = null)
+  public static function printStackTrace(Exception $e, AgaviContext $context = null, AgaviExecutionContainer $container = null)
   {
     // discard any previous output waiting in the buffer
     while(@ob_end_clean());
     
-    // throw away any response data that might be there
-    if($context !== null && ($c = $context->getController()) !== null && $response !== null) {
-      if($response->isLocked()) {
-        // reponse is locked, so grab the output and discard it
-        ob_start();
-        $response->send();
-        ob_end_clean();
-      } else {
-        // not locked, we can clear the response
-        $response->clear();
-      }
-    }
-    
-    if($context !== null && ($c = $context->getController()) !== null && ($oti = $c->getOutputTypeInfo()) !== null && isset($oti['exception_template'])) { 
-      // an exception template was defined for this output type
-      include($oti['exception_template']); 
+    if($context !== null && $container !== null && ($et = $container->getExceptionTemplate()) !== null) { 
+      // an exception template was defined for the container's output type
+      include($et); 
+    } elseif($container === null && ($c = $context->getController()) !== null && ($ot = $c->getOutputType() !== null) && ($et = $ot->getExceptionTemplate()) !== null) {
+      // an exception template was defined for the default output type and no container was given
+      include($et);
     } elseif($context !== null && $tpl = AgaviConfig::get('exception.templates.' . $context->getName())) {
       // a template was set for this context

branches/david-execution_flow/src/filter/AgaviDispatchFilter.class.php

@@ -46 +46 @@
   public function execute(AgaviFilterChain $filterChain, AgaviExecutionContainer $container)
   {
-    $container->execute();
+    $container->setResponse($container->execute());
   }
 }

branches/david-execution_flow/src/filter/AgaviExecutionFilter.class.php

@@ -333 +333 @@
 
       // get the view instance
-      $viewInstance = $controller->getView($viewModule, $viewName);
+      $viewInstance = $controller->createViewInstance($viewModule, $viewName);
 
       // initialize the view
@@ -363 +363 @@
         }
         $key = $request->toggleLock();
-        $renderer = $viewInstance->$executeMethod($container);
+        $next = $viewInstance->$executeMethod($container);
         $request->toggleLock($key);
         
-        $attributes =& $viewInstance->getAttributes();
-        
-        $output = array();
-        $nextOutput = null;
-        foreach($viewInstance->getLayers() as $layerName => $layer) {
-          foreach($layer->getSlots() as $slotName => $slotContainer) {
-            $slotContainer->execute();
-            $response = $slotContainer->getResponse();
-            if($response) {
-              // set the presentation data as a template attribute
-              $output[$name] = $response->getContent();
-              // $response->merge($response->exportInfo());
-            } else {
-              $output[$name] = null;
+        if($next instanceof AgaviExecutionContainer) {
+          $container->setNext($next);
+        } else {
+          $attributes =& $viewInstance->getAttributes();
+
+          $output = array();
+          $nextOutput = null;
+          foreach($viewInstance->getLayers() as $layerName => $layer) {
+            foreach($layer->getSlots() as $slotName => $slotContainer) {
+              $slotResponse = $slotContainer->execute();
+              if($response) {
+                // set the presentation data as a template attribute
+                $output[$name] = $slotResponse->getContent();
+                // $response->merge($response->exportInfo());
+              } else {
+                $output[$name] = null;
+              }
             }
+            $nextOutput = $layer->getRenderer()->render($layer, $attributes, $output);
+            $output = array();
+            $output[$layerName] = $nextOutput;
           }
-          $nextOutput = $layer->getRenderer()->render($layer, $attributes, $output);
-          $output = array();
-          $output[$layerName] = $nextOutput;
-        }
-        $response->setContent($nextOutput);
+          $response->setContent($nextOutput);
+        }
       }
 
@@ -527 +530 @@
     }
 
-    if($viewName !== AgaviView::NONE && !$controller->viewExists($viewModule, $viewName)) {
-      // the requested view doesn't exist
-      $file = AgaviConfig::get('core.module_dir') . '/' . $viewModule . '/views/' . $viewName . 'View.class.php';
-      $error = 'Module "%s" does not contain the view "%sView" or the file "%s" is unreadable';
-      $error = sprintf($error, $viewModule, $viewName, $file);
-      throw new AgaviViewException($error);
-    }
-
     return array($viewModule, $viewName);
   }

branches/david-execution_flow/src/filter/AgaviSecurityFilter.class.php

@@ -70 +70 @@
         $filterChain->execute($container);
       } else {
-        // the user doesn't have access, exit stage left
+        // the user doesn't have access, set info regarding next action and leave
         $request->setAttributes(array(
           'requested_module' => $container->getModuleName(),
           'requested_action' => $container->getActionName()
         ), 'org.agavi.controller.forwards.secure');
-        $controller->forward(new AgaviExecutionContainer(AgaviConfig::get('actions.secure_module'), AgaviConfig::get('actions.secure_action')));
+        $container->setNext($controller->createExecutionContainer(AgaviConfig::get('actions.secure_module'), AgaviConfig::get('actions.secure_action')));
       }
 
@@ -84 +84 @@
         'requested_action' => $container->getActionName()
       ), 'org.agavi.controller.forwards.login');
-      $controller->forward(new AgaviExecutionContainer(AgaviConfig::get('actions.login_module'), AgaviConfig::get('actions.login_action')));
+      $container->setNext($controller->createExecutionContainer(AgaviConfig::get('actions.login_module'), AgaviConfig::get('actions.login_action')));
     }
   }

branches/david-execution_flow/src/routing/AgaviRouting.class.php

@@ -483 +483 @@
   public function execute()
   {
+    $req = $this->context->getRequest();
+
+    $container = $this->context->getController()->createExecutionContainer();
+    $response = $container->getResponse();
+    
+    if(!AgaviConfig::get('core.use_routing', false) || count($this->routes) == 0) {
+      // routing disabled, determine module and action manually and bail out
+      $container->setModuleName($req->getParameter($req->getModuleAccessor()));
+      $container->setActionName($req->getParameter($req->getActionAccessor()));
+      
+      return $container;
+    }
+
     $matchedRoutes = array();
-
-    if(!AgaviConfig::get('core.use_routing', false) || count($this->routes) == 0) {
-      // routing disabled, bail out
-      return $matchedRoutes;
-    }
-
-    $req = $this->context->getRequest();
 
     $input = $this->input;
@@ -501 +507 @@
     $aa = $req->getActionAccessor();
     $requestMethod = $req->getMethod();
-
-//    $routes = array_keys($this->routes);
 
     // get all top level routes
@@ -524 +528 @@
             $cb = $opts['callback'];
             $route['cb'] = new $cb();
-            $route['cb']->initialize($this->response, $route);
+            $route['cb']->initialize($response, $route);
           }
 
@@ -635 +639 @@
     // set the output type if necessary
     if($ot !== null) {
-      $this->context->getController()->setOutputType($ot);
+      $container->setOutputType($ot);
     }
 
@@ -658 +662 @@
       ));
     }
+    
+    $container->setModuleName($req->getParameter($ma));
+    $container->setActionName($req->getParameter($aa));
+    
+    // set the list of matched route names as a request attribute
+    $req->setAttribute('matchedRoutes', $matchedRoutes, 'org.agavi.routing');
+    
     // return a list of matched route names
-    return $matchedRoutes;
+    return $container;
   }
 

branches/david-execution_flow/tests2/controller/ControllerTest.php

@@ -53 +53 @@
     // TODO: check all other existing naming schemes for actions
 
-    $action = $this->_controller->getAction('Test', 'Test');
+    $action = $this->_controller->createActionInstance('Test', 'Test');
     $this->assertType('Test_TestAction', $action);
     $this->assertType('AgaviAction', $action);
 
     // TODO: this needs checking for errors 
-//    $this->_controller->getAction('Test', 'NonExistant');
+//    $this->_controller->createActionInstance('Test', 'NonExistant');
   }