org.netfrag.app/WebExplorer/AbstractExplorer.php

<?
/*
##    -----------------------------------------------------------------------------
##    $Id: AbstractExplorer.php,v 1.20 2003/04/19 16:24:49 jonen Exp $
##    -----------------------------------------------------------------------------
##    $Log: AbstractExplorer.php,v $
##    Revision 1.20  2003/04/19 16:24:49  jonen
##    + added two more GUI modules to default registry initiation,
##       relating to new navigation module 'NavigationTree'
##    + added prepartion of needed args for abstract navigation tree
##       and concret UserManagment 'UMnav' tree
##
##    Revision 1.19  2003/04/18 16:21:37  joko
##    fixed commit comment - the last one caused a syntax error!!!
##
##    Revision 1.18  2003/04/18 15:27:06  joko
##    NEW: XML Trees in data area
##      new ecom module: DataTree
##      introduced new query argument: 'filter' (purpose: xml/tree filtering)
##        $filter = array(
##          dotted => $val['ecom_data_filter'],
##          ident => $val['ecom_data_ident'],
##        );
##        A Data::Lift module translates this filter-query into a XPath-query ...
##        $filter = array(
##          xpq => '*\/*[@name="cli"]',
##        );
##        ... which finally is propagated to the backend.
##    NEW: AbstractExplorer - standalone version
##      enhanced set_e_state: now can overwrite internal state to arguments from outside
##      enhanced get_com: also capable of propagating additional args through _load_ecom to _prepare_component_args
##      enhanced _prepare_component_args: now able to dispatch to a "transparent navigation ecom" (e.g. YAA::JobGroups)
##    MISC:
##      added some pre-flight checks throughout the module, especially at the core dispatcher inside _prepare_component_args
##      error checking: added some more croaks via 'user_error'
##      cosmetic updates
##
##    Revision 1.17  2003/04/18 13:46:15  jonen
##    + add hidden elements(items) now to the constructor arguments of each ecom
##
##    Revision 1.16  2003/04/10 06:00:58  joko
##    ALPHA: Item.Delete
##
##    Revision 1.15  2003/04/09 02:08:20  joko
##    CHANGE: renamed key 'classname' through 'nodename'
##
##    Revision 1.14  2003/04/09 00:31:27  jonen
##    + added arguments for data list ecom
##
##    Revision 1.13  2003/04/09 00:03:11  jonen
##    disabled form rendering for inheritanced items at 'list'
##
##    Revision 1.12  2003/04/08 17:52:12  joko
##    CHANGE: renamed property 'datasource' to 'transport'
##    NEW: Module 'RemoteAction'
##
##    Revision 1.11  2003/04/07 22:31:51  jonen
##    + added switch of ecom label (e.g. nav, chooser) at ecom type switch 'nav'
##    - removed recent added ecom type chooser
##
##    Revision 1.10  2003/04/05 20:32:04  joko
##    added Chooser
##
##    Revision 1.9  2003/04/04 02:22:37  joko
##    minor fix: querySchema now issues argument
##
##    Revision 1.8  2003/04/04 01:16:03  jonen
##    +  integrated different mode's for 'DataItem'
##
##    Revision 1.7  2003/03/29 07:49:55  joko
##    show boxes in DEBUG-mode only!
##
##    Revision 1.6  2003/03/28 06:42:37  joko
##    fix: propagating rpc-debugging-options to constants here
##
##    Revision 1.5  2003/03/27 01:24:29  jonen
##    + enabled navigation ecom (only list yet)
##
##    Revision 1.4  2003/03/20 08:02:11  jonen
##    + purged code
##
##    Revision 1.3  2003/03/20 07:54:52  jonen
##    + added docu
##
##    Revision 1.2  2003/03/20 07:44:31  jonen
##    + removed dumper
##
##    Revision 1.1  2003/03/20 03:48:46  jonen
##    + initial commit
##
##    Revision 1.1  2003/03/08 02:36:17  cvsmax
##    + moved from *.inc
##    + mungled namespace with WebExplorer
##
##    Revision 1.3  2003/03/03 22:25:21  joko
##    fixed minor typos
##    namespace mungling
##
##    Revision 1.2  2003/03/02 00:48:49  cvsmax
##    + set up gui module registry
##    - purged old/sample code
##
##    Revision 1.1  2003/03/01 22:57:32  cvsmax
##    + inital commit
##
##
##    -----------------------------------------------------------------------------
*/

