class.BatchDisplayController.php

Go to the documentation of this file.

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2014 wemove digital solutions GmbH
 *
 * Licensed under the terms of any of the following licenses 
 * at your choice:
 *
 * - GNU Lesser General Public License (LGPL)
 *   http://www.gnu.org/licenses/lgpl.html
 * - Eclipse Public License (EPL)
 *   http://www.eclipse.org/org/documents/epl-v10.php
 *
 * See the license.txt file distributed with this work for 
 * additional information.
 *
 * $Id: class.BatchDisplayController.php 1079 2009-09-08 15:21:33Z iherwig $
 */
require_once(BASE."wcmf/application/controller/class.BatchController.php");
require_once(BASE."wcmf/lib/persistence/class.PersistenceFacade.php");
require_once(BASE."wcmf/lib/model/class.PersistentIterator.php");
require_once(BASE."wcmf/lib/model/class.Node.php");
require_once(BASE."wcmf/lib/model/class.NodeUtil.php");

/**
 * @class BatchDisplayController
 * @ingroup Controller
 * @brief BatchDisplayController is a controller that loads a tree of Nodes recursivly and
 * returns the Nodes in lists of a given size. The reconstruction of the tree must 
 * be handled by the client.
 *
 * <b>Input actions:</b>
 * - see BatchController
 *
 * <b>Output actions:</b>
 * - see BatchController
 * 
 * @param[in,out] oid The oid of the Node to start loading from
 * @param[in] translateValues True/False. If true, list values will be translated using FormUtil::translateValue. If not given, 
 *                        all values will be returned as is, default: true
 * @param[in] nodes_per_call The number of nodes to process in one call, default: 50
 * @param[out] objects An array of Nodes
 *
 * @author ingo herwig <ingo@wemove.com>
 */
class BatchDisplayController extends BatchController
{
  // session name constants
  var $REQUEST = 'BatchDisplayController.request';
  var $REGISTRY = 'BatchDisplayController.registry';
  var $ITERATOR_ID = 'BatchDisplayController.iteratorid';
  
  // default values, maybe overriden by corresponding request values (see above)
  var $_NODES_PER_CALL = 50;
  
