org.netfrag.glib/DataSource/Locator.php

<?php
/**
 * This file contains the DataSource::Locator class.
 *
 * It acts as a container for DataSource connection 
 * metadata. Think of it as an enhanced dsn.
 *
 * It gets used by DataSource::Generic
 * to be informed about the most important stuff it
 * has to do.
 *
 * @author Andreas Motl <andreas.motl@ilo.de>
 * @package org.netfrag.glib
 * @name DataSource::Locator
 *
 *
 */


/**
 * <b>Cvs-Log:</b>
 *
 * <pre>
 * $Id: Locator.php,v 1.17 2003/03/11 02:34:55 joko Exp $
 *
 * $Log: Locator.php,v $
 * Revision 1.17  2003/03/11 02:34:55  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.16  2003/03/11 02:28:12  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.15  2003/03/11 02:23:03  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.14  2003/03/11 02:14:24  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.13  2003/03/11 02:04:37  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.12  2003/03/11 01:10:00  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.11  2003/03/11 00:12:49  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.10  2003/03/10 23:25:03  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.9  2003/03/10 22:31:55  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.8  2003/03/09 15:50:36  joko
 * + additional metadata for Autodia
 *
 * Revision 1.7  2003/03/05 17:13:16  joko
 * updated docu (phpDocumentor testing....)
 *
 * Revision 1.6  2003/03/05 16:10:08  joko
 * updated docu (phpDocumentor testing....)
 *
 * Revision 1.5  2003/03/05 15:40:39  joko
 * updated docu (phpDocumentor testing....)
 *
 * Revision 1.4  2003/03/05 15:26:23  joko
 * updated docu (phpDocumentor testing....)
 *
 * Revision 1.3  2003/03/05 15:21:54  joko
 * updated docu (phpDocumentor testing....)
 *
 * Revision 1.2  2003/03/05 15:01:10  joko
 * updated docu
 *
 * Revision 1.1  2003/03/05 12:04:37  joko
 * + initial commit
 * </pre>
 *
 *
 */

/**
 * It helps DataSource::Generic working in different "operation modes".
 *
 * <p>
 * <b>Modes:</b> (these are proposals, more or less...)
 * o Pass-Through-Reference: php Object will get passed through all layers
 * o Pass-Through-Memory: reference to a memory area will get used
 * + Build-Locator: build locator from datasource-type and adapter-type
 * o Use-Locator: directly use DataSource::Locator instance passed in
 * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
 * o Build-AutoLocator: use global constants making up our metadata
 * </p>
 *
 * <b>It can/should contain:</b>
 * (flexible, just some parameters are required for each operation mode)
 * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
 * + (x) name of a Proxy module to use to *wrap/hide* the connection/transport-layer
 *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)
 * + (x) metadata (a hash) directly describing *where* to connect to (e.g. 'Host', 'Port')
 * o an instance of an already instantiated arbitrary datasource handler (e.g. 'source')
 *   this will get propagated (pass-through-mode)
 * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')
 *   this will be mapped to a module name and used as a *Proxy* 
 *   by the DataSource::Generic at runtime
 * + (x) an adapter-type (of 'phpHtmlLib|pear')
 *   this will be mapped to a module name and used as an *Adapter*
 *   by the DataSource::Generic at runtime
 * o names of global constants where to find these informations
 * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')
 *
 * <b>It can do:</b>
 * - builds a larger locator from a minimum of information passed in via constructor-arguments
 * - direct fallback mode to some predefined constant names if locator is empty and above method fails
 * - direct fallback mode to some predefined values if just *everything* fails
 *
 * <b>How to use?</b>
 *
 * Pass an array holding "locator metadata" to the constructor.
 * This module takes care of the rest.
 * Pass an array to the constructor: (e.g.)
 *
 * <pre>
 *  1. for doing rpc-calls....
 *    <code>
 *    $locator = array(
 *      datasource_type => 'rpc',
 *      [adapter_type => 'phpHtmlLib',]
 *      metadata => array( Host => 'localhost', Port => '8765' ),
 *    );
 *    $source = ne w DataSource::Generic($locator);
 *    $this->set_data_source( &$source );
 *    </code>
 *
 *  2. [proposal] for common/oldschool datahandles....
 *    <code>
 *    $locator = array(
 *      dsn => 'known dsn markup',
 *    );
 *    $source = ne w DataSource::Generic($locator);
 *    $this->set_data_source( &$source );
 *    </code>
 * </pre>
 *
 *
 *
 * @author Andreas Motl <andreas.motl@ilo.de>
 * @link http://www.netfrag.org/~joko/
 * @copyright (c) 2003 - All Rights reserved.
 *
 * @license GNU LGPL (GNU Lesser General Public License)
 * @link http://www.gnu.org/licenses/lgpl.txt
 *
 * @package org.netfrag.glib
 * @subpackage DataSource
 * @name DataSource::Locator
 *
 */
