• Intro
• Downloads
• Community
• Development
• News
• TALK

Documentation/Maemo 5 Developer Guide/Using Data Sharing/Sharing Plug-in

Latest revision as of 15:28, 10 August 2010

With the Sharing dialog API, the user can open the first dialog, which starts the Sharing flow. From the first dialog the user can select "Send via Bluetooth", "Send via E-mail" and "Share via service".

More detailed API documentation can be found from here.

Example code how to use the API:

/* create osso context in your app that is passed to sharing */
osso_context_t *osso = osso_initialize ("my_app", "1.0.0.", FALSE, NULL);
/* file to open */
gchar *filename = "/path/to/file";
sharing_dialog_with_file (osso,
                          GTK_WINDOW (parent),
                          filename);

In the example above we use the API to start sharing single file. In case you want to share simultaneously more than one file or you want to change what button are seen in the dialog use one of the functions below.

 void sharing_dialog_with_files (osso_context_t * osso, GtkWindow * parent, GSList * uris);
 void sharing_dialog_button_mask_with_file (osso_context_t * osso, GtkWindow * parent, const gchar * uris, guint share_button_mask);
 void sharing_dialog_button_mask_with_files (osso_context_t * osso, GtkWindow * parent, GSList * uris, guint share_button_mask);

[edit] Compiling

When compiling your application use the following pkg-config configuration:

`pkg-config --cflags --libs sharingdialog`

[edit] Writing "Send Via" Functionality for E-mail and Bluetooth

Send Via E-mail and Bluetooth can be used directly without Sharing dialog and the functionality is provided by the platform to enable applications to send data via E-mail or over a Bluetooth connection. Because several applications share this functionality, the platform provides a public interface to facilitate the deployment of these services in user applications. The interfaces are defined in two header files: libmodest-dbus-client.h (in the libmodest-dbus-client-dev package) and conbtdialogs-dbus.h (in the conbtdialogs-dev package). The following sample code is an example of the usage of these interfaces. See the maemopad source code available in the SDK repository for a fully functional application using this service.

maemopad/src/maemopad-window.c

/* send via email: */
#include <libmodest-dbus-client/libmodest-dbus-client.h>
/* send via bt: */
#include <conbtdialogs-dbus.h>
/*......*/
static void maemopad_window_on_menu_sendvia_email (GtkButton *button, gpointer data)
{
 MaemopadWindow *self = MAEMOPAD_WINDOW (data);
 gboolean result = TRUE;
 GSList *list = NULL;
 g_assert (self);
 /* Attach the saved file (and not the one currently on screen). If the file 
  * has not been saved yet, nothing is attached */
 if (self->file_name) {
  list = g_slist_append(list, self->file_name);
  result = libmodest_dbus_client_compose_mail(self->osso, /*osso_context_t*/
    NULL, /*to*/
    NULL, /*cc*/
    NULL, /*bcc*/
    NULL, /*body*/
    NULL, /*subject*/
    list /*attachments*/);
 }
 g_slist_free(list);
 if (result == FALSE)
  g_print("Could not send via email\n");
}
 
static gboolean maemopad_window_rpc_sendvia_bluetooth (const gchar *path)
{
 DBusGProxy *proxy = NULL;
 DBusGConnection *sys_conn = NULL;
 GError *error = NULL;
 gboolean result = TRUE;
 gchar **files = NULL;
 /*sys_conn = osso_get_sys_dbus_connection(ctx);*/
 sys_conn = dbus_g_bus_get(DBUS_BUS_SYSTEM, &error);
 if(sys_conn == NULL)
 {
  return FALSE;
 }
 files = g_new0(gchar*, 2);
 *files = g_strdup(path);
 files[1] = NULL;
 /* Open connection for btdialogs service */
 proxy = dbus_g_proxy_new_for_name(sys_conn,
  CONBTDIALOGS_DBUS_SERVICE,
  CONBTDIALOGS_DBUS_PATH,
  CONBTDIALOGS_DBUS_INTERFACE);
 /* Send send file request to btdialogs service */
 if (!dbus_g_proxy_call(proxy, CONBTDIALOGS_SEND_FILE_REQ,
  &error, G_TYPE_STRV, files,
  G_TYPE_INVALID, G_TYPE_INVALID))
 {
  g_print("Error: %s\n", error->message);
  g_clear_error (&error);
  result = FALSE;
 }
 g_strfreev(files);
 g_object_unref(proxy);
 return result;
}