/**
 * WebExplorer::AbstractExplorer - this can be simple compared to a container,
 *  which modular GUI classes can be register, manipulated and rendered...
 *
 * @author Sebastian Utz <seut@tunemedia.de>
 * @package org.netfrag.app
 * @name WebExplorer::AbstractExplorer
 */


class WebExplorer_AbstractExplorer {

 /**
  * container holds meta information of data locators
  */
 var $_data_locators = array();

 /**
  * container for registered modules
  */
 var $_module = array();

 /**
  * container holds references to each ecom
  */
 var $_ecom = array();

 /**
  * holds the whole page state
  */
 var $_state = array();

 /**
  * holds state variables only needed for explorer
  */
 var $_e_state = array();


  function WebExplorer_AbstractExplorer($data_locators=array()) {
    $this->_data_locators = $data_locators;
    $this->init_default_gui_modules();    
    $this->set_e_state();

    //debug
    //print "State: " . Dumper($this->_state) ."<br>";
    $div = html_div();
    $div->add( html_b(get_class($this)), html_hr(), "Explorer_State: " . Dumper($this->_e_state));
    $div->set_style('background: #adadad; border: 2px black groove; width:640px; padding:10px; margin:40px;');
    if (constants::get('DEBUG')) {
      print $div->render();
    }
  }


  function add_data_locator($label, $args) {
    $this->_data_locators[$label] = $args;
  }
  
  function set_data_locator($label, $new_args=array() ) {
    global $app;
    
    // pre-flight checks
    if (!$label) {
      user_error("AbstractExplorer::set_data_locator - label was empty.");
      return;
    }
    
    if ($label == "rpc") {
      $rpcinfo = $app->getConfig("rpcinfo");
      define('RPC_HOSTNAME', $rpcinfo[Host]);
      define('RPC_PORT', $rpcinfo[Port]);
      define('RPC_DEBUG', $rpcinfo[DEBUG]);
      define('RPC_TRACE', $rpcinfo[TRACE]);
      define('RPC_DISCONNECT_ON_ERROR', $rpcinfo[DISCONNECT_ON_ERROR]);
    } else {
      user_error("AbstractExplorer::set_data_locator - Could not dispatch data_locator_key label '$label'!");
    }
  }
  
  function get_data_locator($label) {
  }

  function get_page_state() {
    $requestTracker = mkObject("Application::Request::Tracker");
    //print Dumper($this->_state);
    $this->_state = $requestTracker->getPointer();
  }
  
  function set_e_state($state = null) {
    // NEW [2003-04-18]: now has two modes
    // 1. inject page state from argument passed to us
    // 2. (was) get page state from request tracker
    if ($state) {
      $this->_e_state = $state;
    } else {
      $this->get_page_state();
      $this->_e_state = $this->_state[options][options];
    }
    //  print "Setting Explorer state:" . Dumper($this->_e_state);
  }

  function set_page_state() {
    user_error("AbstractExplorer::set_page_state - please implement me....");    
  }

