Continuous Learning

Out of the three supported API, MetaWeblog API documentation is the only one that has not moved - it is located here.

The main difference between MetaWeblog & Blogger API is that MetaWeblog extends the Blogger API by passing a struct for the post rather than just a string for the content.

The explanation on the spec page has one confusing point: it mentioned that the struct contains the elements defined in RSS 2.0 - this can be read as that struct has the same XML markup as RSS 2.0. This is NOT the case. The struct still has the same XML markup in XMLRPC, but it can have member with the names of link, title, description, etc.

The main methods are:

• metaWeblog.newPost (blogid, username, password, struct, publish) returns string (postid) - supersede blogger.newPost
• metaWeblog.editPost (postid, username, password, struct, publish) returns boolean - supersede blogger.editPost
• metaWeblog.getPost (postid, username, password) returns struct - return a post by its ID
• metaWeblog.newMediaObject (blogid, username, password, struct) returns struct - uploads a base64 encoded file (in the struct of name, type, bits) onto the server, returning an URL
• metaWeblog.getCategories (blogid, username, password) returns struct - returns a list of defined categories
• metaWeblog.getRecentPosts (blogid, username, password, numberOfPosts) returns array of structs - returns a list of the recent posts.

I recently spoke with a friend who said that she has no real passion in life. She feels that work is all there is, and there is nothing that she cares about, and that she rather works on community services instead. Having worked in the same line of work as she did before, I know what she’s talking about. In the consulting business, while it might seem glamorous from outside, the truth is that it takes a special type of people to really love meeting impossible and contradictory demands time after time from your boss as well as clients.

However, when she started to talk about community service, she switched into a different mode. Her eyes light up, her speech rate is faster and voice elevated, and she gets a lot more animated. Without missing a beat, she went on and tell me about the latest mentoring program that they have for youth, and how it focuses on providing kids with multiple role models to offset the challenges of having only a couple of role models that might disappear later, and that the program shows high promises than other mentoring models. She practically becomes a different person. Right there and then, she just found her passion - volunteering.

Without a doubt in my mind, passion is one of the strongest indicators for future success. Most people in this world are living in the rat race, without realizing that while the rat race provides a paycheck, it sucked away a bigger part of ourselves - our spirit. Most of us grow up having a dream - Keep reading →

Blogger API is one of the earliest Blogging API’s, and it has been around for a long time. Currently Blogger is moving to ATOM, so if you just click on the Blogger API link, it’s going to take you to a blog. Google broke its own links, basically.

So where is the actual Blogger API documentations nowadays? I forgot how I found it, but it’s here:

• http://www.blogger.com/developers/api/1_docs/

And the first thing you will see when going to the link is the highlighted warning that says:

Note: This API will be deprecated soon; please use the Atom API instead. - Eric, 4/2006

The nice thing is that we are learning about WP’s API, so unless WP decides to follow suit, we don’t have to worry about the warning

Limitations

The reason for its obsolescence is because the API is limited - it can only post content; not title, categories, and other things that you have come to expect from a blogging platform. I don’t know why the API is this limited, but perhaps once upon a time that was all people need. This is no longer true today (and hence WP’s support for MetaWeblog & MovableType API).

Regardless of its limitations, because of its early status and influence on upcoming API’s, it is still important to know. And hopefully Blogger does not decide to take down these pages soon (they probably break the link because they want to obsolete the API, but that makes it difficult for others trying to figure out WP)

API

Below are the methods supported in Blogger API:

• blogger.newPost: Makes a new post to a designated blog. Optionally, will publish the blog after making the post.
• blogger.editPost: Edits a given post. Optionally, will publish the blog after making the edit.
• blogger.getUsersBlogs: Returns information on all the blogs a given user is a member of.
• blogger.getUserInfo: Authenticates a user and returns basic user info (name, email, userid, etc.).
• blogger.getTemplate: Returns the main or archive index template of a given blog.
• blogger.setTemplate: Edits the main or archive index template of a given blog.

From WP perspective, the necessary methods are Blogger.getUsersBlogs & Blogger.getUserInfo (possibly getTemplate & setTemplate as well, but I’ve not had uses for it). For the posting capabilities we need to look at MetaWeblog & MovableType, which we will discuss in the next article.

Just which methods do Wordpress supports exactly? The best way to know is to look at the source (because source code is the design document). You will find the following if you look at the xmlrpc.php located in the root directory of your WP installation (the version I have is 2.0.5).