[edit] Writing Sharing Plug-in for "Send via Service"

Maemo 5 introduces a new library for handling Sharing related information and services. This chapter will walk you through the process of creating a sharing plug-in using a template plug-in as example. Basic knowledge of Debian development and working in a Scratchbox environment is needed in order to follow these guides.

Plugin template with some example codes is located here Data Sharing Plugin example

Detailed API documentation is available in libsharing-plugin-doc package in gtk-doc format.

Before starting to create your own plugin it is a good idea to check the default services: OVI and Flickr. From those you can see two different UI flows for creating accounts. In OVI the UI flow is pretty simple and clear, you just type a user name and password and then validate the account. In Flickr the flow is more complex, as before validation the user must login to Flickr via a web page to get authentication and continue the validation after that.

Account creation is started from Settings:

Settings -> Sharing accounts -> New -> Select service ...

[edit] Sharing User Interfaces

Sharing application abstracts the file sharing and implements common parts needed for file sharing application. Sharing Application service support can be extended by using Sharing Plug-ins. These plug-ins can be created by any 3rd party developer. The plug-ins should implement the Sharing Plug-in API functions and define some parameters in a service definition XML file.

Figure 1 below shows Sharing accounts dialog opened from the control panel. With the Sharing accounts, you can create a new Sharing account or edit an existing one. If you install a custom Sharing plug-in, you can see the service it provides in the "Select service list" when creating a new Sharing account.

Figure 1: Sharing Accounts

Figure 2 shows the Sharing Dialog user interface that is used to share images with the selected account on some service. The images displayed can come for example from the Photos application or from the device camera. You can choose the account created for your service from the "Account" combo box which holds all existing Sharing accounts.

Figure 2: Sharing Dialog User Interface

[edit] Getting Familiar With Target Service API

Many web services provide APIs that are available for 3rd party developers. In this tutorial, we focus on services that provide APIs for image and video uploads. It is possible to give a title, description and tags for the images using the common service API. Sharing supports image scaling and metadata filtering as common options for any service. Sharing Plug-ins can have service-specific options, like privacy. These settings can be accessed through the Options dialog (in Figure 2.)

[edit] Getting Your Dummy Plugin To Sharing Menus

As a prerequisite, you will need a working Maemo 5 SDK to continue further. We will first install the Sharing Plug-in template:

• Obtain the template source code sharing-plugin-template-0.1.tar.gz from the maemoexamples repository. It contains a good start up file structure for creating a plugin.
• Extract and build the package from the folder using command:

./autogen.sh; dpkg-buildpackage -rfakeroot -d

• Install the package built for your Scratchbox environment or to the device if it was built with the ARM target.
• The template dummy service should be now visible in the Sharing account when creating new accounts.

Note that this template plugin does not send any data before you write the implementation for it.

[edit] Editing Template Plug-in

In this section, we peek under the hood by opening the files found from the template plugin and get familiar with Sharing classes that are used in the Sharing Plugin API functions.

[edit] Sharing Internals

Figure 3 shows the general overview of how Sharing Plug-in connects to Sharing Application using the Sharing Plugin API. The basic plug-in components are the service definition file and the plugin library. The Application Sharing-Dialog is used to create SharingEntries that are shared by a SharingManager. Sharing Account Manager implements the Sharing Accounts. Libsharing is a library for all common Sharing functionality.

Figure 3: Sharing Plugin API

Figure 4 shows the common Sharing classes found in libsharing that you would use while creating the plug-in:

• SharingTransfer is the object that contains all the data of a sharing task, overall status of the transfer process for one set of shared files.
• SharingEntry contains the SharingEntryMedia that are the selected files. It also knows the SharingAccount that is the target of sharing.
• SharingAccount contains the username and password along with other parameters that you have to save for your service's accounts. It also has the information about SharingService which is registered with the SharingAccount.

Figure 4: Libsharing classes

To see more detail the sharing classes you can browse to Sharing plugin example

[edit] Service XML File

The service definition file, data/template.service.xml.in is the starting point for plugin loading. It defines the library that implements Sharing Plugin API functions, the sign up URL for totally new account creation using a web browser, the service name, icon file names and some basic information from plug-in.

