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
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_delete_message:
227 * @osso_context: a valid #osso_context_t object.
228 * @msg_uri: A valid url to a mail
230 * This method will try to find the message supplied
231 * by @msg_uri and if found delete it. It will use
232 * remote procedure calls (rpc) over dbus to do so.
234 * Return value: TRUE on successs, FALSE on error
237 libmodest_dbus_client_delete_message (osso_context_t *osso_ctx,
243 ret = osso_rpc_run_with_defaults (osso_ctx,
245 MODEST_DBUS_METHOD_DELETE_MESSAGE, &retval,
246 DBUS_TYPE_STRING, msg_uri,
249 if (ret != OSSO_OK) {
250 g_debug ("debug: osso_rpc_run() failed.\n");
252 g_debug ("debug: osso_rpc_run() succeeded.\n");
255 osso_rpc_free_val (&retval);
257 return ret == OSSO_OK;
261 modest_search_hit_free (ModestSearchHit *hit)
264 g_slice_free (ModestSearchHit, hit);
268 modest_search_hit_list_free (GList *hits)
276 for (iter = hits; iter; iter = iter->next) {
277 modest_search_hit_free ((ModestSearchHit *) iter->data);
284 _dbus_iter_get_string_or_null (DBusMessageIter *iter)
286 const char *string = NULL;
289 dbus_message_iter_get_basic (iter, &string);
291 if (string && strlen (string)) {
292 ret = g_strdup (string);
299 _dbus_iter_get_uint64 (DBusMessageIter *iter)
305 dbus_message_iter_get_basic (iter, &ui64v);
307 ret = (guint64) ui64v;
314 _dbus_iter_get_int64 (DBusMessageIter *iter)
320 dbus_message_iter_get_basic (iter, &i64v);
328 _dbus_iter_get_boolean (DBusMessageIter *iter)
335 dbus_message_iter_get_basic (iter, &val);
337 ret = (gboolean) val;
342 /** Get the values from the complex type (SEARCH_HIT_DBUS_TYPE)
343 * in the D-Bus return message. */
344 static ModestSearchHit *
345 modest_dbus_message_iter_get_search_hit (DBusMessageIter *parent)
347 ModestSearchHit *hit;
348 DBusMessageIter child;
354 hit = g_slice_new0 (ModestSearchHit);
356 arg_type = dbus_message_iter_get_arg_type (parent);
358 if (arg_type != 'r') {
362 dbus_message_iter_recurse (parent, &child);
365 arg_type = dbus_message_iter_get_arg_type (&child);
367 if (arg_type != DBUS_TYPE_STRING) {
372 hit->msgid = _dbus_iter_get_string_or_null (&child);
374 res = dbus_message_iter_next (&child);
381 arg_type = dbus_message_iter_get_arg_type (&child);
383 if (arg_type != DBUS_TYPE_STRING) {
388 hit->subject = _dbus_iter_get_string_or_null (&child);
390 res = dbus_message_iter_next (&child);
397 arg_type = dbus_message_iter_get_arg_type (&child);
399 if (arg_type != DBUS_TYPE_STRING) {
404 hit->folder = _dbus_iter_get_string_or_null (&child);
406 res = dbus_message_iter_next (&child);
413 arg_type = dbus_message_iter_get_arg_type (&child);
415 if (arg_type != DBUS_TYPE_STRING) {
420 hit->sender = _dbus_iter_get_string_or_null (&child);
422 res = dbus_message_iter_next (&child);
429 arg_type = dbus_message_iter_get_arg_type (&child);
431 if (arg_type != DBUS_TYPE_UINT64) {
436 hit->msize = _dbus_iter_get_uint64 (&child);
438 res = dbus_message_iter_next (&child);
445 arg_type = dbus_message_iter_get_arg_type (&child);
447 if (arg_type != DBUS_TYPE_BOOLEAN) {
452 hit->has_attachment = _dbus_iter_get_boolean (&child);
454 res = dbus_message_iter_next (&child);
461 arg_type = dbus_message_iter_get_arg_type (&child);
463 if (arg_type != DBUS_TYPE_BOOLEAN) {
468 hit->is_unread = _dbus_iter_get_boolean (&child);
470 res = dbus_message_iter_next (&child);
477 arg_type = dbus_message_iter_get_arg_type (&child);
479 if (arg_type != DBUS_TYPE_INT64) {
484 hit->timestamp = _dbus_iter_get_int64 (&child);
486 res = dbus_message_iter_next (&child);
494 g_warning ("%s: Error during unmarshalling", __FUNCTION__);
495 modest_search_hit_free (hit);
503 * libmodest_dbus_client_search:
504 * @osso_ctx: A valid #osso_context_t object.
505 * @query: The term to search for.
506 * @folder: An url to specific folder or %NULL to search everywhere.
507 * @start_date: Search hits before this date will be ignored.
508 * @end_date: Search hits after this date will be ignored.
509 * @min_size: Messagers smaller then this size will be ingored.
510 * @flags: A list of flags where to search so the documentation
511 * of %ModestDBusSearchFlags for details.
512 * @hits: A pointer to a valid GList pointer that will contain the search
513 * hits (ModestSearchHit). The list and the items must be freed by the caller
514 * with modest_search_hit_list_free().
516 * This method will search the folder specified by a valid url in @folder or all
517 * known accounts (local and remote) if %NULL for matches of the search term(s)
518 * specified in @query. It is legal to specify 0 in @start_date, @end_date and
519 * @min_size to ignore these parameters during the search otherwise those message
520 * that do not meet the specifed dates or size will be ignored.
521 * Where to search, be it subject, sender or the whole body can be specified by
522 * the @flags parameter.
524 * Upon success TRUE is returned and @hits will include the search hits or the list
525 * migh be empty if none of the messages matched the search criteria. The returned
526 * list must be freed with modest_search_hit_list_free (). It is save to pass
527 * %NULL to this function so you can call this function on the result list no matter
528 * if a hit was found or not (means the list is empty - i.e. %NULL)
529 * FALSE will only be return if an error during the remote procedure call (rpc)
530 * occured or if the specified folder could not be found.
532 * NOTE: The body of a message can only be searched if it was previously downloaded by
533 * modest. This function does also not attempt do to remote searches (i.e. IMAP search).
535 * Example to search every account for message containing "no":
536 * <informalexample><programlisting>
537 * ModestDBusSearchFlags flags;
538 * osso_context_t *osso_context;
543 * [...] Initialize osso context [...]
545 * res = libmodest_dbus_client_search (osso_context,
554 * for (iter = hits; iter; iter = iter->next) {
555 * ModestSearchHit *hit = (ModestSearchHit *) iter->data;
557 * [...] Do something with the hit [...]
561 * modest_search_hit_list_free (hits);
562 * </programlisting></informalexample>
564 * Return value: TRUE if the search succeded or FALSE for an error during the search
567 libmodest_dbus_client_search (osso_context_t *osso_ctx,
573 ModestDBusSearchFlags flags,
580 DBusMessageIter iter;
581 DBusMessageIter child;
582 DBusMessage *reply = NULL;
587 dbus_int32_t flags_v;
588 dbus_uint32_t size_v;
594 con = osso_get_dbus_connection (osso_ctx);
597 g_warning ("Could not get dbus connection\n");
603 msg = dbus_message_new_method_call (MODEST_DBUS_SERVICE,
606 MODEST_DBUS_METHOD_SEARCH);
609 //ULOG_ERR_F("dbus_message_new_method_call failed");
613 if (folder == NULL) {
619 flags_v = (dbus_int32_t) flags;
620 size_v = (dbus_uint32_t) min_size;
622 res = dbus_message_append_args (msg,
623 DBUS_TYPE_STRING, &query,
624 DBUS_TYPE_STRING, &folder,
625 DBUS_TYPE_INT64, &sd_v,
626 DBUS_TYPE_INT64, &ed_v,
627 DBUS_TYPE_INT32, &flags_v,
628 DBUS_TYPE_UINT32, &size_v,
631 dbus_message_set_auto_start (msg, TRUE);
633 /* Use a long timeout (2 minutes) because the search currently
634 * gets folders and messages from the servers. */
635 timeout = 120000; //milliseconds.
636 //osso_rpc_get_timeout (osso_ctx, &timeout);
638 /*printf("DEBUG: %s: Before dbus_connection_send_with_reply_and_block().\n",
640 /* TODO: Detect the timeout somehow. */
642 dbus_error_init (&err);
643 reply = dbus_connection_send_with_reply_and_block (con,
647 /* printf("DEBUG: %s: dbus_connection_send_with_reply_and_block() finished.\n",
650 dbus_message_unref (msg);
653 g_warning("%s: dbus_connection_send_with_reply_and_block() error: %s",
654 __FUNCTION__, err.message);
658 switch (dbus_message_get_type (reply)) {
660 case DBUS_MESSAGE_TYPE_ERROR:
661 dbus_set_error_from_message (&err, reply);
663 dbus_error_free (&err);
664 dbus_message_unref (reply);
667 case DBUS_MESSAGE_TYPE_METHOD_RETURN:
668 /* ok we are good to go
669 * lets drop outa here and handle that */
672 //ULOG_WARN_F("got unknown message type as reply");
673 //retval->type = DBUS_TYPE_STRING;
674 //retval->value.s = g_strdup("Invalid return value");
676 dbus_message_unref (reply);
680 g_debug ("%s: message return", __FUNCTION__);
682 dbus_message_iter_init (reply, &iter);
683 arg_type = dbus_message_iter_get_arg_type (&iter);
685 dbus_message_iter_recurse (&iter, &child);
689 ModestSearchHit *hit;
691 hit = modest_dbus_message_iter_get_search_hit (&child);
694 *hits = g_list_prepend (*hits, hit);
697 } while (dbus_message_iter_next (&child));
699 dbus_message_unref (reply);
702 /* TODO: This is from osso source, do we need it? */
704 /* Tell TaskNavigator to show "launch banner" */
705 msg = dbus_message_new_method_call (TASK_NAV_SERVICE,
706 APP_LAUNCH_BANNER_METHOD_PATH,
707 APP_LAUNCH_BANNER_METHOD_INTERFACE,
708 APP_LAUNCH_BANNER_METHOD);
711 g_warn ("dbus_message_new_method_call failed");
716 dbus_message_append_args (msg,
721 b = dbus_connection_send (conn, msg, NULL);
724 ULOG_WARN_F("dbus_connection_send failed");
727 dbus_message_unref (msg);
735 modest_folder_result_free (ModestFolderResult *item)
737 g_free (item->folder_name);
738 g_free (item->folder_uri);
739 g_slice_free (ModestFolderResult, item);
743 modest_folder_result_list_free (GList *list)
751 for (iter = list; iter; iter = iter->next) {
752 modest_folder_result_free ((ModestFolderResult *) iter->data);
759 /** Get the values from the complex type (GET_FOLDERS_RESULT_DBUS_TYPE)
760 * in the D-Bus return message. */
761 static ModestFolderResult *
762 modest_dbus_message_iter_get_folder_item (DBusMessageIter *parent)
764 gboolean error = FALSE;
765 ModestFolderResult *item = g_slice_new0 (ModestFolderResult);
767 int arg_type = dbus_message_iter_get_arg_type (parent);
769 if (arg_type != 'r') {
773 DBusMessageIter child;
774 dbus_message_iter_recurse (parent, &child);
777 arg_type = dbus_message_iter_get_arg_type (&child);
779 if (arg_type != DBUS_TYPE_STRING) {
784 item->folder_name = _dbus_iter_get_string_or_null (&child);
787 dbus_bool_t res = dbus_message_iter_next (&child);
794 arg_type = dbus_message_iter_get_arg_type (&child);
796 if (arg_type != DBUS_TYPE_STRING) {
801 item->folder_uri = _dbus_iter_get_string_or_null (&child);
806 g_warning ("%s: Error during unmarshalling", __FUNCTION__);
807 modest_folder_result_free (item);
815 * libmodest_dbus_client_get_folders:
816 * @osso_ctx: A valid #osso_context_t object.
817 * @folders: A pointer to a valid GList pointer that will contain the folder items
818 * (ModestFolderResult). The list and the items must be freed by the caller
819 * with modest_folder_result_list_free().
821 * This method will obtain a list of folders in the default account.
823 * Upon success TRUE is returned and @folders will include the folders or the list
824 * might be empty if there are no folders. The returned
825 * list must be freed with modest_folder_result_list_free ().
827 * NOTE: A folder will only be retrieved if it was previously downloaded by
828 * modest. This function does also not attempt do to remote refreshes (i.e. IMAP).
830 * Return value: TRUE if the request succeded or FALSE for an error.
833 libmodest_dbus_client_get_folders (osso_context_t *osso_ctx,
836 /* Initialize output argument: */
842 DBusConnection *con = osso_get_dbus_connection (osso_ctx);
845 g_warning ("Could not get dbus connection\n");
850 DBusMessage *msg = dbus_message_new_method_call (MODEST_DBUS_SERVICE,
853 MODEST_DBUS_METHOD_GET_FOLDERS);
856 //ULOG_ERR_F("dbus_message_new_method_call failed");
860 dbus_message_set_auto_start (msg, TRUE);
862 /* Use a long timeout (2 minutes) because the search currently
863 * gets folders from the servers. */
864 gint timeout = 120000;
865 //osso_rpc_get_timeout (osso_ctx, &timeout);
868 dbus_error_init (&err);
869 DBusMessage *reply = dbus_connection_send_with_reply_and_block (con,
874 dbus_message_unref (msg);
878 g_warning("%s: dbus_connection_send_with_reply_and_block() error:\n %s",
879 __FUNCTION__, err.message);
883 switch (dbus_message_get_type (reply)) {
885 case DBUS_MESSAGE_TYPE_ERROR:
886 dbus_set_error_from_message (&err, reply);
888 dbus_error_free (&err);
889 dbus_message_unref (reply);
892 case DBUS_MESSAGE_TYPE_METHOD_RETURN:
893 /* ok we are good to go
894 * lets drop outa here and handle that */
897 //ULOG_WARN_F("got unknown message type as reply");
898 //retval->type = DBUS_TYPE_STRING;
899 //retval->value.s = g_strdup("Invalid return value");
901 dbus_message_unref (reply);
905 g_debug ("%s: message return", __FUNCTION__);
907 DBusMessageIter iter;
908 dbus_message_iter_init (reply, &iter);
909 /* int arg_type = dbus_message_iter_get_arg_type (&iter); */
911 DBusMessageIter child;
912 dbus_message_iter_recurse (&iter, &child);
915 ModestFolderResult *item = modest_dbus_message_iter_get_folder_item (&child);
918 *folders = g_list_append (*folders, item);
921 } while (dbus_message_iter_next (&child));
923 dbus_message_unref (reply);
926 /* TODO: This is from osso source, do we need it? */
928 /* Tell TaskNavigator to show "launch banner" */
929 msg = dbus_message_new_method_call (TASK_NAV_SERVICE,
930 APP_LAUNCH_BANNER_METHOD_PATH,
931 APP_LAUNCH_BANNER_METHOD_INTERFACE,
932 APP_LAUNCH_BANNER_METHOD);
935 g_warn ("dbus_message_new_method_call failed");
940 dbus_message_append_args (msg,
945 b = dbus_connection_send (conn, msg, NULL);
948 ULOG_WARN_F("dbus_connection_send failed");
951 dbus_message_unref (msg);