  function init_default_gui_modules() {
    
    // format of parameters: label, ecom_type, abstract_type, module_name
    
    // 2003-03-02 - First ecom modules/components
    //$this->register_gui_module("n_tree", "nav", array( 'name' => "NavigationTree", 'type' => "tree") );
    $this->register_gui_module("nav", "nav", "list", "WebExplorer::Module::NavigationList" );
    $this->register_gui_module("content", "data", "list", "WebExplorer::Module::DataList" );
    $this->register_gui_module("content", "data", "item", "WebExplorer::Module::DataItem" );
    
    // 2003-04-05 - Chooser (a Nav.List)
    $this->register_gui_module("chooser", "nav", "list", "WebExplorer::Module::Chooser");
    
    // 2003-04-07 - RemoteAction
    $this->register_gui_module("phase_startup", "call", "auto", "WebExplorer::Module::RemoteAction");
    
    // 2003-04-09 - Data.Item: DeleteAction
    $this->register_gui_module("phase_startup", "data", "item", "WebExplorer::Module::DataItem");
    //$this->register_gui_module("phase_startup", "data", "auto", "WebExplorer::Module::RemoteAction");
    //$this->register_gui_module("phase_startup", "data", "auto", "WebExplorer::Module::DataItem");
    
    // 2003-04-12 - Data.Tree
    $this->register_gui_module("content", "data", "tree", "WebExplorer::Module::DataTree" );
    
    // 2003-04-18 - Nav.Tree
    $this->register_gui_module("nav", "nav", "tree", "WebExplorer::Module::NavigationTree" );

    // 2003-04-18 - UserManagment Nav.Tree (we need only a different 'label' as Nav.Tree yet..)
    $this->register_gui_module("UMnav", "nav", "tree", "WebExplorer::Module::NavigationTree" );

  }

  function register_source_module($label, $args) {
    $this->_module['source'][$label] = $args;
  }
  
  function register_gui_module($label, $ecom_type, $abstract_type, $module_name) {
    $this->_module['gui'][$label][$ecom_type][$abstract_type] = $module_name;
  }


  function &get_ecom($label, $args = array()) {
    
    // the very first - strongly hardcoded - Hello World ecom
    //return "Hello World";
    
    // that's better ...
    $this->_load_ecom($label, $args);
    return $this->_ecom[$label];
    
  }

  
  function _load_ecoms() {
    //trace("_load_ecoms: " . Dumper($this->_e_state[ecoms]) . "<br/>");
    foreach($this->_e_state[ecoms] as $label => $val) {
      $this->_load_ecom($label);
    }
  }


  function _load_ecom($label, $args = array()) {
    
    // fetch values from state
    $val = $this->_e_state['ecoms'][$label];
    debug::info("_load_ecom($label): " . Dumper($val) . "<br/>");

    // NEW [2003-04-10]: ecom-RESET-condition
    if (!is_array($val) && $val == 'RESET') {
      debug::info("Resetting component: $label");
      return;
    }

    // find right ecom gui module
    $ecom_type = $val['ecom_type'];
    $abstract_type = $val['ecom_abstract_type'];
    $gui_module = $this->_module['gui'][$label][$ecom_type][$abstract_type];
    //print Dumper($gui_module);
    if(!$gui_module) {
      user_error("_load_ecom: No GUI module found for [label='$label', ecom type='$val[ecom_type]', abstract type='$val[ecom_abstract_type]'].");
      return;
    }

    // get arguments needed for ecom gui module
    $args = $this->_prepare_component_args($label, $args);
    
    // trace
    //print "raw-args: " . Dumper($args) . "<br/>";
    
    // get ecom GUI module
    if (!$ecom = php::mkComponent($gui_module, $args)) {
      user_error("AbstractExplorer::_load_component - Error while instantiating ecom gui component. [label='$label', abstract type='$val[ecom_abstract_type]', ecom type='$val[ecom_type]']");
      return;
    }
    //print Dumper($ecom);
    
    // NEW[2003-04-18] done via args(prepare args!) passed at constructor
    //  (needed for non-real objects instanced at some child of AbstractGUIModule, eg. NavigationList)
/*
    // add hidden vars, needed for explorer control
    $hidden_items = $this->_get_hidden_items($label);
    if(is_array($hidden_items) ) {
      $ecom->add_hidden_items($hidden_items);
      print "Hidden: " . Dumper($hidden_items);
    }
*/

    // load phphtmllib GUI object 
    $gui_ecom = &$ecom->get();

    // attempt:
    //$gui_ecom->make_transparent();
    
    // store phphtmllib GUI object 
    $this->_ecom[$label] = &$gui_ecom;
  }


