Horde and Funambol Windows Mobile... It works!

Short: To make Funambol Client for Windows Mobile work with the Horde framework, you have to do four things:

• Define an extra application api in your Horde tree (I named it "syncconf").
• Register it saying it provides "configuration/list", "configuration/listBy" and "configuration/import"
• Patch horde/lib/SyncML/Backend.php to accept "configuration" as database
• Patch horde/lib/SyncML/Backend/Sql.php to accept "configuration" as database

To be able to register an application you have to have at least an "api.php" file in a horde subdirectory named with the application name. So I had to do a mkdir $hordedir/syncconf, there I had to make two subdirectories: config and lib.

In my case I have three new directories:

.....horde/syncconf/
.....horde/syncconf/config
.....horde/syncconf/lib

I began with the API. This is the easy part, it looks like this:

<?php

$_services['import'] = array(
 'args' => array('content' => 'string', 'contentType' => 'string', 'source' => 'string'),
 'type' => 'string',
);

$_services['listBy'] = array(
 'type' => '{urn:horde}stringArray'
);

$_services['list'] = array(
 'type' => '{urn:horde}stringArray'
);

function _syncconf_import($content, $contentType = 'array', $import_source = null)
{
  $result="";
  return $result;
}

function _syncconf_listBy()
{
  $ar=array();
  return $ar;
}

function _syncconf_list()
{
  $ar=array();
  return $ar;
}

As you see, we don't return anything useful. These functions always return an empty result - an empty string or an empty array. But that will do the trick!

Save that file as "....horde/syncconf/lib/api.php" and you have your superb new API! (returning nothing, wha whaaaaa).

Now make a fake configuration (Horde DOES WANT a configuration! No chance if you don't have one). Create file conf.php as ....horde/syncconf/config/conf.php:

<?php
  $conf['syncconf']['looking_for_nice_woman_to_make_family'] = true;

put in whatever you want.

You may omit the last "?>" as all included Horde files do. I am just accomodating to their style.


Now it is time to register this "application" - hey we don't even have a user interface - all we have is a dumb api and a nonsense config. So we have to insert this in ....horde/config/registry.php  (the Horde application registry):

$this->applications['syncconf'] = array(
 'fileroot' => dirname(__FILE__) . '/../syncconf', 
 'name' => 'Funambol Configuration',
 'status' => 'hidden',
 'provides' => array('configuration/listBy','configuration/list','configuration/import')
);

Please make sure that the status is 'hidden' otherwise Horde will have some big problem...

Last, define "configuration" as valid SyncML database name. Unfortunately, there is not a small configuration file to achieve this, no, you have to patch Backend.php and Backend/Sql.php (real paths described above).

In ....horde/lib/SyncML/Backend.php you'll find these lines:

    function isValidDatabaseURI($databaseURI)
    {
        $database = $this->_normalize($databaseURI);

        switch($database) {
        case 'tasks';
        case 'calendar';
        case 'notes';
        case 'contacts';
        case 'configuration';
            return true;

Note I just added "case 'configuration';" to the switch statement.

The same applies to ....horde/lib/SyncML/Backend/Sql.php:

    function isValidDatabaseURI($databaseURI)
    {
        $database = $this->_normalize($databaseURI);

        switch($database) {
        case 'tasks';
        case 'calendar';
        case 'notes';
        case 'contacts';
        case 'configuration';
        case 'events':
        case 'memo':
            return true;

Same trick as above: I just inserted "case 'configuration';".

Now you're ready to run.

The SyncML server URL is just

https://your_horde_server/horde/rpc.php

I used an Apache Alias statement to change this to

https://our_horde_site/sync

And it works.
The first run (after entering server url, username and password) will fail though, the Funambol client just does not like to have zero data (as our api does not return anything). But after acknowledging this "error" with ok, it will work and synchronizes Contacts, Tasks, Calendar items and Notes!
Please make sure that neither "E-Mail" nor "Briefcase" are selecedt in the PIM settings of  the Funambol Client. These won't work.
Just use normal IMAP4 account data for Windows Mobile Messaging to get your email on your phone/mobile device.


Mission accomplished.

Yes, I hate PHP.
But Horde is quite cool.