<?xml version="1.0" encoding="UTF-8"?> 
<service plugin="libtemplate.so" provider="Me"> 
 
   <accounts plugInSetup="0" plugInEdit="0">
     <signup>www.maemo.org</signup> 
     <password maxlen="32"/> 
   </accounts> 
 
   <ui> 
       <name>Template</name>  
       <icon type="post">@servicesdir@/template-post.png</icon> 
       <icon type="setup">@servicesdir@/template-setup.png</icon> 
       <options> 
           <option id="privacy" type="enumeration" default="private"> 
               <caption domain="osso-sharing-ui" key="share_bd_options_privacy"/> 
               <value id="private" domain="osso-sharing-ui" key="share_fi_options_privacy_private"/> 
               <value id="public" domain="osso-sharing-ui" key="share_fi_options_privacy_public"/>
               </option>
       </options>
    </ui>
</service>

File 1: Example service definition XML file

[edit] How to read the xml file

The prefix of the xml file name defines the used service id of the plugin. In our example the id is "template".

Service element:

<service plugin="" provider="">
...
</service>

• Service is the root node of each service xml and must be named exactly service.
• Property plugin defines the library name that Sharing will look for in /usr/lib/sharing.
• Property provider defines the plugin provider.

Accounts element:

<accounts plugInSetup="0" plugInEdit="0">
  <signup>www.myservicepage.com</signup> 
</accounts>

• Accounts element defines the account setup options.
• Property plugInSetup defines if sharing should use internal default flow or flow implemented in the plugin itself. Set to "1" in case using own flow.
• Property plugInEdit defines if sharing should use internal default flow or flow implemented in the plugin itself. Set to "1" in case using own flow.
• Element signup defines the URL where browser is opened in case default flow used when user press button "Register new account" in account setup dialog.

Ui element:

<ui> 
  <name>...</name>  
  <icon type="post">@servicesdir@/...</icon> 
  <icon type="setup">@servicesdir@/...</icon> 
  <options> 
    ...
  </option>
</ui>

• UI element defines Name, icons and options that can be modified through XML file.
• Element name defines the name that is shown for the service in all the UI.
• Element icon defines the used icons. Property post or setup can be used. Property setup defines the icon shown in account setup dialogs.
• Element options defines the different changeable options for selected service. See more below.

Options element:

<options>
  <option id="..." type="enumeration || updatable" default="..."> 
    <caption domain="osso-sharing-ui" key="..."/> 
    <value id="..." domain="osso-sharing-ui" key="..."/> 
  </option>
  <option>
  ...
  </option>
</options>

• Options element defines all the options that a user can change through "Options" for the selected service. Each individual option is an element option.
• Property id defines the internal id for this option. User selected choice for this option is asked with the id, see here.
• Property type defines the type of option. You can select enumeration or updatable. For the enumeration you need to specify the shown values with values elements. Updatable option can contain default values and the remaining values can be updated from service.
• Property default defines the default value to select if user haven't made any selections yet. The value of the default property must mach one of the value element ids.
• Properties domain and key under caption element defines the actual text to be displayed. If you want to use some localization package then define domain and desired logical id to key. For free text the domain is not mandatory.
• Element value defines one value in the selection. If option is updatable new values with id/key pair can be added in code, see here. Otherwise you need to specify the shown values.

[edit] Account Setup User Interface Flow

Sharing accounts can either create a default flow where username and password parameters are set to the account or an optional custom flow. In File 1, the accounts tag has a parameter plugInSetup. If it is set to "1", Sharing Accounts will call the Sharing Plugin API function sharing_plugin_interface_account_setup to create UI flow; it will use the default flow. You can see the difference between UI flows when creating Flickr and Ovi account. Ovi uses the default flow and Flickr uses it's own UI flow.

SharingPluginInterfaceAccountSetupResult sharing_plugin_interface_account_setup (GtkWindow* parent, SharingService* service, SharingAccount** worked_on, osso_context_t* osso)

If you decide to create your own account setup flow, please try to keep the same UI look as in other Sharing dialogs.

[edit] Account Validation

Account validation is needed to reduce error cases in the sending process. Of course you can use the dummy function at template plug-in, but for better user experience this function is recommended to be implemented so that Sharing Account account information is really validated against the service when new account is created.

Next function is called after sharing_plugin_interface_account_setup call ends or when default account setup flow is done (when the "Validate" button is pressed).

