hands on xml-rpc : copying msql tables

I don’t have anything to blog on, so I will bore you all with a quick generic function to copy mysql tables from one host to another, using xml-rpc.

I use the Incutio xml-rpc library on both hosts, to handle the tedious stuff (xml formatting and parsing). That leaves only some snippets to send and receive table data and store it on a mysql database.

First : how to handle the table data on the sending end:

  • I take an associative array from a mysql query
  • I make an array to hold the records
  • I add each row as array
  • I make an IXR-client.
  • I add some general parameters
  • I hand these and the entire table array to my IXR-client.
  • send…
  1. //the snippet with the client is at the bottom of the post
  2. $ThisClient = New SerpClient('http://serp.trismegistos.net/db/xmlrpc.php', 'user', 'pass', 'sender');
  3.  
  4. $tablename = "serp_tags_keys";
  5. $tableid = "id";
  6. $result = $serpdb->query("SELECT * FROM ".$tablename);
  7. $recordcount = mysql_num_rows($result);
  8.  
  9. while($row=mysql_fetch_assoc($result)) {
  10.  $record=array();
  11.  foreach($row as $key => $value) $record[$key]=$value;
  12.  $records[]=$record;
  13. }
  14.  
  15. $ThisClient->putTable($tablename, $recordcount, $tableid, $records);

I consider some additional fields necessary for basic integrity checks : I add “ID” as key field, so on the receiving end the server knows which field is my table’s auto-increment field. Other fields are a username, password, tablename and the batch recordcount.

The IXR_Client then generates a tangled mess of xml-tags holding the entire prodecure call and data. (you can put the client on ‘debug’, then it dumps the generated xml to the screen).

The first part of the xml file contains the single parameters :

  • username
  • password
  • tablename
  • recordcount
  • id-field

<methodCall>
<methodName>serp.putTable</methodName>
<params>
<param><value><string>user</string></value></param>
<param><value><string>pass</string></value></param>
<param><value><string>serp_tags_keys</string></value></param>
<param><value><int>91</int></value></param>
<param><value><string>id</string></value></param>

Then the entire table is sent as one parameter in the procedure call.

That parameter is built from an array containing the table rows as ‘struct’. If I want to use the routine for any table, I need the fieldname-value pairs to compose a standard mysql insert statement. A struct type allows me to use key-value pairs in the xml-file that can be parsed back into an array.

<param><value><array>

<data>

<value><struct>
<member><name>id</name><value><string>4</string></value></member>
<member><name>tag</name><value><string>ranking</string></value></member>
<member><name>cat</name><value><string>alexa ranking seo internet ranking internet positi</string></value></member>
<member><name>date</name><value><string>200901</string></value></member>
</struct></value>

<value><struct>
<member><name>id</name><value><string>94</string></value></member>
<member><name>tag</name><value><string>firm</string></value></member>
<member><name>cat</name><value><string>firm seo</string></value></member>
<member><name>date</name><value><string>200901</string></value></member>
</struct></value>

</data>

</array></value></param>

That was the last of the param holding the table, so the entire tag-mess is closed :

</params&gt</methodCall&gt

Then the second part : on the receiving end the Incutio class parses the whole tag-mess, and hands an array of the param sections as input to my function putTable.

  1.  function putTable($args)
  2.  {
  3.   $user   = $args[0];
  4.   $pass   = $args[1];
  5.   $tname   = $args[2];
  6.   $tcount  = $args[3];
  7.   $id           = $args[4];
  8.   $table   = $args[5];

$table is a straightforward array holding as items an array ($t) created from the struct with the pairs of fieldname-value. I turn the recordsets key-value struct into a mysql INSERT query :
$query = “INSERT INTO `”.$tname.”` (” field, field… “) VALUES (” fieldvalue, fieldvalue “)”;

All I have to do is add the fieldnames and fieldvalues to the mysql insert query.

  1.   foreach($table as $t) {
  2.  
  3. //the fixed parts
  4.     $query0 = 'INSERT INTO `'.$tname.'` (';
  5.     $query2 .=") VALUES (";
  6.  
  7. //make the (`fieldname`, `fieldname`, `fieldname`) query-bit
  8. //and the ('fieldvalue', 'fieldvalue', 'fieldvalue') query-bit :
  9.  
  10.     foreach($t as $key=>$value) {
  11.      if($key!=$id) {
  12.       $query1 .="`".$key."`, ";
  13.       $query3 .="'".$value."', ";
  14.      }
  15.     }
  16.  
  17. //remove the trailing ", "
  18.     $query1=substr($query1, 0, strlen($query1)-2);
  19.     $query3=substr($query3, 0, strlen($query3)-2);
  20.  
  21. //glue em up and add the final ")"
  22.     $query0 .= $query1.$query2.$query3.")";
  23.  
  24. //query…
  25.     $this->connection->query($query0);
  26.  
  27. //reset the strings
  28.     $query0='';
  29.     $query1='';
  30.     $query2='';
  31.     $query3='';
  32.    }
  33.  }