  function _get_hidden_items($label) {
    $ecom_state = $this->_e_state['ecoms'][$label];
    if($ecom_state['ecom_type'] == "data") {
      if($ecom_state['ecom_abstract_type'] == "list") {
        $hidden_items = array(
                                  'ecl' => $label,
                                  'ecat' => "item",
                                  'ecmod' => "view",
                                  'ecdm' => $ecom_state['ecom_data_ident'],
                                  );
      }
      elseif($ecom_state['ecom_abstract_type'] == "item") {
        $hidden_items = array(
                                  'ecl' => $label,
                                  'ecat' => "item",
                                  'ecmod' => "view",
                                  );
      }
    }
    elseif($ecom_state['ecom_type'] == "nav") {
      // Switching abstract make no real sense here,
      // because hidden_items(link_vars) for Naviagtion-Ecoms
      // are more label specified!!
      // OLD:
      //if($ecom_state['ecom_abstract_type'] == "list") {
      // NEW:
      if($label == "nav") {
        $hidden_items = array(
                                  'ecl' => "content",
                                  'ecat' => "list",
                                  'ecmod' => "view",
                                  'ect' => "data",
                                  'ecdlk' => "rpc",
                                 );

      }
      elseif($label == "chooser") {
        $hidden_items = array(
                                  'ecl' => "phase_startup",
                                  'ecdlk' => "rpc",
                                 );

      }
    }
      // add page idents
      foreach($this->_e_state[idents] as $label => $value) {
        $hidden_items[$label] = $value;
      }
    return $hidden_items;
  }