SharingPluginInterfaceAccountValidateResult sharing_plugin_interface_account_validate (SharingAccount* account, ConIcConnection* con, gboolean *cont, gboolean* dead_mans_switch)

In the last phase of account creation, the account must be validated. Sharing Plug-in API sharing_plugin_interface_test_account is the function called in the validation phase of the account creation flow. Usually web services have a phase in account creation where you have put the needed information from your account, only then you get the actual credentials to upload images if your account information is valid. This is the phase that is implemented in the Sharing Plug-in API function.

[edit] Account Editing User Interface Flow

Sharing Accounts support here too either default flow where username and password parameters are edited or optional custom edit UI flow. The desired flow can be set by setting the parameter plugInEdit from the service definition file either to "0" or to "1" where "0" means the default flow and "1" plug-in flow.

The default flow can be used when you need only username and password to get needed information for sending. The plug-in flow is used when you need more than this or customised account validation flow. You can see the difference between UI flows here too when editing Flickr and Ovi accounts.

Next function must be implemented only when plug-in account setup is used (when plugInSetup is set to "1"):

SharingPluginInterfaceEditAccountResult sharing_plugin_interface_edit_account (GtkWindow* parent, SharingAccount* account, ConIcConnection* con, gboolean* dead_mans_switch)

[edit] Sending Functionality

SharingPluginInterfaceSendResult sharing_plugin_interface_send (SharingTransfer* transfer, ConIcConnection* con, gboolean* dead_mans_switch)

After pressing the 'Share' button in Sharing dialog (Figure 2.), the data is put into the Sharing Outbox (can be seen under /home/user/MyDocs/.sharing/outbox/). Sharing manager process is started and the status menu gets the icon to process the new Sharing Entry. SharingHTTP provides an API to create common HTTP requests. In order to create a better user experience following things are good to be implemented after you get the basic functionality working in your plug-in:

• Set progress of sending with sharing_transfer_set_progress between 0 and 1 to estimate the current transfer time / total transfer time.
• Set sent to SharingEntryMedia with sharing_entry_media_set_sent when file sending is done and check the send value with sharing_entry_media_get_sent to prevent sending same files multiple times for example in reboot scenarios.
• Poll cancel flag time to time, for example in curl or SharingHTTP progress function to end transferring when needed. Use sharing_transfer_continue to get the continue flag bit.
• If you are using libcurl instead of SharingHTTP, please listen to conic events to disconnect transfer when no connection available. It returns with 'no connection' return value in this case.

Next some example source for common tasks found in usual sending functionality:

[edit] Example sending loop

When you process SharingEntryMedias from the SharingEntry you propably end up with loop where you go the list of SharingEntryMedias through. Here is a raw example, where some example lines commented out with "//".

for (GSList* p = sharing_entry_get_media (entry); p != NULL; p = g_slist_next(p)) {
   SharingEntryMedia* media = p->data;
   /* Process media */
   if (!sharing_entry_media_get_sent (media)) {
       /* Post media */
       //guint result = my_send_task_post_function (my_send_task, media);
       /* Process post result */
       if (result == 0 /* EXAMPLE: MY_SEND_RESULT_SUCCESS */) {
           /* If success mark media as sent */
           sharing_entry_media_set_sent (media, TRUE);
           /* And mark process to your internal data structure */
           //my_send_task->upload_done += sharing_entry_media_get_size (media); 
       } else {
           /* We have sent the file in last sharing-manager call */
           //my_send_task->upload_done += sharing_entry_media_get_size (media);
       }
   }
}

[edit] Example tags string

Usually services accept the tags in their API to be added to images. Here is example source to create nice string about tag information to be put where ", " string used as separator. If service supports also geo tagging you should develop this source further by checking the tag type also.

static gchar* create_tags_str (const GSList* tags)
{
   gchar* ret = NULL;
   for (const GSList* p = tags; p != NULL; p = g_slist_next (p)) {
       SharingTag* tag = (SharingTag*)(p->data);
       const gchar* tmp = sharing_tag_get_word (tag);
       if (tmp != NULL) {
           gchar* new_ret = NULL;
           if (ret != NULL) {
               new_ret = g_strdup_printf ("%s, %s", ret, tmp);
               g_free (ret); /* old return is freed */
           } else {
               new_ret = g_strdup (tmp);
           }
           ret = new_ret;
       }
   }
   return ret;
}
gchar* tags = create_tags_str (sharing_entry_media_get_tags (media));