class DataSource_Locator {

  /**
    * This var holds the locator metadata hash,
    *
    * which is built from some predefined rules
    * using metadata from $_options and some
    * other presets.
    *
    * {@see build}, which acts as a dispatcher
    * depending on $_options[datasource]. (main dispatching level)
    *
    * <p>
    *
    * The structure of a full blown locator looks like this:
    *
    * <code>
    *  $locator = array(
    *    type => '<your type specifying the datasource-type>',
    *    metadata => array(
    *       ... your arbitrary deep metadata structure ...
    *    ),
    *    [dsn => '<your dsn markup>'],
    *  );
    * </code>
    *
    * Example 1 - data is inside a rdbms, using a dsn to connect to it:
    * <code>
    *  $locator = array(
    *    dsn => 'mysql://username:password@localhost/database',
    *  );
    * </code>
    *
    * Example 2 - data is inside an odbms, reachable by doing remote procedure calls (rpc):
    * <code>
    *  $locator = array(
    *    type => 'rpc',
    *    metadata => array(
    *      package => 'Data::Driver::Proxy',
    *      Host => 'localhost',
    *      Port => '8765',
    *    )
    *  );
    * </code>
    *
    * </p>
    *
    * @deprecated
    *
    */
    var $_locator_metadata = NULL;


   /**
    * This var holds the arguments passed in to the constructor.
    * We will try to build full blown locator metadata information from that.
    *
    * @deprecated
    *
    */
    var $_in = NULL;

   /**
    * This var holds the locator metadata informations inside
    * a single hash. This is returned from '->get()'.
    *
    * @deprecated
    *
    */
    var $_out = NULL;


        /**
         * Locator metadata.
         *
         */

    // name of a Proxy module
    var $_datasource_type;
    
    // name of an Adapter module
    var $_adapter_type;
    
    // additional information required (passed on to the Proxy by DataSource::Generic)
    var $_metadata = array();
    
    //var $_dsn;
    

        /**
         * The constructor is used to pass in the
         * locator metadata hash.
         *
         * @param object(DataSource::Locator)|hash optional: a &$locator instance
         */
        function DataSource_Locator() {
      $args_multi = func_get_args();
      
      //php::array_shrink($args_multi);

      //print Dumper($args_multi);
      //exit;

      foreach ($args_multi as $args) {
        if (isset($args)) {
          $this->merge_args($args);
        }
      }

      $this->build();
      //$this->check();
        }
        
        function merge_args(&$args) {
          
          //print "args: " . Dumper($args);
          
                // check if passed in locator is already of type *me* ...
                // ... if so, merge it into current instance
                if (is_object($args) && get_class($args) == get_class($this)) {
                  $this->merge_to($this, $args);

                } else {
                
        // FIXME: handle locator merging here?
        //$this->_arguments = &$args;
        
        // FIXME: to php::merge_to($this, $locator) here!!!
        //$this->_data
        // for now: assume plain hash, so just iterate and overwrite!
        $this->merge_to($this, $args, '_');

      }
        }
        