  function _prepare_component_args($label, $args = array()) {    
    $val = $this->_e_state['ecoms'][$label];

    // pre-flight checks
    if (!$val['ecom_data_locator_key']) {
      user_error("_prepare_component_args: Key 'ecom_data_locator_key' was empty, should be one of 'rpc'.");
      return;
    }

    if (!$val['ecom_type']) {
      user_error("WebExplorer::AbstractExplorer: Key 'ecom_type' was empty, should be one of 'data|nav|call'.");
    }

    if (!$val['ecom_abstract_type']) {
      user_error("_prepare_component_args: Key 'ecom_abstract_type' was empty, should be one of 'item|list|tree|auto'.");
      return;
    }

    // trace
    //print "YAI1<br/>";
    //print Dumper($val);
    
    $this->set_data_locator($val['ecom_data_locator_key']);

    // detect and execute 'selectSource' action
    // FIXME: this is a HACK!!! move to a module 'BackendAction' or s.th.l.th.
    //print Dumper($this->_e_state['sources']);
    if ($source = $this->_e_state['main']['ecom_data_source_key']) {
      //print "selectSource: $source<br/>";
      //global $app;
      //print Dumper($backend);
      //$app->backend->do();
    }
    
    // switch component type
    if($val['ecom_type'] == "data") {
      // switch abstract type
      if($val['ecom_abstract_type'] == "list") {
        if($val['ecom_data_locator_key'] == "rpc") {
          //$data_locator_meta = array( transport => 'rpc', metatype => 'data', vartype => 'objects', nodename => $val['ecom_data_ident']);
          $data_locator_meta = array( transport => 'rpc', metatype => 'data', abstract_type => 'list', nodename => $val['ecom_data_ident'], list_meta => $val['ecom_data_meta']);
        } else {
          user_error("AbstractExplorer::_prepare_component_args - Cannot build query for data_locator_key $val[ecom_data_locator_key] !");
        }
        $args = array(
                      'caption' => $val['ecom_data_ident'],
                      'orderby' => "Guid",
                      'options' => array( 
                                          'data_locator_meta' => $data_locator_meta,
                                          'decode' => 1,
                                          'decode_args' => array(
                                              'seperator' => "_",
                                              //'form' => 1,
                                              ),
                                          'actionbar' => array(
                                              'name' => "ecdfa",
                                              'list' => array(
                                                  "View" => 'view',
                                                  "Edit" => 'edit',
                                                  "Delete" => 'delete',
                                                  ),
                                              'selected' => 'view',
                                              'create' => array( 
                                                   'name' => "ecdfcr",
                                                   'value' => "Add new"
                                                   ),
                                              ),
                                          'parent' => array(
                                              'class' => $val['ecom_data_ident'],
                                              ),
                                          ),
                      );
      
      // switch abstract type
      } elseif ($val['ecom_abstract_type'] == "item") {
        if($val['ecom_data_locator_key'] == "rpc") {
          //$data_locator_meta = array( transport => 'rpc', metatype => 'data', vartype => 'objects', nodename => $val['ecom_data_ident']);
          
          // NEW: 'filter' - 2003-04-14 - required for filtering xml-nodes
          // this propagates the full identifier to reach through all parent nodes
          $filter = array( 
            dotted => $val['ecom_data_filter'],
            ident => $val['ecom_data_ident'],
            //xpq => '*/*[@name="cli"]',
            //xpq => '*/*',
          );
          // lift filter from dotted format to xpq format
          $lift = mkObject('Data::Lift', $filter, array( metatype => 'filter' ) );
          $filter = $lift->to('XPath');

          $data_locator_meta = array( 
            transport => 'rpc', metatype => 'data', abstract_type => 'item', 
            ident => $val['ecom_data_ident'], nodename => $val['ecom_data_meta'], filter => $filter,
          );
        } else {
          user_error("AbstractExplorer::_prepare_component_args - Cannot build query for data_locator_key $val[ecom_data_locator_key] !");
        }
        
        // defaults
        if (!$val['ecom_mode']) { $val['ecom_mode'] = "view"; }
        //$val['ecom_mode'] = "view";
        
        // debugging
        print "Mode: $val[ecom_mode]<br>";
        
        // prepare some arguments...
        $args = array(
                      'caption' => $val['ecom_data_meta'],
                      'mode' => $val['ecom_mode'],
                      'options' => array( 
                                            'data_locator_meta' => $data_locator_meta,
                                            'decode' => 1,
                                            'decode_args' => array(
                                              'seperator' => "_",
                                              ),
                                            'parent' => array(
                                                'guid' => $val['ecom_data_ident'],
                                                'class' => $val['ecom_data_meta'],
                                                ),
                                            ),
                      );
         if ($val['ecom_mode'] == "edit") { $args['adapter'] = 'FormProcessor'; }
         
         // FIXME: (see WebExplorer::Module::AbstractGUIModule)
         //if ($val['ecom_mode'] == "delete") { $args['adapter'] = 'GenericNegotiation'; }
         if ($val['ecom_mode'] == "delete") { 
           $args['adapter'] = 'NonValidatingFormProcessor';
         }

         if ($val['ecom_mode'] == "create") { 
           $args['adapter'] = 'FormProcessor';
           $args['options']['caption'] = $val['ecom_data_ident'];
           $args['options']['data_locator_meta']['action'] = 'create';
           print "debug 'create': " . Dumper($val);
           if($val['ecom_data_meta_x']) {
             unset($args['options']['data_locator_meta']['nodename']);
             $args['options']['data_locator_meta']['parent'][guid] = $val['ecom_data_meta'];
             $args['options']['data_locator_meta']['parent'][nodename] = $val['ecom_data_meta_x'];
           }
         }
         
      // switch abstract type
      } elseif ($val['ecom_abstract_type'] == "tree") {
        //print "TREE!<br/>";
        
        // FIXME: shouldn't this (dispatching by transport-key) be done very *outside* of this scope?
        // or: do it outside per default, let a possibility to modify it inside the lower levels of the dispatcher (here)
        if ($val['ecom_data_locator_key'] == "rpc") {
          //$data_locator_meta = array( transport => 'rpc', metatype => 'data', vartype => 'objects', nodename => $val['ecom_data_ident']);
          $args[options][data_locator_meta] = array( transport => 'rpc', metatype => 'data', abstract_type => 'tree', ident => $val['ecom_data_ident'], nodename => $val['ecom_data_meta']);
        }

      } else {
        user_error("_prepare_component_args: Could not dispatch ecom_abstract_type='$val[ecom_abstract_type]'.");
        
      }
    
    // switch component type
    } elseif ($val['ecom_type'] == "nav") {
      
      // switch abstract type
      // list
      if ($val['ecom_abstract_type'] == "list") {
       $args = array();
        if($val['ecom_data_locator_key'] == "rpc") {
          
          // switch component label
          // TODO: should we really dispatch by label inside here?
          
          if ($label == "nav") {
            $data_locator_meta = array( transport => 'rpc', metatype => 'schema', filter => 'nodes.root:concrete' );
            $args['caption'] = "Objekt Typen";
          }
          // NEW [2003-04-05]: DataSource.Chooser
          elseif ($label == "chooser") {
            $data_locator_meta = array( transport => 'rpc', metatype => 'schema', filter => 'sources.all' );
            $args['caption'] = "Datenquellen";
          }
          // NEW [2003-04-18]: croak if label empty
          else {
            user_error("_prepare_component_args: Dispatching for nav.list.rpc failed. \$label was empty.");
          }
          $args['options']['data_locator_meta'] = $data_locator_meta;
          
        } else {
          user_error("AbstractExplorer::_prepare_component_args - Cannot build schema query for data_locator_key $val[ecom_data_locator_key] !");
        }
      
      // NEW [2003-04-18]: Abstract navigation tree
      } elseif ($val['ecom_abstract_type'] == "tree") {
        $args = array();
        if($label == "nav") {
          //$args[options][data_locator_meta] = array( transport => 'rpc', metatype => 'schema', abstract_type => 'tree', ident => $val['ecom_data_ident'], nodename => $val['ecom_data_meta']);
          $args[options][data_locator_meta] = array( transport => 'rpc', metatype => 'schema', filter => 'nodes.root:concrete' );
          $args['caption'] = $val['ecom_data_source_key'];
        } elseif($label == "UMnav") {
          //$args[options][data_locator_meta] = array( transport => 'rpc', metatype => 'schema', abstract_type => 'tree', ident => $val['ecom_data_ident'], nodename => $val['ecom_data_meta']);
          $args[options][data_locator_meta] = array( transport => 'rpc', metatype => 'method', method => 'UserManagmentSchema' );
          $args['caption'] = "Benutzerverwaltung";
        }

      // NEW [2003-04-18]: transparent nav - argument pass-through mode
      } elseif ($val['ecom_abstract_type'] == "transparent") {
        
        // You are responsible for all arguments passed through.
        // Where are these arguments from?
        // They are propagated transparently to this place from a new optional
        // parameter ($args) introduced for the methods 'get_com', 'load_com'
        // and '_prepare_component_args' (this one).
        // This means full control over ecoms from outside.
        
        // TODO: maybe add some additional pre-flight checks here!?
      
      // croak
      } else {
        user_error("_prepare_component_args: Could not dispatch ecom_abstract_type='$val[ecom_abstract_type]'.");
      }

    // NEW [2003-04-08]: RemoteAction (e.g.: result of a selection inside a Chooser)
    // switch component type
    } elseif ($val['ecom_type'] == "call") {

      // responses of RemoteActions are not predictable!
      if ($val['ecom_abstract_type'] == "auto") {
        
        // Dispatching by $label is not done here. RemoteAction-ecoms can appear anywhere!

        // Just define the RemoteQuery using a declaration to use DataSource::Generic most transparently.
        // Really - just a remote call is issued, no data-/schema-structures or similar are expected.
        
        // The RemoteMethod 'method' is called directly with arguments in 'args'!
        // As response (important for widget assignement!) you may expect an arbitrary payload.
        $args['options']['data_locator_meta'] = array( 
          transport => 'rpc', 
          metatype => 'method', 
          method => $val['ecom_call_method'], 
          args => $val['ecom_call_args']
        );
        
      } else {
        // FIXME: implement automatic re-dispatching to available ecoms here!
        user_error("WebExplorer::AbstractExplorer: results of RemoteActions can only be handled automatically. Who knows what comes back?");
      }      
    
    }

    // NEW[2003-04-18]: add hidden items to args
    $args['hidden_elements'] = $this->_get_hidden_items($label);

    return $args;
  }


  function get_msg($label) {
    if($label == "welcome") {
      $msg = "Welcome to the Explorer.";
    }
    return $msg;
  }


  function render() {
    user_error("AbstractExplorer::render - please implement me....");
  }

}


?>
MailToCvsAdmin">MailToCvsAdmin	ViewVC Help
Powered by ViewVC 1.1.26