Changeset 1448 for branches/david-execution_flow/src/controller/AgaviController.class.php

Timestamp:

01/01/07 19:42:27 (2 years ago)

Author:

david

Message:

work in progress: new execution flow, action stack is gone, decoration doesn't require special abilities of the renderer anymore, but still needs further abstraction. decorators in decorators (for slots) should work now, and slots are available in the main content template. also, caching for execution filter is in place, albeit not enabled/complete yet. refs #373, #377, #287 and #290

Files:

• branches/david-execution_flow/src/controller/AgaviController.class.php (modified) (15 diffs)

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

@@ -30 +30 @@
 {
   /**
+   * @var        int The number of forward() calls done so far.
+   */
+  protected $numForwards = 0;
+  
+  /**
    * @var        int The maximum number of times this Controller will forward().
    */
   protected $maxForwards  = 20;
   
-  /**
-   * @var        int The render mode, see AgaviView RENDER_* constants.
-   */
-  protected $renderMode   = AgaviView::RENDER_CLIENT;
-
-  /**
-   * @var        AgaviActionStack An ActionStack instance.
-   */
-  protected $actionStack = null;
-
   /**
    * @var        AgaviContext An AgaviContext instance.
@@ -55 +50 @@
     'global' => array(),
     'action' => array(
-      '*' => null
-    ),
-    'rendering' => array(
       '*' => null
     ),
@@ -76 +68 @@
   
   /**
-   * @var        AgaviResponse The Response instance for this Controller.
-   */
-  protected $response = null;
-  
-  /**
-   * @var        AgaviResponse The Response to be used after redirects are set.
-   */
-  protected $redirectResponse = null;
-
-  /**
-   * Retrieve the ActionStack.
-   *
-   * @return     AgaviActionStack the ActionStack instance
-   *
-   * @author     David Zuelke <dz@bitxtender.com>
-   * @since      0.11.0
-   */
-  public function getActionStack()
-  {
-    return $this->actionStack;
-  }
-
-  /**
    * Indicates whether or not a module has a specific action.
    *
@@ -104 +73 @@
    * @param      string An action name.
    *
-   * @return     mixed  The actual name of the action (might be auto-resolved),
-   *                    or false if no Action related to that name was found.
-   *
-   * @author     Sean Kerr <skerr@mojavi.org>
-   * @author     David Zuelke <dz@bitxtender.com>
-   * @since      0.9.0
-   */
-  public function actionExists($moduleName, $actionName = null)
+   * @return     mixed  The actual name of the action (might be auto-resolved).
+   *
+   * @throws     AgaviControllerException if the action could not be found.
+   * @author     Sean Kerr <skerr@mojavi.org>
+   * @author     David Zuelke <dz@bitxtender.com>
+   * @since      0.9.0
+   */
+  public function resolveAction($moduleName, $actionName = null)
   {
     $actionName = str_replace('.', '/', $actionName);
@@ -123 +92 @@
       if(is_readable($file)) {
         return $actionName;
-      } else {
-        return false;
-      }
-    }
+      }
+    }
+    throw new AgaviControllerException(sprintf('Action "%s" in Module "%s" could not be found.', $actionName, $moduleName));
+  }
+  
+  public function incNumForwards()
+  {
+    if(++$this->numForwards > $this->maxForwards) {
+      throw new AgaviForwardException('Too many forwards have been detected for this request.');
+    }
+  }
+  
+  /**
+   * Create and initialize new execution container instance.
+   *
+   * @param      string The name of the module.
+   * @param      string The name of the action.
+   * @param      array  Optional additional parameters.
+   *
+   * @return     AgaviExecutionContainer A new execution container instance,
+   *                                     fully initialized.
+   *
+   * @author     David Zuelke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function createExecutionContainer($moduleName, $actionName, array $parameters = array())
+  {
+    $container = new AgaviExecutionContainer();
+    $container->initialize($this->context, $moduleName, $actionName, $parameters);
+    return $container;
   }
   
@@ -146 +141 @@
       $request->setAttribute('matchedRoutes', $this->context->getRouting()->execute(), 'org.agavi.routing');
     
-      if($parameters != null) {
-        $request->setParametersByRef($parameters);
-      }
+      $request->setParameters($parameters);
     
       // determine our module and action
@@ -171 +164 @@
       }
       
+      $container = $this->createExecutionContainer($moduleName, $actionName);
+      
       // create a new filter chain
       $fcfi = $this->context->getFactoryInfo('filter_chain');
       $filterChain = new $fcfi['class']();
-      $filterChain->initialize($this->response, $fcfi['parameters']);
+      $filterChain->initialize($this->context, $fcfi['parameters']);
       
       $this->loadFilters($filterChain, 'global');
@@ -182 +177 @@
     
       // go, go, go!
-      $filterChain->execute();
-      
-      if($this->redirectResponse instanceof AgaviResponse) {
-        $this->redirectResponse->append($this->response->export());
-        $this->redirectResponse->send();
+      $filterChain->execute($container);
+      
+      $container->getResponse()->send();
+      
+    } catch(Exception $e) {
+      if(isset($container) && $container instanceof AgaviExecutionContainer && $container->getResponse() instanceof AgaviResponse) {
+        AgaviException::printStackTrace($e, $this->context, $response);
       } else {
-        $this->response->send();
-      }
-      
-    } catch(Exception $e) {
-      AgaviException::printStackTrace($e, $this->context, $this->getResponse());
-    }
-  }
-
-  /**
-   * Forward the request to another action.
-   *
-   * @param      string A module name.
-   * @param      string An action name.
-   * @param      array|AgaviParameterHolder Additional parameters which will be
-   *                                        passed to the action.
-   *
-   * @throws     <b>AgaviConfigurationException</b> If an invalid configuration 
-   *                                                setting has been found.
-   * @throws     <b>AgaviForwardException</b> If an error occurs while 
-   *                                          forwarding the request.
-   * @throws     <b>AgaviInitializationException</b> If the action could not be
-   *                                                 initialized.
-   * @throws     <b>AgaviSecurityException</b> If the action requires security 
-   *                                           but the user implementation is 
-   *                                           not of type SecurityUser.
-   *
-   * @author     Sean Kerr <skerr@mojavi.org>
-   * @since      0.9.0
-   */
-  public function forward($moduleName, $actionName = 'Index', $additionalParams = array())
-  {
-    $request = $this->context->getRequest();
-
-    $actionName = str_replace('.', '/', $actionName);
-    $actionName = preg_replace('/[^a-z0-9\-_\/]+/i', '', $actionName);
-    $moduleName = preg_replace('/[^a-z0-9\-_]+/i', '', $moduleName);
-
-    if($this->actionStack->getSize() >= $this->maxForwards) {
-      throw new AgaviForwardException('Too many forwards have been detected for this request');
-    }
-
-    if(!AgaviConfig::get('core.available', false)) {
-      // application is unavailable
-      $request->setAttributes(array(
-        'requested_module' => $moduleName,
-        'requested_action' => $actionName
-      ), 'org.agavi.controller.forwards.unavailable');
-      $moduleName = AgaviConfig::get('actions.unavailable_module');
-      $actionName = AgaviConfig::get('actions.unavailable_action');
-
-      if(!$this->actionExists($moduleName, $actionName)) {
-        // cannot find unavailable module/action
-        $error = 'Invalid configuration settings: actions.unavailable_module "%s", actions.unavailable_action "%s"';
-        $error = sprintf($error, $moduleName, $actionName);
-
-        throw new AgaviConfigurationException($error);
-      }
-
-    } elseif(!$this->actionExists($moduleName, $actionName)) {
-      // the requested action doesn't exist
-
-      // track the requested module so we have access to the data
-      // in the error 404 page
-      $request->setAttributes(array(
-        'requested_module' => $moduleName,
-        'requested_action' => $actionName
-      ), 'org.agavi.controller.forwards.error_404');
-
-      // switch to error 404 action
-      $moduleName = AgaviConfig::get('actions.error_404_module');
-      $actionName = AgaviConfig::get('actions.error_404_action');
-
-      if(!$this->actionExists($moduleName, $actionName)) {
-        // cannot find unavailable module/action
-        $error = 'Invalid configuration settings: actions.error_404_module "%s", actions.error_404_action "%s"';
-        $error = sprintf($error, $moduleName, $actionName);
-
-        throw new AgaviConfigurationException($error);
-      }
-    }
-    
-    // get the "real" action name, i.e. allow auto-resolving of sub-action IndexActions
-    $actionName = $this->actionExists($moduleName, $actionName);
-
-    // create an instance of the action
-    $actionInstance = $this->getAction($moduleName, $actionName);
-
-    // add a new action stack entry
-    $actionEntry = $this->actionStack->addEntry($moduleName, $actionName, $actionInstance, new AgaviParameterHolder(array_merge($request->getParameters(), $additionalParams instanceof AgaviParameterHolder ? $additionalParams->getParameters() : (array) $additionalParams)));
-
-    // include the module configuration
-    // laoded only once due to the way import() works
-    if(is_readable(AgaviConfig::get('core.module_dir') . '/' . $moduleName . '/config/module.xml')) {
-      AgaviConfigCache::import(AgaviConfig::get('core.module_dir') . '/' . $moduleName . '/config/module.xml', $this->context->getName());
-    } else {
-      AgaviConfig::set('modules.' . strtolower($moduleName) . '.enabled', true);
-    }
-
-    // save autoloads so we can restore them later
-    $oldAutoloads = Agavi::$autoloads;
-    
-    static $moduleAutoloads = array();
-    if(!isset($moduleAutoloads[$moduleName])) {
-      $moduleAutoloads[$moduleName] = array();
-      $moduleAutoload = AgaviConfig::get('core.module_dir') . '/' . $moduleName . '/config/autoload.xml';
-      if(is_readable($moduleAutoload)) {
-        include(AgaviConfigCache::checkConfig($moduleAutoload));
-        $moduleAutoloads[$moduleName] = Agavi::$autoloads;
-      }
-    } else {
-      Agavi::$autoloads = array_merge($moduleAutoloads[$moduleName], Agavi::$autoloads);
-    }
-    
-    if(AgaviConfig::get('modules.' . strtolower($moduleName) . '.enabled')) {
-      // check for a module config.php
-      $moduleConfig = AgaviConfig::get('core.module_dir') . '/' . $moduleName . '/config.php';
-      if(is_readable($moduleConfig)) {
-        require_once($moduleConfig);
-      }
-
-      // initialize the action
-      $actionInstance->initialize($this->context);
-      
-      // create a new response instance for this action
-      $rfi = $this->context->getFactoryInfo('response');
-      $response = new $rfi['class'];
-      $response->initialize($this->context, $rfi['parameters']);
-
-      // create a new filter chain
-      $fcfi = $this->context->getFactoryInfo('filter_chain');
-      $filterChain = new $fcfi['class']();
-      $filterChain->initialize($response, $fcfi['parameters']);
-
-      if(AgaviConfig::get('core.available', false)) {
-        // the application is available so we'll register
-        // global and module filters, otherwise skip them
-
-        // does this action require security?
-        if(AgaviConfig::get('core.use_security', false) && $actionInstance->isSecure()) {
-          // register security filter
-          $filterChain->register($this->filters['security']);
-        }
-
-        // load filters
-        $this->loadFilters($filterChain, 'action');
-        $this->loadFilters($filterChain, 'action', $moduleName);
-      }
-
-      // register the execution filter
-      $filterChain->register($this->filters['execution']);
-
-      // process the filter chain
-      $filterChain->execute();
-      
-      // clear the global request attribute namespace containing attributes for the View
-      $request->removeAttributeNamespace($request->getDefaultNamespace());
-      
-      if($this->renderMode == AgaviView::RENDER_CLIENT && !$actionEntry->hasNext()) {
-        // add the output for this action to the global one
-        $this->getResponse()->append($response->export());
-      }
-      
-      // restore autoloads
-      Agavi::$autoloads = $oldAutoloads;
-
-    } else {
-      // module is disabled
-      $request->setAttributes(array(
-        'requested_module' => $moduleName,
-        'requested_action' => $actionName
-      ), 'org.agavi.controller.forwards.disabled');
-      $moduleName = AgaviConfig::get('actions.module_disabled_module');
-      $actionName = AgaviConfig::get('actions.module_disabled_action');
-
-      if(!$this->actionExists($moduleName, $actionName)) {
-        // cannot find mod disabled module/action
-        $error = 'Invalid configuration settings: actions.module_disabled_module "%s", actions.module_disabled_action "%s"';
-        $error = sprintf($error, $moduleName, $actionName);
-        throw new AgaviConfigurationException($error);
-      }
-
-      $this->forward($moduleName, $actionName);
-    }
-    
-    if($actionEntry->hasNext()) {
-      $next = $actionEntry->getNext();
-      $request->setParameters($next['parameters'] instanceof AgaviParameterHolder ? $next['parameters']->getParameters() : $next['parameters']);
-      $this->forward($next['moduleName'], $next['actionName']);
+        AgaviException::printStackTrace($e, $this->context);
+      }
     }
   }