  /**
   * @see Controller::initialize()
   */
  function initialize(&$request, &$response)
  {
    parent::initialize($request, $response);

    // initialize controller
    if ($request->getAction() != 'continue')
    {
      $session = &SessionData::getInstance();

      // set defaults
      if (!$request->hasValue('nodes_per_call')) {
        $request->setValue('nodes_per_call', $this->_NODES_PER_CALL);
      }
      if (!$request->hasValue('translateValues')) {
        $request->setValue('translateValues', true);
      }
      
      // store request in session
      $session->set($this->REQUEST, $request, array(BASE."wcmf/lib/presentation/class.ControllerMessage.php"));
      $reg = array();
      $session->set($this->REGISTRY, $reg);
    }
  }
  /**
   * @see Controller::validate()
   */
  function validate()
  {
    if ($this->_request->getAction() != 'continue')
    {
      // check request values
      if(strlen($this->_request->getValue('oid')) == 0)
      {
        $this->appendErrorMsg("No 'oid' given in data.");
        return false;
      }
    }
    // do default validation
    return parent::validate();
  }
  /**
   * @see BatchController::getWorkPackage()
   */
  function getWorkPackage($number)
  {
    if ($number == 0) {
      return array('name' => Message::get('Loading'), 'size' => 1, 'oids' => array(1), 'callback' => 'startProcess');
    }
    else {
      return null;
    }
  }
  /**
   * @see LongTaskController::getDisplayText()
   */
  function getDisplayText($step)
  {
    return $this->_workPackages[$step-1]['name']." ...";
  }
  /**
   * Copy/Move the first node (oids parameter will be ignored)
   * @param oids The oids to process
   */
  function startProcess($oids)
  {
    $session = &SessionData::getInstance();
    
    // restore the request from session
    $request = $session->get($this->REQUEST);
    $nodeOID = $request->getValue('oid');
    
    // do the action
    $iterator = new PersistentIterator($nodeOID);
    $iteratorID = $iterator->save();
    $session->set($this->ITERATOR_ID, $iteratorID);
    
    // display the first node in order to reduce the number of calls
    $this->loadNode($iterator->getCurrentOID());
    
    $iterator->proceed();

    // proceed if nodes are left
    if (!$iterator->isEnd())
    {
      $iteratorID = $iterator->save();
      $session->set($this->ITERATOR_ID, $iteratorID);
      
      $name = Message::get('Loading tree: continue with %1%', array($iterator->getCurrentOID()));
      $this->addWorkPackage($name, 1, array(null), 'loadNodes');
    }
    else
    {
      // set the result and finish
      $this->endProcess();
    }
  }
  /**
   * Load nodes provided by the persisted iterator (oids parameter will be ignored)
   * @param oids The oids to process
   */
  function loadNodes($oids)
  {
    $session = &SessionData::getInstance();
    
    // restore the request from session
    $request = $session->get($this->REQUEST);

    // check for iterator in session
    $iterator = null;
    $iteratorID = $session->get($this->ITERATOR_ID);
    if ($iteratorID != null) {
      $iterator = &PersistentIterator::load($iteratorID);
    }

    // no iterator, finish  
    if ($iterator == null)
    {
      // set the result and finish
      $this->endProcess();
    }

    // process _NODES_PER_CALL nodes
    $counter = 0;
    while (!$iterator->isEnd() && $counter < $request->getValue('nodes_per_call'))
    {
      $currentOID = $iterator->getCurrentOID();
      $this->loadNode($currentOID);

      $iterator->proceed();
      $counter++;
    }
    
    // decide what to do next
    if (!$iterator->isEnd())
    {
      // proceed with current iterator
      $iteratorID = $iterator->save();
      $session->set($this->ITERATOR_ID, $iteratorID);

      $name = Message::get('Loading tree: continue with %1%', array($iterator->getCurrentOID()));
      $this->addWorkPackage($name, 1, array(null), 'loadNodes');
    }
    else
    {
      // set the result and finish
      $this->endProcess();
    }
  }
  /**
   * Finish the process and set the result
   */
  function endProcess() 
  {
    $session = &SessionData::getInstance();

    // clear session variables
    $tmp = null;
    $session->set($this->REQUEST, $tmp);
    $session->set($this->REGISTRY, $tmp);
    $session->set($this->ITERATOR_ID, $tmp);
  }
  /**
   * Load the node with the given object id and assign it to the response.
   * @param oid The oid of the node to copy
   */
  function loadNode($oid)
  {
    // check if we already loaded the node
    if ($this->isRegistered($oid))
      return;
      
    $persistenceFacade = &PersistenceFacade::getInstance();
    $session = &SessionData::getInstance();

    // restore the request from session
    $request = $session->get($this->REQUEST);

    // load the node
    $node = &$persistenceFacade->load($oid, BUIDLDEPTH_SINGLE);
    if ($node == null) {
      WCMFException::throwEx("Can't load node '".$oid."'", __FILE__, __LINE__);
    }
    
    // translate all nodes to the requested language if requested
    if ($this->isLocalizedRequest())
    {
      $localization = Localization::getInstance();
      $localization->loadTranslation($node, $request->getValue('language'), true, true);
    }

    // translate values if requested
    if ($request->getBooleanValue('translateValues'))
    {
      $nodes = array($node);
      if ($this->isLocalizedRequest()) {
        NodeUtil::translateValues($nodes, $request->getValue('language'));
      }
      else {
        NodeUtil::translateValues($nodes);
      }
    }

    // assign it to the response
    $this->addNodeToResponse($node);

    $this->register($oid);

    if (Log::isInfoEnabled(__CLASS__)) {
      Log::info("Loaded: ".$node->getOID(), __CLASS__);
    }
    if (Log::isDebugEnabled(__CLASS__)) {
      Log::debug($node->toString(), __CLASS__);
    }    
  }
  /**
   * Register an object id in the registry
   * @param oid The object id to register
   */
  function register($oid)
  {
    $session = &SessionData::getInstance();
    $registry = $session->get($this->REGISTRY);
    array_push($registry, $oid);
    $session->set($this->REGISTRY, $registry);
  }
  /**
   * Check if an object id is registered in the registry
   * @param oid The object id to check
   * @return True/False wether the oid is registered or not
   */
  function isRegistered($oid)
  {
    $session = &SessionData::getInstance();
    $registry = $session->get($this->REGISTRY);
    
    return in_array($oid, $registry);
  }
  /**
   * Add a given node to the objects variable of the response
   * @param node A reference to the node to add
   */
  function addNodeToResponse(&$node)
  {
    if (!$this->_response->hasValue('objects')) {
      $objects = array();
      $this->_response->setValue('objects', $objects);
    }
    
    $objects = &$this->_response->getValue('objects');
    $objects[sizeof($objects)] = &$node;
    $this->_response->setValue('objects', $objects);
  }
}
?>