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