$this->methods = 
array(
      // Blogger API
      'blogger.getUsersBlogs' => 'this:blogger_getUsersBlogs',
      'blogger.getUserInfo' => 'this:blogger_getUserInfo',
      'blogger.getPost' => 'this:blogger_getPost',
      'blogger.getRecentPosts' => 'this:blogger_getRecentPosts',
      'blogger.getTemplate' => 'this:blogger_getTemplate',
      'blogger.setTemplate' => 'this:blogger_setTemplate',
      'blogger.newPost' => 'this:blogger_newPost',
      'blogger.editPost' => 'this:blogger_editPost',
      'blogger.deletePost' => 'this:blogger_deletePost',
      
      // MetaWeblog API (with MT extensions to structs)
      'metaWeblog.newPost' => 'this:mw_newPost',
      'metaWeblog.editPost' => 'this:mw_editPost',
      'metaWeblog.getPost' => 'this:mw_getPost',
      'metaWeblog.getRecentPosts' => 'this:mw_getRecentPosts',
      'metaWeblog.getCategories' => 'this:mw_getCategories',
      'metaWeblog.newMediaObject' => 'this:mw_newMediaObject',
      
      // MetaWeblog API aliases for Blogger API
      // see http://www.xmlrpc.com/stories/storyReader$2460
      'metaWeblog.deletePost' => 'this:blogger_deletePost',
      'metaWeblog.getTemplate' => 'this:blogger_getTemplate',
      'metaWeblog.setTemplate' => 'this:blogger_setTemplate',
      'metaWeblog.getUsersBlogs' => 'this:blogger_getUsersBlogs',
      
      // MovableType API
      'mt.getCategoryList' => 'this:mt_getCategoryList',
      'mt.getRecentPostTitles' => 'this:mt_getRecentPostTitles',
      'mt.getPostCategories' => 'this:mt_getPostCategories',
      'mt.setPostCategories' => 'this:mt_setPostCategories',
      'mt.supportedMethods' => 'this:mt_supportedMethods',
      'mt.supportedTextFilters' => 'this:mt_supportedTextFilters',
      'mt.getTrackbackPings' => 'this:mt_getTrackbackPings',
      'mt.publishPost' => 'this:mt_publishPost',
      
      // PingBack
      'pingback.ping' => 'this:pingback_ping',
      'pingback.extensions.getPingbacks' => 'this:pingback_extensions_getPingbacks',

      'demo.sayHello' => 'this:sayHello',
      'demo.addTwoNumbers' => 'this:addTwoNumbers'
      );

And below is the relevant extracted list from the source code:

• blogger.getUsersBlogs
• blogger.getUserInfo
• blogger.getPost
• blogger.getRecentPosts
• blogger.getTemplate
• blogger.setTemplate
• blogger.newPost
• blogger.editPost
• blogger.deletePost
• metaWeblog.newPost
• metaWeblog.editPost
• metaWeblog.getPost
• metaWeblog.getRecentPosts
• metaWeblog.getCategories
• metaWeblog.newMediaObject
• metaWeblog.deletePost
• metaWeblog.getTemplate
• metaWeblog.setTemplate
• metaWeblog.getUsersBlogs
• mt.getCategoryList
• mt.getRecentPostTitles
• mt.getPostCategories
• mt.setPostCategories
• mt.supportedMethods
• mt.supportedTextFilters
• mt.getTrackbackPings
• mt.publishPost

The ones with blogger prefix are Blogger API methods. The ones with metaWeblog prefix are MetaWeblog methods, and the ones with mt prefix are MovableType methods.

We will cover the different API’s next.

The foundation of Wordpress API is built on XMLRPC, and hence if you want to know how the API works then you need to know XMLRPC.

XMLRPC Specification

The authoritative source about XMLRPC is its spec, which includes the following information:

1. Sample request & response
2. Method name
3. XML representation of scalar data (boolean, integer, double, date, string, and base64)
4. XML representation of complex data (array and struct)
5. Failure response

You might find the spec itself is a bit sparse (which is a prevalent feature in the whole xmlrpc.com), and might want to have some tutorials and samples to go along with the information. Furthermore, who wants to manually construct XML these days?? We want a library to do the work!

PHP Implementations of XMLRPC

It turns out that many people have answered the call - I found that at least 5 major branches of XMLRPC libraries in PHP (there are probably more, but I can’t boil the ocean ;P):

• PHP itself has included an experimental xmlrpc functionality, which can be turned on/off
• The PHP experimental xmlrpc functionality is based on eOpinion’s library
• PEAR also has a library for XMLPRC called PEAR::XML_RPC
• PEAR’s library is based on Edi Dumbill (Useful Inc)’s XML-RPC package
• Lastly but not least, Incutio has a very easy to use XML-RPC package (this is the package used by WP)

How should one go about choosing the right package to use? Below is my quick checklist for decision points:

• Is the library stable?
• Will the library be supported?
• Will the library be available?
• Will the library require additional effort to get setup (e.g. require compilation process)?

And how the libraries stack up:

Conclusion

While the pure library XML-RPC package such as Useful Inc’s or Incutio’s do not necessarily offer speed, IMHO they are easier to include for distribution, better documentation, and possibly active support.

When comparing the two package, what I found is that:

• Useful Inc’s has more active development and better documentations
• But Incutio’s is easier to use, and is used in WP