that generates mysql queries like
INSERT INTO `serp_tags_keys` (`tag`, `cat`, `date`) VALUES (‘ranking’, ‘alexa ranking’, ‘200901’) and copies the entire table.

That is how I handle the table data.

Of course I have to define two custom classes to process the serp.putTable procedure itself, using the Incutio class.

First the class for the sending script, which is pretty straight forward :

  • make an IXR_Client instance
  • hand the record set to it
  • have it formatted and sent
  1. //include the library
  2. include('class-IXR.php');
  3.  
  4. //make a custom class that uses the IXR_client
  5. Class SerpClient
  6. {
  7.  var $rpcurl;         //endpoint
  8.  var $username;   //you go figure
  9.  var $password;
  10.  var $bClient;      //incutio ixr-client instance
  11.  var $myclient;  //machine/host-id
  12.  
  13.     function SerpClient($rpcurl, $username, $password, $myclient)
  14.     {
  15.  $this->rpcurl = $rpcurl;
  16.     if (!$this->connect()) return false;
  17.  
  18.      //Standard variables to send in the message
  19.  $this->rpcurl = (string) $rpcurl;
  20.      $this->username = (string) $username;
  21.      $this->password = (string) $password;
  22.  $this->myclient = (string) $myclient;
  23.      return $this;
  24.     }
  25.  
  26.      function connect()
  27.    {
  28. //basic client, it takes the endpoint url, tests and returns true if it exists
  29.      if($this->bClient = new IXR_Client($this->rpcurl)) return true;
  30.     }
  31.  
  32. //the function I use to send the data
  33.   function putTable($tablename, $recordcount, $tableid, $array)
  34.  {
  35. //first parameter is always the methodname, then the parameters, which are
  36. //added sequential to the xml-file (with the appropriate tags for datatypes.
  37. //the script figures that out. note : it uses htmlentities on strings.
  38.   $this->bClient->query('serp.putTable', $this->username, $this->password, $tablename, $recordcount, $tableid, $array);
  39.  }
  40.  
  41. }

I use it in the snippets above with :

  1. $ThisClient = New SerpClient('http://serp.trismegistos.net/db/xmlrpc.php', 'user', 'pass', 'sender');
  2. //…
  3. $ThisClient->putTable($tname, $tcount, $tableid, $records);

Then, on the receiving end, my program has to know how to handle the xml containing the remote procedure call.

I define an extension on IXR_server and pass serp.putTable as new ‘method’ (callback function).

  1. //go away cookie…
  2. $_COOKIE = array();
  3.  
  4. //make sure you get the posted crap, the ixr instances grabs it input from it
  5. if ( !isset( $HTTP_RAW_POST_DATA ) ) $HTTP_RAW_POST_DATA = file_get_contents( 'php://input' );
  6. if ( isset($HTTP_RAW_POST_DATA) ) $HTTP_RAW_POST_DATA = trim($HTTP_RAW_POST_DATA);
  7.  
  8. //include the library
  9. include('class-IXR.php');
  10.  
  11. //make an extended class
  12. class serp_xmlrpc_server extends IXR_Server {
  13.  
  14. //use the same function name…
  15.  
  16.  function serp_xmlrpc_server() {
  17.  
  18. //build an array of methods :
  19. //first the procedurename you use in the xml-text,
  20. //then which function in the extended class (this one) it maps to
  21. //to be used as $this->method
  22.  
  23.   $this->methods = array('serp.putTable'  => 'this:putTable');
  24.  
  25. //hand em to the IXR server instance that will map it as callback
  26.   $this->IXR_Server($this->methods);
  27.  }
  28.  
  29. //now IXR_Server instance uses ($this->)putTable
  30. //to process incoming xml-text
  31. //containing serp.putTable as methodname
  32.  
  33.   function putTable($args)
  34.  {
  35. //(for routine : see the snippet above to store the xml data in mysql)
  36.  }
  37. }
  38.  
  39. //make the class instance like any regular get-post php program,
  40. //the only actual program line, that instantiates the extended class,
  41. //which handles the posted xml
  42.  
  43. $serp_xmlrpc_server = new serp_xmlrpc_server();

That’s all. I am not going to list a cut-and-paste version. You have to build some stuff with it, then you will come up with lots of stuff you can do with it.

WordPress and iPhone built a plugin that receives pictures from iPhone. WordPress uses Incutio so you can ‘piggyback’ on that and have an iPhone plugin for your own website in two days flat using an ajax lightbox gallery script. Or go monetize small websites with some seo oriented ‘optimisation’ functions like ChangeFooterLinks(array($paidurl, $anchortext)) :) or whatever… boring, isn’t it ?

Posted in optimisation, php, xml-rpc and tagged , , .

Leave a Reply

Your email address will not be published. Required fields are marked *