class.MultipleActionController.php

Go to the documentation of this file.

<?php
/** 
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005 wemove digital solutions GmbH
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * $Id: class.MultipleActionController.php 1427 2012-12-21 19:03:06Z iherwig $
 */
require_once(BASE."wcmf/lib/presentation/class.Controller.php");
require_once(BASE."wcmf/lib/presentation/class.ActionMapper.php");

/**
 * @class MultipleActionController
 * @ingroup Controller
 * @brief MultipleActionController is a controller that executes multiple actions by
 * passing them do the appropriate controllers and returning all results as once.
 * 
 * <b>Input actions:</b>
 * - unspecified: Execute the given actions
 *
 * <b>Output actions:</b>
 * - @em ok In any case
 * 
 * @param[in] data An associative array with unique/sortable keys and values that describe an action to perform
 * @param[out] data An associative array with the same keys and values that describe the resonse of each action
 *
 * The data array may contain the following special variables, that will be replaced by the described values:
 * - {last_created_oid:type}  will be replaced by the oid lastly created object of the given type
 *
 * An example of input data in JSON:
 * @code
    data: {
      action1: {
        usr_action: "new",
        type: "ChiGoal"
      }
      action2: {
        usr_action: "display",
        oid: {last_created_oid:ChiGoal},
        omitMetaData: true
      }
    }
 * @endcode
 * 
 * The output data for the preceding request could look like
 * @code
   data: {
     action1: {
       oid: "ChiGoal:123",
       success: "1"
     }
     action2: {
       oid: "ChiGoal:123",
       node: {
         "0": {
           modified: "2001-01-01 01:01",
           creator: "admin"
           ...
         }
         ...
       },
       success: "1"
     }
   }
 * @endcode
 *
 * @author      ingo herwig <ingo@wemove.com>
 */
class MultipleActionController extends Controller
{
  /**
   * @see Controller::validate()
   */
  function validate()
  {
    // check if we have an array of arrays
    $data = &$this->_request->getValue('data');
    foreach($data as $key => $value)
    {
      if (!is_array($value))
      {
        $this->setErrorMsg("Data should be an associative array of action definition arrays.");
        return false;
      }
    }
    return true;
  }
  /**
   * @see Controller::hasView()
   */
  function hasView()
  {
    return false;
  }
  /**
   * (Dis-)Associate the Nodes.
   * @return Array of given context and action 'ok' in every case.
   * @see Controller::executeKernel()
   */
  function executeKernel()
  {
    // create and execute requests for the actions given in data
    $results = array();
    $session = &SessionData::getInstance();
    $data = &$this->_request->getValue('data');
    $actions = array_keys($data);
    $numActions = sizeof($actions);
    $exceptions = array();
    for($i=0; $i<$numActions; $i++)
    {
      $action = $actions[$i];
      $GLOBALS['gJSONData'] = array();
      
      if (Log::isDebugEnabled(__CLASS__)) {
        Log::debug("processing action: ".$action.":\n".StringUtil::getDump($data[$action]), __CLASS__);
      }
      // replace special variables
      $this->replaceVariables($data[$action]);

      // for all requests we choose TerminateController as source controller 
      // to make sure that we process the action and return to here
      
      // create the request
      $request = new Request(
        'TerminateController',
        $data[$action]['context'], 
        $data[$action]['usr_action'], 
        $data[$action]
      );
      $request->setFormat('Null');
      $request->setResponseFormat($this->_request->getResponseFormat());

      // execute the request
      try {
        $response = &ActionMapper::processAction($request);
      }
      catch (ApplicationException $ex)
      {
        Log::error($ex->__toString(), __CLASS__);
        $response = $ex->getResponse();
        if ($response == null) {
          $response = new Response('', '', $action, array());
          $response->setFormat($request->getResponseFormat());
          $requestData = $request->getData();
          foreach ($requestData as $key => $value) {
            $response->setValue($key, $value);
          }
        }
        $response->setValue('success', false);
        $response->setValue('errorCode', $ex->getCodeString());
        $response->setValue('errorMessage', $ex->getMessage());
        $exceptions[] = $ex;
      }
      catch (Exception $ex)
      {
        Log::error($ex->__toString(), __CLASS__);
        $exceptions[] = $ex;
      }
      
      // collect the result
      $results[$action] = &$response->getData();
    }
    if (Log::isDebugEnabled(__CLASS__)) {
      Log::debug($results, __CLASS__);
    }
    
    // add error from first exception to mark the action set execution as failed
    if (sizeof($exceptions) > 0) {
      $ex = $exceptions[0];
      $this->_response->setValue('success', false);
      $this->_response->setValue('errorCode', $ex->getCodeString());
      $this->_response->setValue('errorMessage', $ex->getMessage());
    }
    $this->_response->setValue('data', $results);
    $this->_response->setAction('ok');
    return true;
  }
  
  /**
   * Check the given data array for special variables to replace
   * Variables have either the form 'variable_name' or 'variable_name:column_separated_parameters'
   * @param data A reference to the associative data array
   */
  function replaceVariables(&$data)
  {
    $keys = array_keys($data);
    for($i=0; $i<sizeof($keys); $i++)
    {
      $key = $keys[$i];
      $value = $data[$key];
      
      // replace variables
      $newKey = $this->replaceVariablesString($key);
      $newValue = $this->replaceVariablesString($value);

      // replace entry
      if ($key != $newKey || $value != $newValue)
      {
        if (Log::isDebugEnabled(__CLASS__))
        {
          if ($key != $newKey)
            Log::debug("Replace $key by $newKey", __CLASS__);
          if ($value != $newValue)
            Log::debug("Replace $value by $newValue", __CLASS__);
        }
        unset($data[$key]);
        $data[$newKey] = $newValue;
      }
    }
  }

  /**
   * Check the given string for special variables to replace
   * Variables have either the form 'variable_name' or 'variable_name:column_separated_parameters'
   * @param value The string
   * @return The string
   */
  function replaceVariablesString($value)
  {
    preg_match_all('/\{([^\{]+)\}/', $value, $variableMatches);
    $variables = $variableMatches[1];
    foreach($variables as $variable)
    {
      preg_match('/^([^:]+)[:]*(.*)$/', $variable, $matches);
      if (sizeof($matches > 0))
      {
        $variableName = $matches[1];
        $parameters = $matches[2];

        // last_created_oid
        if ($variableName == 'last_created_oid')
        {
          $type = $parameters;
          if (PersistenceFacade::isKnownType($type))
          {
            $persistenceFacade = &PersistenceFacade::getInstance();
            $oid = $persistenceFacade->getLastCreatedOID($type);
            $value = preg_replace("/{".$variable."}/", $oid, $value);
          }
        }

        // Dionysos oid reference: {type:?}
        if (PersistenceFacade::isKnownType($variableName))
        {
          $type = $variableName;
          $persistenceFacade = &PersistenceFacade::getInstance();
          $oid = $persistenceFacade->getLastCreatedOID($type);
          $value = $oid;
        }
      }
    }
    return $value;
  }
}
?>