[edit] SharingHTTP example

SharingHTTP is meant to be used for HTTP transfers. It is probably easier to use this than libcurl and libconic directly in common cases. Give it a try at least if you are not familiar with libcurl!

SharingHTTP * http = sharing_http_new ();
SharingHTTPRunResponse res;
res = sharing_http_run (http, "http://example.com/post");
if (res == SHARING_HTTP_RUNRES_SUCCESS) {
 g_print ("Got response (%d): %s\n", sharing_http_get_res_code (http),
    sharing_http_get_res_body (http, NULL));
} else {
    g_printerr ("Couldn't get stuff from service\n");
}
sharing_http_unref (http);

[edit] Update options

sharing_plugin_interface_update_options is used to update account specific options in Sharing Dialog's Options menu. This is pretty handy when you want to have changing options in your plug-in for example albums.

You are defining these options in your plug-in's service definion .xml file. For example next lines can add updatable option "album" to the plug-in's accounts:

<option id="album" type="updatable" default="default_photoset">
    <caption domain="osso-sharing-ui" key="share_ti_select_album"/>
    <value id="default_photoset" domain="osso-sharing-ui" key="Default"/>
</option>

When update options is pressed sharing_plugin_interface_update_options is called. After you have got the newest options from service's server you can add them to currently selected account by creating a GSList* of SharingServiceOptionValues. After having a nice list of new options you can then set them to account with sharing_account_set_option_values (self->account, "album", option_values).

When setting the options to account is done you have to call the function that was given to you as parameter passing the SharingPluginInterfaceUpdateOptionsResult with value of your choise and the already before got cb_data as parameter. This tells to the caller that your part from the update flow is succesfully done. Next source can be used to create this function call (self->result is containing the result in you opinion):

/* Callback */
if (self->cb_func != NULL) {
    void (*fp) (SharingPluginInterfaceUpdateOptionsResult, gpointer);
    fp = self->cb_func;
    fp (self->result, self->cb_data);
} else {
    ; /* Fail */
}

You can have the callback function and it's parameter stored for example in next form:

void (*cb_func)(UpdateOptionsCallback result, gpointer data);
gpointer cb_data;

[edit] Uninstallation

Libsharing provides the sharing-account-remover binary that can be used to clean Sharing Accounts created for your plugin. This binary is run by debian/ dir's prerm script. Prerm scripts are run just before the package is uninstalled. Change the plugin id from sharingplugintemplate to match your plug-in id in the script. Your plug-in's id is the service definitions files prefix. For template.service.xml, the prefix is "template".

Example prerm script:

#!/bin/sh
# You can use sharing-account-remover to remove the accounts at plugin
# uninstallation
if [ "$1" = "remove" ]; then
	/usr/bin/sharing-account-remover <service name>
fi

[edit] Testing your plugin

After setting up your Scratchbox environment you can start using and testing your own plugin.

Sharing framework consists following packages:

libsharing-plugin-dev
libsharing0
sharing-manager
sharing-account-manager
sharing-dialog
sharing-service-ovi
sharing-service-flickr

All the needed packages should be installed along with nokia-binaries.

Important: When testing inside scratchbox remember to start the signond daemon after the desktop is started. Signond is used for storing the account information and it's needed in order to get Sharing framework working properly

[sbox] > signond &

Also remember to install the debian .deb package build from your sources.

Creating sharing account is started from setting.

settings -> Sharing accounts -> New

Select your service and create new account. After one account is created you can use ImageViewer for sharing images and MediaPlayer for sharing video files.

[edit] Sharing your plugin with others

Maemo Extras repository is the best place for your plug-in if you want to get users for it. More information on how you can upload packages to Extras repository is available.

Before uploading plugin to public repositories make sure you have updated the Debian configuration files to match your information under ./debian folder.

Also make sure that the section is set to one of the valid sections listed in the packaging guide. For data sharing, use user/multimedia. This way the package will be installable by application manager. Below example version of debian control file.

Source: sharing-plugin-template
Section: user/multimedia
Priority: optional
Maintainer: Maemo Team <xxxx@maemo.org>
Build-Depends: debhelper (>= 5.0.0), 
   libgtk2.0-dev, libglib2.0-dev, 
   libconic0-dev, libosso-dev, 
   libsharing-plugin-dev
Standards-Version: 3.8.0