@@ -391 +202 @@
    */
   abstract public function redirect($to);
-
-  /**
-   * Retrieve the currently executing Action's name.
-   *
-   * @return     string The currently executing action name, if one is set,
-   *                    otherwise null.
-   *
-   * @author     Sean Kerr <skerr@mojavi.org>
-   * @author     David Zuelke <dz@bitxtender.com>
-   * @since      0.11.0
-   */
-  public function getActionName()
-  {
-    // get the last action stack entry
-    $actionEntry = $this->actionStack->getLastEntry();
-
-    return $actionEntry->getActionName();
-  }
-  
-  /**
-   * Retrieve the currently executing Action's module directory.
-   *
-   * @return     string An absolute filesystem path to the directory of the
-   *                    currently executing module if set, otherwise null.
-   *
-   * @author     Sean Kerr <skerr@mojavi.org>
-   * @author     David Zuelke <dz@bitxtender.com>
-   * @since      0.11.0
-   */
-  public function getModuleDirectory()
-  {
-    // get the last action stack entry
-    $actionEntry = $this->actionStack->getLastEntry();
-
-    return AgaviConfig::get('core.module_dir') . '/' . $actionEntry->getModuleName();
-  }
-
-  /**
-   * Retrieve the currently executing Action's module name.
-   *
-   * @return     string The currently executing module name, if one is set,
-   *                    otherwise null.
-   *
-   * @author     Sean Kerr <skerr@mojavi.org>
-   * @author     David Zuelke <dz@bitxtender.com>
-   * @since      0.11.0
-   */
-  public function getModuleName()
-  {
-    // get the last action stack entry
-    $actionEntry = $this->actionStack->getLastEntry();
-
-    return $actionEntry->getModuleName();
-  }
 
   /**
@@ -510 +267 @@
 
   /**
-   * Retrieve the Response object.
-   *
-   * @return     AgaviResponse The current Response implementation instance.
-   *
-   * @author     David Zuelke <dz@bitxtender.com>
-   * @since      0.11.0
-   */
-  protected final function getResponse()
-  {
-    return $this->response;
-  }
-
-  /**
-   * Retrieve the presentation rendering mode.
-   *
-   * @return     int One of the following:
-   *                 - AgaviView::RENDER_CLIENT
-   *                 - AgaviView::RENDER_VAR
-   *
-   * @author     Sean Kerr <skerr@mojavi.org>
-   * @since      0.9.0
-   */
-  public function getRenderMode()
-  {
-    return $this->renderMode;
-  }
-
-  /**
    * Retrieve a View implementation instance.
    *
@@ -623 +352 @@
     $this->filters['execution'] = new $effi['class']();
     $this->filters['execution']->initialize($this->context, $effi['parameters']);
-    
+  }
+  
+  public function getFilter($which)
+  {
+    return (isset($this->filters[$which]) ? $this->filters[$which] : null);
   }
   
@@ -630 +363 @@
    *
    * @param      AgaviFilterChain A FilterChain instance.
-   * @param      string           "global", "action" or "rendering".
+   * @param      string           "global" or "action".
    * @param      string           A module name, or "*" for the generic config.
    *
@@ -703 +436 @@
 
   /**
-   * Set the presentation rendering mode.
-   *
-   * @param      int A rendering mode.
-   *
-   * @throws     <b>AgaviRenderException</b> - If an invalid render mode has 
-   *                                           been set.
-   *
-   * @author     Sean Kerr <skerr@mojavi.org>
-   * @since      0.9.0
-   */
-  public function setRenderMode($mode)
-  {
-    if($mode == AgaviView::RENDER_CLIENT || $mode == AgaviView::RENDER_VAR || $mode == AgaviView::RENDER_NONE) {
-      $this->renderMode = $mode;
-      return;
-    }
-
-    // invalid rendering mode type
-    $error = 'Invalid rendering mode: %s';
-    $error = sprintf($error, $mode);
-
-    throw new AgaviRenderException($error);
-  }
-
-  /**
    * Execute the shutdown procedure for this controller.
    *
@@ -760 +468 @@
    * @param      string The output type name.
    *
-   * @return     bool Whether or not the operation was successful.
-   *
    * @throws     <b>AgaviConfigurationException</b> If the given output type 
    *                                                doesnt exist.
@@ -771 +477 @@
   {
     if(isset($this->outputTypes[$outputType])) {
-      if(!$this->getResponse()->isLocked()) {
-        $this->outputType = $outputType;
-        return true;
-      }
-      return false;
+      $this->outputType = $outputType;
     } else {
       throw new AgaviConfigurationException('Output Type "' . $outputType . '" has not been configured.');