1 /* Copyright (c) 2007, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of the Nokia Corporation nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #include "libmodest-dbus-client.h"
31 #include <dbus_api/modest-dbus-api.h> /* For the API strings. */
33 //#define DBUS_API_SUBJECT_TO_CHANGE 1
34 #include <dbus/dbus.h>
35 #include <dbus/dbus-glib-lowlevel.h>
40 /** Get a comma-separated list of attachement URI strings,
41 * from a list of strings.
43 static gchar* get_attachments_string (GSList *attachments)
48 gchar *attachments_str = g_strdup("");
50 GSList *iter = attachments;
54 gchar *tmp = g_strconcat(attachments_str, ",", (gchar *) (iter->data), NULL);
55 g_free(attachments_str);
56 attachments_str = tmp;
59 iter = g_slist_next(iter);
62 return attachments_str;
66 * libmodest_dbus_client_mail_to:
67 * @osso_context: a valid #osso_context_t object.
68 * @mailto_uri: A mailto URI.
70 * This function will try to do a remote procedure call (rpc)
71 * into modest (or start it if necessary) and open a composer
72 * window with the supplied parameters prefilled.
74 * Return value: Whether or not the rpc call to modest
78 libmodest_dbus_client_mail_to (osso_context_t *osso_context, const gchar *mailto_uri)
81 const osso_return_t ret = osso_rpc_run_with_defaults(osso_context,
83 MODEST_DBUS_METHOD_MAIL_TO, &retval,
84 DBUS_TYPE_STRING, mailto_uri,
88 printf("debug: %s: osso_rpc_run() failed.\n", __FUNCTION__);
91 printf("debug: %s: osso_rpc_run() succeeded.\n", __FUNCTION__);
94 osso_rpc_free_val(&retval);
100 * libmodest_dbus_client_compose_mail:
101 * @osso_context: a valid #osso_context_t object.
102 * @to: The Recipients (From: line)
103 * @cc: Recipients for carbon copies
104 * @bcc: Recipients for blind carbon copies
105 * @subject: Subject line
106 * @body: The actual body of the mail to compose.
107 * @attachments: Additional list of attachments. A list of URI strings.
109 * This function will try to do a remote procedure call (rpc)
110 * into modest (or start it if necessary) and open a composer
111 * window with the supplied parameters prefilled.
113 * Return value: Whether or not the rpc call to modest
117 libmodest_dbus_client_compose_mail (osso_context_t *osso_context, const gchar *to, const gchar *cc,
118 const gchar *bcc, const gchar* subject, const gchar* body, GSList *attachments)
122 gchar *attachments_str = get_attachments_string(attachments);
124 const osso_return_t ret = osso_rpc_run_with_defaults(osso_context,
126 MODEST_DBUS_METHOD_COMPOSE_MAIL, &retval,
127 DBUS_TYPE_STRING, to,
128 DBUS_TYPE_STRING, cc,
129 DBUS_TYPE_STRING, bcc,
130 DBUS_TYPE_STRING, subject,
131 DBUS_TYPE_STRING, body,
132 DBUS_TYPE_STRING, attachments_str,
135 if (ret != OSSO_OK) {
136 printf("debug: %s: osso_rpc_run() failed.\n", __FUNCTION__);
139 printf("debug: %s: osso_rpc_run() succeeded.\n", __FUNCTION__);
142 osso_rpc_free_val(&retval);
144 g_free (attachments_str);
150 * libmodest_dbus_client_open_message:
151 * @osso_context: a valid #osso_context_t object.
152 * @msg_uri: A valid url to a mail
154 * This method will try to find the message supplied
155 * by @msg_uri and open it for display if found.
156 * It will use remote procedure calls (rpc) over
159 * Return value: TRUE on successs, FALSE on error
162 libmodest_dbus_client_open_message (osso_context_t *osso_context, const gchar *mail_uri)
165 const osso_return_t ret = osso_rpc_run_with_defaults(osso_context,
167 MODEST_DBUS_METHOD_OPEN_MESSAGE, &retval,
168 DBUS_TYPE_STRING, mail_uri,
171 if (ret != OSSO_OK) {
172 printf("debug: %s: osso_rpc_run() failed.\n", __FUNCTION__);
175 printf("debug: %s: osso_rpc_run() succeeded.\n", __FUNCTION__);
178 osso_rpc_free_val(&retval);
184 libmodest_dbus_client_send_and_receive (osso_context_t *osso_context)
187 const osso_return_t ret = osso_rpc_run_with_defaults(osso_context,
189 MODEST_DBUS_METHOD_SEND_RECEIVE, &retval,
192 if (ret != OSSO_OK) {
193 printf("debug: %s: osso_rpc_run() failed.\n", __FUNCTION__);
196 printf("debug: %s: osso_rpc_run() succeeded.\n", __FUNCTION__);
199 osso_rpc_free_val(&retval);
205 libmodest_dbus_client_open_default_inbox (osso_context_t *osso_context)
208 const osso_return_t ret = osso_rpc_run_with_defaults(osso_context,
210 MODEST_DBUS_METHOD_OPEN_DEFAULT_INBOX, &retval,
213 if (ret != OSSO_OK) {
214 printf("debug: %s: osso_rpc_run() failed.\n", __FUNCTION__);
217 printf("debug: %s: osso_rpc_run() succeeded.\n", __FUNCTION__);
220 osso_rpc_free_val(&retval);
226 libmodest_dbus_client_open_account (osso_context_t *osso_context,
227 const gchar *account_id)
230 const osso_return_t ret =
231 osso_rpc_run_with_defaults(osso_context,
233 MODEST_DBUS_METHOD_OPEN_ACCOUNT, &retval,
234 DBUS_TYPE_STRING, account_id,
237 if (ret != OSSO_OK) {
238 printf("debug: %s: osso_rpc_run() failed.\n", __FUNCTION__);
241 printf("debug: %s: osso_rpc_run() succeeded.\n", __FUNCTION__);
244 osso_rpc_free_val(&retval);
250 * libmodest_dbus_client_delete_message:
251 * @osso_context: a valid #osso_context_t object.
252 * @msg_uri: A valid url to a mail
254 * This method will try to find the message supplied
255 * by @msg_uri and if found delete it. It will use
256 * remote procedure calls (rpc) over dbus to do so.
258 * Return value: TRUE on successs, FALSE on error
261 libmodest_dbus_client_delete_message (osso_context_t *osso_ctx,
267 ret = osso_rpc_run_with_defaults (osso_ctx,
269 MODEST_DBUS_METHOD_DELETE_MESSAGE, &retval,
270 DBUS_TYPE_STRING, msg_uri,
273 if (ret != OSSO_OK) {
274 g_debug ("debug: osso_rpc_run() failed.\n");
276 g_debug ("debug: osso_rpc_run() succeeded.\n");
279 osso_rpc_free_val (&retval);
281 return ret == OSSO_OK;
285 modest_search_hit_free (ModestSearchHit *hit)
288 g_slice_free (ModestSearchHit, hit);
292 modest_search_hit_list_free (GList *hits)
300 for (iter = hits; iter; iter = iter->next) {
301 modest_search_hit_free ((ModestSearchHit *) iter->data);
308 _dbus_iter_get_string_or_null (DBusMessageIter *iter)
310 const char *string = NULL;
313 dbus_message_iter_get_basic (iter, &string);
315 if (string && strlen (string)) {
316 ret = g_strdup (string);
323 _dbus_iter_get_uint64 (DBusMessageIter *iter)
329 dbus_message_iter_get_basic (iter, &ui64v);
331 ret = (guint64) ui64v;
338 _dbus_iter_get_int64 (DBusMessageIter *iter)
344 dbus_message_iter_get_basic (iter, &i64v);
352 _dbus_iter_get_boolean (DBusMessageIter *iter)
359 dbus_message_iter_get_basic (iter, &val);
361 ret = (gboolean) val;
366 /** Get the values from the complex type (SEARCH_HIT_DBUS_TYPE)
367 * in the D-Bus return message. */
368 static ModestSearchHit *
369 modest_dbus_message_iter_get_search_hit (DBusMessageIter *parent)
371 ModestSearchHit *hit;
372 DBusMessageIter child;
378 hit = g_slice_new0 (ModestSearchHit);
380 arg_type = dbus_message_iter_get_arg_type (parent);
382 if (arg_type != 'r') {
386 dbus_message_iter_recurse (parent, &child);
389 arg_type = dbus_message_iter_get_arg_type (&child);
391 if (arg_type != DBUS_TYPE_STRING) {
396 hit->msgid = _dbus_iter_get_string_or_null (&child);
398 res = dbus_message_iter_next (&child);
405 arg_type = dbus_message_iter_get_arg_type (&child);
407 if (arg_type != DBUS_TYPE_STRING) {
412 hit->subject = _dbus_iter_get_string_or_null (&child);
414 res = dbus_message_iter_next (&child);
421 arg_type = dbus_message_iter_get_arg_type (&child);
423 if (arg_type != DBUS_TYPE_STRING) {
428 hit->folder = _dbus_iter_get_string_or_null (&child);
430 res = dbus_message_iter_next (&child);
437 arg_type = dbus_message_iter_get_arg_type (&child);
439 if (arg_type != DBUS_TYPE_STRING) {
444 hit->sender = _dbus_iter_get_string_or_null (&child);
446 res = dbus_message_iter_next (&child);
453 arg_type = dbus_message_iter_get_arg_type (&child);
455 if (arg_type != DBUS_TYPE_UINT64) {
460 hit->msize = _dbus_iter_get_uint64 (&child);
462 res = dbus_message_iter_next (&child);
469 arg_type = dbus_message_iter_get_arg_type (&child);
471 if (arg_type != DBUS_TYPE_BOOLEAN) {
476 hit->has_attachment = _dbus_iter_get_boolean (&child);
478 res = dbus_message_iter_next (&child);
485 arg_type = dbus_message_iter_get_arg_type (&child);
487 if (arg_type != DBUS_TYPE_BOOLEAN) {
492 hit->is_unread = _dbus_iter_get_boolean (&child);
494 res = dbus_message_iter_next (&child);
501 arg_type = dbus_message_iter_get_arg_type (&child);
503 if (arg_type != DBUS_TYPE_INT64) {
508 hit->timestamp = _dbus_iter_get_int64 (&child);
510 res = dbus_message_iter_next (&child);
518 g_warning ("%s: Error during unmarshalling", __FUNCTION__);
519 modest_search_hit_free (hit);
527 * libmodest_dbus_client_search:
528 * @osso_ctx: A valid #osso_context_t object.
529 * @query: The term to search for.
530 * @folder: An url to specific folder or %NULL to search everywhere.
531 * @start_date: Search hits before this date will be ignored.
532 * @end_date: Search hits after this date will be ignored.
533 * @min_size: Messagers smaller then this size will be ingored.
534 * @flags: A list of flags where to search so the documentation
535 * of %ModestDBusSearchFlags for details.
536 * @hits: A pointer to a valid GList pointer that will contain the search
537 * hits (ModestSearchHit). The list and the items must be freed by the caller
538 * with modest_search_hit_list_free().
540 * This method will search the folder specified by a valid url in @folder or all
541 * known accounts (local and remote) if %NULL for matches of the search term(s)
542 * specified in @query. It is legal to specify 0 in @start_date, @end_date and
543 * @min_size to ignore these parameters during the search otherwise those message
544 * that do not meet the specifed dates or size will be ignored.
545 * Where to search, be it subject, sender or the whole body can be specified by
546 * the @flags parameter.
548 * Upon success TRUE is returned and @hits will include the search hits or the list
549 * migh be empty if none of the messages matched the search criteria. The returned
550 * list must be freed with modest_search_hit_list_free (). It is save to pass
551 * %NULL to this function so you can call this function on the result list no matter
552 * if a hit was found or not (means the list is empty - i.e. %NULL)
553 * FALSE will only be return if an error during the remote procedure call (rpc)
554 * occured or if the specified folder could not be found.
556 * NOTE: The body of a message can only be searched if it was previously downloaded by
557 * modest. This function does also not attempt do to remote searches (i.e. IMAP search).
559 * Example to search every account for message containing "no":
560 * <informalexample><programlisting>
561 * ModestDBusSearchFlags flags;
562 * osso_context_t *osso_context;
567 * [...] Initialize osso context [...]
569 * res = libmodest_dbus_client_search (osso_context,
578 * for (iter = hits; iter; iter = iter->next) {
579 * ModestSearchHit *hit = (ModestSearchHit *) iter->data;
581 * [...] Do something with the hit [...]
585 * modest_search_hit_list_free (hits);
586 * </programlisting></informalexample>
588 * Return value: TRUE if the search succeded or FALSE for an error during the search
591 libmodest_dbus_client_search (osso_context_t *osso_ctx,
597 ModestDBusSearchFlags flags,
604 DBusMessageIter iter;
605 DBusMessageIter child;
606 DBusMessage *reply = NULL;
611 dbus_int32_t flags_v;
612 dbus_uint32_t size_v;
618 con = osso_get_dbus_connection (osso_ctx);
621 g_warning ("Could not get dbus connection\n");
627 msg = dbus_message_new_method_call (MODEST_DBUS_SERVICE,
630 MODEST_DBUS_METHOD_SEARCH);
633 //ULOG_ERR_F("dbus_message_new_method_call failed");
637 if (folder == NULL) {
641 sd_v = (dbus_int64_t) start_date;
642 ed_v = (dbus_int64_t) end_date;
643 flags_v = (dbus_int32_t) flags;
644 size_v = (dbus_uint32_t) min_size;
646 res = dbus_message_append_args (msg,
647 DBUS_TYPE_STRING, &query,
648 DBUS_TYPE_STRING, &folder,
649 DBUS_TYPE_INT64, &sd_v,
650 DBUS_TYPE_INT64, &ed_v,
651 DBUS_TYPE_INT32, &flags_v,
652 DBUS_TYPE_UINT32, &size_v,
655 dbus_message_set_auto_start (msg, TRUE);
657 /* Use a long timeout (2 minutes) because the search currently
658 * gets folders and messages from the servers. */
659 timeout = 120000; //milliseconds.
660 //osso_rpc_get_timeout (osso_ctx, &timeout);
662 /*printf("DEBUG: %s: Before dbus_connection_send_with_reply_and_block().\n",
664 /* TODO: Detect the timeout somehow. */
666 dbus_error_init (&err);
667 reply = dbus_connection_send_with_reply_and_block (con,
671 /* printf("DEBUG: %s: dbus_connection_send_with_reply_and_block() finished.\n",
674 dbus_message_unref (msg);
677 g_warning("%s: dbus_connection_send_with_reply_and_block() error: %s",
678 __FUNCTION__, err.message);
682 switch (dbus_message_get_type (reply)) {
684 case DBUS_MESSAGE_TYPE_ERROR:
685 dbus_set_error_from_message (&err, reply);
687 dbus_error_free (&err);
688 dbus_message_unref (reply);
691 case DBUS_MESSAGE_TYPE_METHOD_RETURN:
692 /* ok we are good to go
693 * lets drop outa here and handle that */
696 //ULOG_WARN_F("got unknown message type as reply");
697 //retval->type = DBUS_TYPE_STRING;
698 //retval->value.s = g_strdup("Invalid return value");
700 dbus_message_unref (reply);
704 g_debug ("%s: message return", __FUNCTION__);
706 dbus_message_iter_init (reply, &iter);
707 arg_type = dbus_message_iter_get_arg_type (&iter);
709 dbus_message_iter_recurse (&iter, &child);
713 ModestSearchHit *hit;
715 hit = modest_dbus_message_iter_get_search_hit (&child);
718 *hits = g_list_prepend (*hits, hit);
721 } while (dbus_message_iter_next (&child));
723 dbus_message_unref (reply);
726 /* TODO: This is from osso source, do we need it? */
728 /* Tell TaskNavigator to show "launch banner" */
729 msg = dbus_message_new_method_call (TASK_NAV_SERVICE,
730 APP_LAUNCH_BANNER_METHOD_PATH,
731 APP_LAUNCH_BANNER_METHOD_INTERFACE,
732 APP_LAUNCH_BANNER_METHOD);
735 g_warn ("dbus_message_new_method_call failed");
740 dbus_message_append_args (msg,
745 b = dbus_connection_send (conn, msg, NULL);
748 ULOG_WARN_F("dbus_connection_send failed");
751 dbus_message_unref (msg);
759 modest_folder_result_free (ModestFolderResult *item)
761 g_free (item->folder_name);
762 g_free (item->folder_uri);
763 g_slice_free (ModestFolderResult, item);
767 modest_folder_result_list_free (GList *list)
775 for (iter = list; iter; iter = iter->next) {
776 modest_folder_result_free ((ModestFolderResult *) iter->data);
783 /** Get the values from the complex type (GET_FOLDERS_RESULT_DBUS_TYPE)
784 * in the D-Bus return message. */
785 static ModestFolderResult *
786 modest_dbus_message_iter_get_folder_item (DBusMessageIter *parent)
788 gboolean error = FALSE;
789 ModestFolderResult *item = g_slice_new0 (ModestFolderResult);
791 int arg_type = dbus_message_iter_get_arg_type (parent);
793 if (arg_type != 'r') {
797 DBusMessageIter child;
798 dbus_message_iter_recurse (parent, &child);
801 arg_type = dbus_message_iter_get_arg_type (&child);
803 if (arg_type != DBUS_TYPE_STRING) {
808 item->folder_name = _dbus_iter_get_string_or_null (&child);
811 dbus_bool_t res = dbus_message_iter_next (&child);
818 arg_type = dbus_message_iter_get_arg_type (&child);
820 if (arg_type != DBUS_TYPE_STRING) {
825 item->folder_uri = _dbus_iter_get_string_or_null (&child);
830 g_warning ("%s: Error during unmarshalling", __FUNCTION__);
831 modest_folder_result_free (item);
839 * libmodest_dbus_client_get_folders:
840 * @osso_ctx: A valid #osso_context_t object.
841 * @folders: A pointer to a valid GList pointer that will contain the folder items
842 * (ModestFolderResult). The list and the items must be freed by the caller
843 * with modest_folder_result_list_free().
845 * This method will obtain a list of folders in the default account.
847 * Upon success TRUE is returned and @folders will include the folders or the list
848 * might be empty if there are no folders. The returned
849 * list must be freed with modest_folder_result_list_free ().
851 * NOTE: A folder will only be retrieved if it was previously downloaded by
852 * modest. This function does also not attempt do to remote refreshes (i.e. IMAP).
854 * Return value: TRUE if the request succeded or FALSE for an error.
857 libmodest_dbus_client_get_folders (osso_context_t *osso_ctx,
860 /* Initialize output argument: */
866 DBusConnection *con = osso_get_dbus_connection (osso_ctx);
869 g_warning ("Could not get dbus connection\n");
874 DBusMessage *msg = dbus_message_new_method_call (MODEST_DBUS_SERVICE,
877 MODEST_DBUS_METHOD_GET_FOLDERS);
880 //ULOG_ERR_F("dbus_message_new_method_call failed");
884 dbus_message_set_auto_start (msg, TRUE);
886 /* Use a long timeout (2 minutes) because the search currently
887 * gets folders from the servers. */
888 gint timeout = 120000;
889 //osso_rpc_get_timeout (osso_ctx, &timeout);
892 dbus_error_init (&err);
893 DBusMessage *reply = dbus_connection_send_with_reply_and_block (con,
898 dbus_message_unref (msg);
902 g_warning("%s: dbus_connection_send_with_reply_and_block() error:\n %s",
903 __FUNCTION__, err.message);
907 switch (dbus_message_get_type (reply)) {
909 case DBUS_MESSAGE_TYPE_ERROR:
910 dbus_set_error_from_message (&err, reply);
912 dbus_error_free (&err);
913 dbus_message_unref (reply);
916 case DBUS_MESSAGE_TYPE_METHOD_RETURN:
917 /* ok we are good to go
918 * lets drop outa here and handle that */
921 //ULOG_WARN_F("got unknown message type as reply");
922 //retval->type = DBUS_TYPE_STRING;
923 //retval->value.s = g_strdup("Invalid return value");
925 dbus_message_unref (reply);
929 g_debug ("%s: message return", __FUNCTION__);
931 DBusMessageIter iter;
932 dbus_message_iter_init (reply, &iter);
933 /* int arg_type = dbus_message_iter_get_arg_type (&iter); */
935 DBusMessageIter child;
936 dbus_message_iter_recurse (&iter, &child);
939 ModestFolderResult *item = modest_dbus_message_iter_get_folder_item (&child);
942 *folders = g_list_append (*folders, item);
945 } while (dbus_message_iter_next (&child));
947 dbus_message_unref (reply);
950 /* TODO: This is from osso source, do we need it? */
952 /* Tell TaskNavigator to show "launch banner" */
953 msg = dbus_message_new_method_call (TASK_NAV_SERVICE,
954 APP_LAUNCH_BANNER_METHOD_PATH,
955 APP_LAUNCH_BANNER_METHOD_INTERFACE,
956 APP_LAUNCH_BANNER_METHOD);
959 g_warn ("dbus_message_new_method_call failed");
964 dbus_message_append_args (msg,
969 b = dbus_connection_send (conn, msg, NULL);
972 ULOG_WARN_F("dbus_connection_send failed");
975 dbus_message_unref (msg);