        function merge_to(&$target, $source, $prefix_key = '') {

      //print "target: " . Dumper($target);
      //print "source: " . Dumper($source);

      // pre-flight checks
        if (!isset($target)) {
          user_error("variable passed as reference (merge target) is not set.");
          return;
        }
        //if (!is_hash($hash)) {
        if (!isset($source)) {
          user_error("variable passed as source is not set.");
          return;
        }

      // perform merge
        foreach ($source as $key => $val) {
          $name = $prefix_key . $key;
          if (is_object($target)) {
            $target->$name = $val;
          //} elseif (php::is_hash($target)) {
          } else {
            $target[$name] = $val;
          }
        }

      // indicate good
        return 1;

        }
        
        /**
     * Set the locator metadata hash we will feed *partly*
     * to an encapsulated Data::Driver::Proxy instance
     *
     * @param LocatorMetadataHash array - 
     *
     */
    function set( &$locator ) {
        $this->_out = &$locator;
    }

    function &get_metadata() {
        //return ($this->_out);
        return $this->_metadata;
    }


  function build( ) {
    
    // trace
      //print Dumper($this);
    
    $good = 0;
    switch ($this->_datasource_type) {
      case 'rpc':
        // get rpc connection information from global constants
        $metadata = array(
          //package => 'Data::Driver::Proxy',
          //package => 'DataSource::Proxy::XMLRPC',
          //package => 'DataSource::Generic',
          //package => 'DesignPattern::RemoteProxy',
          Host => RPC_HOSTNAME,
          Port => RPC_PORT,
        );
        $good = 1;
        break;
    }
    
    if ($good) {
      
      // V1:
      /*
      $this->_out = array(
        datasource_type => $datasource,
        adapter_type => 'Data',
        metadata => $metadata,
      );
      */

      // V2:
      //$this->_out = $metadata;
      
      // V3:
      $this->merge_to($this->_metadata, $metadata);
      
    }

    // trace
      //print Dumper($this);

  }
  
  function check() {  
    if (!sizeof($this->_metadata)) {
      user_error("DataSource::Locator::check() failed: " . "Locator metadata not established, please check configuration options.");
      return;
    }
    return 1;
  }

    
}