What really sold me with Incutio’s package is that by default it assumes that you shouldn’t have to even think in XML at all - it helps you handle as much of conversion from XML to PHP objects as possible, where Useful Inc’s version still requires you to explicitly control the conversion (it does have helper functions that will simplify the process). Incutio’s abstraction will help speed up the development of a WP XMLRPC client.

We will talk about the various API for WP next.

Overview

This series of articles is about Wordpress API - how to interface with Wordpress to create posts and manage posts without having to dig into its internal data structures. I have chance to take a look at WP’s internal, and it is certainly not for the faint of heart (or the lack of time), and external API are definitely more stable in the name of upgrades and changes.

It turns out that Wordpress DOES have an external API:

WordPress uses an XML-RPC interface. We currently support the Blogger API, metaWeblog API, and the Movable Type API .

…

You can always develop your own. Many scripts in Perl, Python, PHP, Applescript and Java have already been written and are ripe for the picking (and tweaking).

Below are the web clippings of the day. Enjoy.

• State of the Art of Model-Based Testing with Markov Chain Usage Models
  
  I long believe that xUnit approach to testing creates test case explosion with minimal returns and usage-based testing is superior. This is a document that provides a theoretical description of usage based testing.

• cruizer : Static instances in PHP4
  
  How to use function & static variables inside function to “fake” singleton pattern - make sure not to use reference (&) because in pHp static objects are already references.

• All about Linux: How to securely erase the hard disk before selling ones computer
  
  Tools such as shred or DBAN can help you “securely” remove the data - how secure depends on who is trying to retrieve it. Mere mortals are not likely to recover the data erased this way.

• PHP: assert - Manual
  
  In PHP the combination of assert and assert_options can be used to build design by contract framework.

• PHP: Error Handling and Logging Functions - Manual
  
  Introduction on how to handle PHP errors (in PHP4). In PHP5 try/catch exception models are used.

• Last RSS - PHP RSS parser/reader
  
  An alternative to magpieRSS - claims to be simpler, and appears to be less featured. Also GPL.

• PECL :: Package :: apd
  
  A full-featured engine-level profiler/debugger. APD is a full-featured profiler/debugger that is loaded as a zend_extension. It aims to be an analog of C’s gprof or Perl’s Devel::DProf.

• Profiling Lisp programs
  
  Apparently there are many paths to nirvana in lisp A few simple and different approaches to profiling in lisp.

• cakebaker � Run PHP5 in PHP4 mode
  
  How to run PHP5 in PHP4 mode.

• PHP: Magic constants - Manual
  
  PHP offers some magic constants to allow for inspection on where you are in the script, including __LINE__, __FILE__, __FUNCTION__, __CLASS__, __METHOD__.

• PHP: var_dump - Manual
  
  How to dump a variable in PHP - the comments have some novel and interesting approaches.

• Validating Email Addresses Are Complicated
  
  Many code on how to validate email addresses are wrong. This page demonstrates why… it is more complicated than most people give credit for. Click on the links to see the Perl version of regex. Hint: one-liners are not even close.

The following are the stats for February 2007:

• Posts: 16 posts for 20 weekdays - 4 posts/week
• Visits: 905
• Page Views: 1,802
• Average: 1.99 pages/visit

This is of course a big decrease from January - good thing this drop is by design So what happened?

1. I spend majority of time developing instead of writing.

2. The traffic from Reddit is dying down without being renewed.

As noted in the How to Generate Compelling Content series, going forward I am leveraging my technical skills to bring content to this site. You probably have noticed the Web Clippings for different categories (Bizscape, Leaderware, etc), and these are generated by my script that can pull from del.icio.us by different tags. I am also working on a couple other ways of pulling contents, but as they are more complex they are still in development progress.

Right now I am going through the process of refining the script and add documentations so I can release it for wide use. If you are interested in having similar functionality, stay tuned

Below are the web clippings of the day. Enjoy.

• Stevey’s Home Page - Being the Averagest
  
  Can you tell if someone is a great developer? Or is he/she just one who is very used to do things a particular way who never thought to improve beyond what he/she already knows how to do?

• Why you cannot learn much from past success - lifehack.org
  
  People really learn more from mistakes and failures than from successes.

• Creating Passionate Users: Are our tools making us dumber?
  
  The title says it all - are we becoming less capable because our tool are doing the work for us so we don’t have to think? When was the last time you did calculations by hand and do you still remember? I sure don’t

• Rands In Repose: 1.0
  
  Rands has an interesting model to look at version 1.0 companies and why it almost always fails. IMO the more technical the founders are, the less gap between pitch and product and the more likely it can succeed.

• So you want to be a consultant…?
  
  What it takes to be a consultant from someone who has been doing it since 1985. IMO, this is what it takes to be a professional, period, regardless of the status (i.e. employee, contractor, consultants).

• Creating Passionate Users: Don’t make the Demo look Done
  
  How to set the right expectations with stakeholders/users/etc on the current progress of the project through demos. If one uses polished demo early on, things will look done and the feedback will be minimal.