?>
1	joko	1.1	<?php
2			/**
3	joko	1.2	* This file contains the DataSource::Locator class.
4	joko	1.1	*
5			* It acts as a container for DataSource connection
6			* metadata. Think of it as an enhanced dsn.
7			*
8	joko	1.3	* It gets used by DataSource::Generic
9	joko	1.1	* to be informed about the most important stuff it
10			* has to do.
11			*
12	joko	1.5	* @author Andreas Motl <andreas.motl@ilo.de>
13	joko	1.1	* @package org.netfrag.glib
14	joko	1.7	* @name DataSource::Locator
15			*
16			*
17	joko	1.10	*/
18
19
20			/**
21	joko	1.7	* <b>Cvs-Log:</b>
22	joko	1.1	*
23	joko	1.7	* <pre>
24	joko	1.18	* $Id: Locator.php,v 1.17 2003/03/11 02:34:55 joko Exp $
25	joko	1.2	*
26			* $Log: Locator.php,v $
27	joko	1.18	* Revision 1.17 2003/03/11 02:34:55 joko
28			* + fixed metadata for phpDocumentor
29			*
30	joko	1.17	* Revision 1.16 2003/03/11 02:28:12 joko
31			* + fixed metadata for phpDocumentor
32			*
33	joko	1.16	* Revision 1.15 2003/03/11 02:23:03 joko
34			* + fixed metadata for phpDocumentor
35			*
36	joko	1.15	* Revision 1.14 2003/03/11 02:14:24 joko
37			* + fixed metadata for phpDocumentor
38			*
39	joko	1.14	* Revision 1.13 2003/03/11 02:04:37 joko
40			* + fixed metadata for phpDocumentor
41			*
42	joko	1.13	* Revision 1.12 2003/03/11 01:10:00 joko
43			* + fixed metadata for phpDocumentor
44			*
45	joko	1.12	* Revision 1.11 2003/03/11 00:12:49 joko
46			* + fixed metadata for phpDocumentor
47			*
48	joko	1.11	* Revision 1.10 2003/03/10 23:25:03 joko
49			* + fixed metadata for phpDocumentor
50			*
51	joko	1.10	* Revision 1.9 2003/03/10 22:31:55 joko
52			* + fixed metadata for phpDocumentor
53			*
54	joko	1.9	* Revision 1.8 2003/03/09 15:50:36 joko
55			* + additional metadata for Autodia
56			*
57	joko	1.8	* Revision 1.7 2003/03/05 17:13:16 joko
58			* updated docu (phpDocumentor testing....)
59			*
60	joko	1.7	* Revision 1.6 2003/03/05 16:10:08 joko
61			* updated docu (phpDocumentor testing....)
62			*
63	joko	1.6	* Revision 1.5 2003/03/05 15:40:39 joko
64			* updated docu (phpDocumentor testing....)
65			*
66	joko	1.5	* Revision 1.4 2003/03/05 15:26:23 joko
67			* updated docu (phpDocumentor testing....)
68			*
69	joko	1.4	* Revision 1.3 2003/03/05 15:21:54 joko
70			* updated docu (phpDocumentor testing....)
71			*
72	joko	1.3	* Revision 1.2 2003/03/05 15:01:10 joko
73			* updated docu
74			*
75	joko	1.2	* Revision 1.1 2003/03/05 12:04:37 joko
76			* + initial commit
77	joko	1.7	* </pre>
78	joko	1.1	*
79			*
80			*/
81
82			/**
83	joko	1.3	* It helps DataSource::Generic working in different "operation modes".
84	joko	1.1	*
85	joko	1.18	* <p>
86	joko	1.13	* <b>Modes:</b> (these are proposals, more or less...)
87	joko	1.7	* o Pass-Through-Reference: php Object will get passed through all layers
88			* o Pass-Through-Memory: reference to a memory area will get used
89	joko	1.11	* + Build-Locator: build locator from datasource-type and adapter-type
90	joko	1.7	* o Use-Locator: directly use DataSource::Locator instance passed in
91			* o Merge-Locators: merge metadata of two or more DataSource::Locator instances
92			* o Build-AutoLocator: use global constants making up our metadata
93	joko	1.18	* </p>
94	joko	1.7	*
95	joko	1.4	* <b>It can/should contain:</b>
96			* (flexible, just some parameters are required for each operation mode)
97	joko	1.7	* o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
98	joko	1.11	* + (x) name of a Proxy module to use to wrap/hide the connection/transport-layer
99	joko	1.2	* (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)
100	joko	1.11	* + (x) metadata (a hash) directly describing where to connect to (e.g. 'Host', 'Port')
101	joko	1.7	* o an instance of an already instantiated arbitrary datasource handler (e.g. 'source')
102	joko	1.2	* this will get propagated (pass-through-mode)
103	joko	1.7	* o a datasource-type (of 'rpc\|mysql\|csv-file\|xml-file')
104	joko	1.2	* this will be mapped to a module name and used as a Proxy
105	joko	1.3	* by the DataSource::Generic at runtime
106	joko	1.11	* + (x) an adapter-type (of 'phpHtmlLib\|pear')
107	joko	1.2	* this will be mapped to a module name and used as an Adapter
108	joko	1.3	* by the DataSource::Generic at runtime
109	joko	1.7	* o names of global constants where to find these informations
110			* o datasource-type ('rpc\|csv-file\|...') <-> datasource-family ('orm\|rdbms\|odbms')
111	joko	1.1	*
112	joko	1.14	* <b>It can do:</b>
113	joko	1.10	* - builds a larger locator from a minimum of information passed in via constructor-arguments
114			* - direct fallback mode to some predefined constant names if locator is empty and above method fails
115			* - direct fallback mode to some predefined values if just everything fails
116	joko	1.1	*
117	joko	1.4	* <b>How to use?</b>
118	joko	1.1	*
119			* Pass an array holding "locator metadata" to the constructor.
120			* This module takes care of the rest.
121			* Pass an array to the constructor: (e.g.)
122			*
123	joko	1.17	* <pre>
124	joko	1.1	* 1. for doing rpc-calls....
125	joko	1.5	* <code>
126	joko	1.1	* $locator = array(
127			* datasource_type => 'rpc',
128			* [adapter_type => 'phpHtmlLib',]
129			* metadata => array( Host => 'localhost', Port => '8765' ),
130			* );
131	joko	1.8	* $source = ne w DataSource::Generic($locator);
132	joko	1.1	* $this->set_data_source( &$source );
133	joko	1.5	* </code>
134	joko	1.1	*
135			* 2. [proposal] for common/oldschool datahandles....
136	joko	1.5	* <code>
137	joko	1.1	* $locator = array(
138			* dsn => 'known dsn markup',
139			* );
140	joko	1.8	* $source = ne w DataSource::Generic($locator);
141	joko	1.1	* $this->set_data_source( &$source );
142	joko	1.5	* </code>
143	joko	1.17	* </pre>
144	joko	1.1	*
145			*
146			*
147			* @author Andreas Motl <andreas.motl@ilo.de>
148	joko	1.2	* @link http://www.netfrag.org/~joko/
149	joko	1.1	* @copyright (c) 2003 - All Rights reserved.
150	joko	1.2	*
151	joko	1.1	* @license GNU LGPL (GNU Lesser General Public License)
152	joko	1.2	* @link http://www.gnu.org/licenses/lgpl.txt
153	joko	1.1	*
154	joko	1.7	* @package org.netfrag.glib
155			* @subpackage DataSource
156	joko	1.2	* @name DataSource::Locator
157	joko	1.1	*
158			*/
159			class DataSource_Locator {
160
161			/**
162	joko	1.16	* This var holds the locator metadata hash,
163			*
164	joko	1.1	* which is built from some predefined rules
165			* using metadata from $_options and some
166			* other presets.
167			*
168	joko	1.18	* {@see build}, which acts as a dispatcher
169	joko	1.16	* depending on $_options[datasource]. (main dispatching level)
170	joko	1.1	*
171	joko	1.17	* <p>
172			*
173	joko	1.1	* The structure of a full blown locator looks like this:
174			*
175	joko	1.5	* <code>
176	joko	1.1	* $locator = array(
177			* type => '<your type specifying the datasource-type>',
178			* metadata => array(
179			* ... your arbitrary deep metadata structure ...
180			* ),
181			* [dsn => '<your dsn markup>'],
182			* );
183	joko	1.5	* </code>
184	joko	1.1	*
185			* Example 1 - data is inside a rdbms, using a dsn to connect to it:
186	joko	1.5	* <code>
187	joko	1.1	* $locator = array(
188			* dsn => 'mysql://username:password@localhost/database',
189			* );
190	joko	1.5	* </code>
191	joko	1.1	*
192			* Example 2 - data is inside an odbms, reachable by doing remote procedure calls (rpc):
193	joko	1.5	* <code>
194	joko	1.1	* $locator = array(
195			* type => 'rpc',
196			* metadata => array(
197			* package => 'Data::Driver::Proxy',
198			* Host => 'localhost',
199			* Port => '8765',
200			* )
201			* );
202	joko	1.5	* </code>
203	joko	1.17	*
204			* </p>
205	joko	1.5	*
206			* @deprecated
207	joko	1.1	*
208			*/
209	joko	1.5	var $_locator_metadata = NULL;
210	joko	1.1
211
212	joko	1.5	/**
213			* This var holds the arguments passed in to the constructor.
214			* We will try to build full blown locator metadata information from that.
215			*
216			* @deprecated
217			*
218			*/
219			var $_in = NULL;
220
221			/**
222			* This var holds the locator metadata informations inside
223			* a single hash. This is returned from '->get()'.
224			*
225			* @deprecated
226			*
227			*/
228			var $_out = NULL;
229	joko	1.1
230
231			/**
232			* Locator metadata.
233			*
234			*/
235
236			// name of a Proxy module
237			var $_datasource_type;
238
239			// name of an Adapter module
240			var $_adapter_type;
241
242	joko	1.3	// additional information required (passed on to the Proxy by DataSource::Generic)
243	joko	1.1	var $_metadata = array();
244
245			//var $_dsn;
246
247
248			/**
249			* The constructor is used to pass in the
250			* locator metadata hash.
251			*
252	joko	1.6	* @param object(DataSource::Locator)\|hash optional: a &$locator instance
253	joko	1.1	*/
254			function DataSource_Locator() {
255			$args_multi = func_get_args();
256
257			//php::array_shrink($args_multi);
258
259			//print Dumper($args_multi);
260			//exit;
261
262			foreach ($args_multi as $args) {
263			if (isset($args)) {
264			$this->merge_args($args);
265			}
266			}
267
268			$this->build();
269			//$this->check();
270			}
271
272			function merge_args(&$args) {
273
274			//print "args: " . Dumper($args);
275
276			// check if passed in locator is already of type me ...
277			// ... if so, merge it into current instance
278			if (is_object($args) && get_class($args) == get_class($this)) {
279			$this->merge_to($this, $args);
280
281			} else {
282
283			// FIXME: handle locator merging here?
284			//$this->_arguments = &$args;
285
286			// FIXME: to php::merge_to($this, $locator) here!!!
287			//$this->_data
288			// for now: assume plain hash, so just iterate and overwrite!
289			$this->merge_to($this, $args, '_');
290
291			}
292			}
293
294			function merge_to(&$target, $source, $prefix_key = '') {
295
296			//print "target: " . Dumper($target);
297			//print "source: " . Dumper($source);
298
299			// pre-flight checks
300			if (!isset($target)) {
301			user_error("variable passed as reference (merge target) is not set.");
302			return;
303			}
304			//if (!is_hash($hash)) {
305			if (!isset($source)) {
306			user_error("variable passed as source is not set.");
307			return;
308			}
309
310			// perform merge
311			foreach ($source as $key => $val) {
312			$name = $prefix_key . $key;
313			if (is_object($target)) {
314			$target->$name = $val;
315			//} elseif (php::is_hash($target)) {
316			} else {
317			$target[$name] = $val;
318			}
319			}
320
321			// indicate good
322			return 1;
323
324			}
325
326			/**
327			* Set the locator metadata hash we will feed partly
328	joko	1.6	* to an encapsulated Data::Driver::Proxy instance
329	joko	1.1	*
330			* @param LocatorMetadataHash array -
331			*
332			*/
333			function set( &$locator ) {
334			$this->_out = &$locator;
335			}
336
337			function &get_metadata() {
338			//return ($this->_out);
339			return $this->_metadata;
340			}
341
342
343			function build( ) {
344
345			// trace
346			//print Dumper($this);
347
348			$good = 0;
349			switch ($this->_datasource_type) {
350			case 'rpc':
351			// get rpc connection information from global constants
352			$metadata = array(
353			//package => 'Data::Driver::Proxy',
354			//package => 'DataSource::Proxy::XMLRPC',
355	joko	1.3	//package => 'DataSource::Generic',
356	joko	1.1	//package => 'DesignPattern::RemoteProxy',
357			Host => RPC_HOSTNAME,
358			Port => RPC_PORT,
359			);
360			$good = 1;
361			break;
362			}
363
364			if ($good) {
365
366			// V1:
367			/*
368			$this->_out = array(
369			datasource_type => $datasource,
370			adapter_type => 'Data',
371			metadata => $metadata,
372			);
373			*/
374
375			// V2:
376			//$this->_out = $metadata;
377
378			// V3:
379			$this->merge_to($this->_metadata, $metadata);
380
381			}
382
383			// trace
384			//print Dumper($this);
385
386			}
387
388			function check() {
389			if (!sizeof($this->_metadata)) {
390			user_error("DataSource::Locator::check() failed: " . "Locator metadata not established, please check configuration options.");
391			return;
392			}
393			return 1;
394			}
395
396
397			}
398
399			?>
MailToCvsAdmin">MailToCvsAdmin	ViewVC Help
Powered by ViewVC 1.1.26