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 "libmodest-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;
56 escaped = g_uri_escape_string ((const gchar *) (iter->data), NULL, TRUE);
57 tmp = g_strconcat(attachments_str, ",", escaped, NULL);
59 g_free(attachments_str);
60 attachments_str = tmp;
62 iter = g_slist_next(iter);
64 return attachments_str;
68 * libmodest_dbus_client_mail_to:
69 * @osso_context: a valid #osso_context_t object.
70 * @mailto_uri: A mailto URI.
72 * This function will try to do a remote procedure call (rpc)
73 * into modest (or start it if necessary) and open a composer
74 * window with the supplied parameters prefilled.
76 * Return value: Whether or not the rpc call to modest
80 libmodest_dbus_client_mail_to (osso_context_t *osso_context, const gchar *mailto_uri)
82 osso_rpc_t retval = { 0 };
83 const osso_return_t ret = osso_rpc_run_with_defaults(osso_context,
85 MODEST_DBUS_METHOD_MAIL_TO, &retval,
86 DBUS_TYPE_STRING, mailto_uri,
90 printf("debug: %s: osso_rpc_run() failed.\n", __FUNCTION__);
93 printf("debug: %s: osso_rpc_run() succeeded.\n", __FUNCTION__);
96 osso_rpc_free_val(&retval);
102 * libmodest_dbus_client_compose_mail:
103 * @osso_context: a valid #osso_context_t object.
104 * @to: The Recipients (From: line)
105 * @cc: Recipients for carbon copies
106 * @bcc: Recipients for blind carbon copies
107 * @subject: Subject line
108 * @body: The actual body of the mail to compose.
109 * @attachments: Additional list of attachments. A list of URI strings.
111 * This function will try to do a remote procedure call (rpc)
112 * into modest (or start it if necessary) and open a composer
113 * window with the supplied parameters prefilled.
115 * Return value: Whether or not the rpc call to modest
119 libmodest_dbus_client_compose_mail (osso_context_t *osso_context, const gchar *to, const gchar *cc,
120 const gchar *bcc, const gchar* subject, const gchar* body, GSList *attachments)
122 osso_rpc_t retval = { 0 };
124 gchar *attachments_str = get_attachments_string(attachments);
126 const osso_return_t ret = osso_rpc_run_with_defaults(osso_context,
128 MODEST_DBUS_METHOD_COMPOSE_MAIL, &retval,
129 DBUS_TYPE_STRING, to,
130 DBUS_TYPE_STRING, cc,
131 DBUS_TYPE_STRING, bcc,
132 DBUS_TYPE_STRING, subject,
133 DBUS_TYPE_STRING, body,
134 DBUS_TYPE_STRING, attachments_str,
137 g_free (attachments_str);
139 if (ret != OSSO_OK) {
140 printf("debug: %s: osso_rpc_run() failed.\n", __FUNCTION__);
143 printf("debug: %s: osso_rpc_run() succeeded.\n", __FUNCTION__);
146 osso_rpc_free_val(&retval);
153 * libmodest_dbus_client_open_message:
154 * @osso_context: a valid #osso_context_t object.
155 * @msg_uri: A valid url to a mail
157 * This method will try to find the message supplied
158 * by @msg_uri and open it for display if found.
159 * It will use remote procedure calls (rpc) over
162 * Return value: TRUE on successs, FALSE on error
165 libmodest_dbus_client_open_message (osso_context_t *osso_context, const gchar *mail_uri)
167 osso_rpc_t retval = { 0 };
168 const osso_return_t ret = osso_rpc_run_with_defaults(osso_context,
170 MODEST_DBUS_METHOD_OPEN_MESSAGE, &retval,
171 DBUS_TYPE_STRING, mail_uri,
174 if (ret != OSSO_OK) {
175 printf("debug: %s: osso_rpc_run() failed.\n", __FUNCTION__);
178 printf("debug: %s: osso_rpc_run() succeeded.\n", __FUNCTION__);
181 osso_rpc_free_val(&retval);
187 libmodest_dbus_client_send_and_receive (osso_context_t *osso_context)
189 osso_rpc_t retval = { 0 };
190 const osso_return_t ret = osso_rpc_run_with_defaults(osso_context,
192 MODEST_DBUS_METHOD_SEND_RECEIVE, &retval,
195 if (ret != OSSO_OK) {
196 printf("debug: %s: osso_rpc_run() failed.\n", __FUNCTION__);
199 printf("debug: %s: osso_rpc_run() succeeded.\n", __FUNCTION__);
202 osso_rpc_free_val(&retval);
208 libmodest_dbus_client_send_and_receive_full (osso_context_t *osso_context,
209 const gchar *account,
212 osso_rpc_t retval = { 0 };
213 const osso_return_t ret = osso_rpc_run_with_defaults(osso_context,
215 MODEST_DBUS_METHOD_SEND_RECEIVE_FULL, &retval,
216 DBUS_TYPE_STRING, account,
217 DBUS_TYPE_BOOLEAN, manual,
220 if (ret != OSSO_OK) {
221 printf("debug: %s: osso_rpc_run() failed.\n", __FUNCTION__);
224 printf("debug: %s: osso_rpc_run() succeeded.\n", __FUNCTION__);
227 osso_rpc_free_val(&retval);
233 libmodest_dbus_client_open_default_inbox (osso_context_t *osso_context)
235 osso_rpc_t retval = { 0 };
236 const osso_return_t ret = osso_rpc_run_with_defaults(osso_context,
238 MODEST_DBUS_METHOD_OPEN_DEFAULT_INBOX, &retval,
241 if (ret != OSSO_OK) {
242 printf("debug: %s: osso_rpc_run() failed.\n", __FUNCTION__);
245 printf("debug: %s: osso_rpc_run() succeeded.\n", __FUNCTION__);
248 osso_rpc_free_val(&retval);
254 libmodest_dbus_client_open_account (osso_context_t *osso_context,
255 const gchar *account_id)
257 osso_rpc_t retval = { 0 };
258 const osso_return_t ret =
259 osso_rpc_run_with_defaults(osso_context,
261 MODEST_DBUS_METHOD_OPEN_ACCOUNT, &retval,
262 DBUS_TYPE_STRING, account_id,
265 if (ret != OSSO_OK) {
266 printf("debug: %s: osso_rpc_run() failed.\n", __FUNCTION__);
269 printf("debug: %s: osso_rpc_run() succeeded.\n", __FUNCTION__);
272 osso_rpc_free_val(&retval);
278 * libmodest_dbus_client_delete_message:
279 * @osso_context: a valid #osso_context_t object.
280 * @msg_uri: A valid url to a mail
282 * This method will try to find the message supplied
283 * by @msg_uri and if found delete it. It will use
284 * remote procedure calls (rpc) over dbus to do so.
286 * Return value: TRUE on successs, FALSE on error
289 libmodest_dbus_client_delete_message (osso_context_t *osso_ctx,
292 osso_rpc_t retval = { 0 };
295 ret = osso_rpc_run_with_defaults (osso_ctx,
297 MODEST_DBUS_METHOD_DELETE_MESSAGE, &retval,
298 DBUS_TYPE_STRING, msg_uri,
301 if (ret != OSSO_OK) {
302 g_debug ("debug: osso_rpc_run() failed.\n");
304 g_debug ("debug: osso_rpc_run() succeeded.\n");
307 osso_rpc_free_val (&retval);
309 return ret == OSSO_OK;
313 modest_search_hit_free (ModestSearchHit *hit)
316 g_slice_free (ModestSearchHit, hit);
320 modest_search_hit_list_free (GList *hits)
328 for (iter = hits; iter; iter = iter->next) {
329 modest_search_hit_free ((ModestSearchHit *) iter->data);
336 _dbus_iter_get_string_or_null (DBusMessageIter *iter)
338 const char *string = NULL;
341 dbus_message_iter_get_basic (iter, &string);
343 if (string && strlen (string)) {
344 ret = g_strdup (string);
351 _dbus_iter_get_uint64 (DBusMessageIter *iter)
357 dbus_message_iter_get_basic (iter, &ui64v);
359 ret = (guint64) ui64v;
366 _dbus_iter_get_int64 (DBusMessageIter *iter)
372 dbus_message_iter_get_basic (iter, &i64v);
380 _dbus_iter_get_boolean (DBusMessageIter *iter)
387 dbus_message_iter_get_basic (iter, &val);
389 ret = (gboolean) val;
394 /** Get the values from the complex type (SEARCH_HIT_DBUS_TYPE)
395 * in the D-Bus return message. */
396 static ModestSearchHit *
397 modest_dbus_message_iter_get_search_hit (DBusMessageIter *parent)
399 ModestSearchHit *hit;
400 DBusMessageIter child;
406 hit = g_slice_new0 (ModestSearchHit);
408 arg_type = dbus_message_iter_get_arg_type (parent);
410 if (arg_type != 'r') {
414 dbus_message_iter_recurse (parent, &child);
417 arg_type = dbus_message_iter_get_arg_type (&child);
419 if (arg_type != DBUS_TYPE_STRING) {
424 hit->msgid = _dbus_iter_get_string_or_null (&child);
426 res = dbus_message_iter_next (&child);
433 arg_type = dbus_message_iter_get_arg_type (&child);
435 if (arg_type != DBUS_TYPE_STRING) {
440 hit->subject = _dbus_iter_get_string_or_null (&child);
442 res = dbus_message_iter_next (&child);
449 arg_type = dbus_message_iter_get_arg_type (&child);
451 if (arg_type != DBUS_TYPE_STRING) {
456 hit->folder = _dbus_iter_get_string_or_null (&child);
458 res = dbus_message_iter_next (&child);
465 arg_type = dbus_message_iter_get_arg_type (&child);
467 if (arg_type != DBUS_TYPE_STRING) {
472 hit->sender = _dbus_iter_get_string_or_null (&child);
474 res = dbus_message_iter_next (&child);
481 arg_type = dbus_message_iter_get_arg_type (&child);
483 if (arg_type != DBUS_TYPE_UINT64) {
488 hit->msize = _dbus_iter_get_uint64 (&child);
490 res = dbus_message_iter_next (&child);
497 arg_type = dbus_message_iter_get_arg_type (&child);
499 if (arg_type != DBUS_TYPE_BOOLEAN) {
504 hit->has_attachment = _dbus_iter_get_boolean (&child);
506 res = dbus_message_iter_next (&child);
513 arg_type = dbus_message_iter_get_arg_type (&child);
515 if (arg_type != DBUS_TYPE_BOOLEAN) {
520 hit->is_unread = _dbus_iter_get_boolean (&child);
522 res = dbus_message_iter_next (&child);
529 arg_type = dbus_message_iter_get_arg_type (&child);
531 if (arg_type != DBUS_TYPE_INT64) {
536 hit->timestamp = _dbus_iter_get_int64 (&child);
538 res = dbus_message_iter_next (&child);
546 g_warning ("%s: Error during unmarshalling", __FUNCTION__);
547 modest_search_hit_free (hit);
555 * libmodest_dbus_client_search:
556 * @osso_ctx: A valid #osso_context_t object.
557 * @query: The term to search for.
558 * @folder: An url to specific folder or %NULL to search everywhere.
559 * @start_date: Search hits before this date will be ignored.
560 * @end_date: Search hits after this date will be ignored.
561 * @min_size: Messagers smaller then this size will be ingored.
562 * @flags: A list of flags where to search so the documentation
563 * of %ModestDBusSearchFlags for details.
564 * @hits: A pointer to a valid GList pointer that will contain the search
565 * hits (ModestSearchHit). The list and the items must be freed by the caller
566 * with modest_search_hit_list_free().
568 * This method will search the folder specified by a valid url in @folder or all
569 * known accounts (local and remote) if %NULL for matches of the search term(s)
570 * specified in @query. It is legal to specify 0 in @start_date, @end_date and
571 * @min_size to ignore these parameters during the search otherwise those message
572 * that do not meet the specifed dates or size will be ignored.
573 * Where to search, be it subject, sender or the whole body can be specified by
574 * the @flags parameter.
576 * Upon success TRUE is returned and @hits will include the search hits or the list
577 * migh be empty if none of the messages matched the search criteria. The returned
578 * list must be freed with modest_search_hit_list_free (). It is save to pass
579 * %NULL to this function so you can call this function on the result list no matter
580 * if a hit was found or not (means the list is empty - i.e. %NULL)
581 * FALSE will only be return if an error during the remote procedure call (rpc)
582 * occured or if the specified folder could not be found.
584 * NOTE: The body of a message can only be searched if it was previously downloaded by
585 * modest. This function does also not attempt do to remote searches (i.e. IMAP search).
587 * Example to search every account for message containing "no":
588 * <informalexample><programlisting>
589 * ModestDBusSearchFlags flags;
590 * osso_context_t *osso_context;
595 * [...] Initialize osso context [...]
597 * res = libmodest_dbus_client_search (osso_context,
606 * for (iter = hits; iter; iter = iter->next) {
607 * ModestSearchHit *hit = (ModestSearchHit *) iter->data;
609 * [...] Do something with the hit [...]
613 * modest_search_hit_list_free (hits);
614 * </programlisting></informalexample>
616 * Return value: TRUE if the search succeded or FALSE for an error during the search
619 libmodest_dbus_client_search (osso_context_t *osso_ctx,
625 ModestDBusSearchFlags flags,
632 DBusMessageIter iter;
633 DBusMessageIter child;
634 DBusMessage *reply = NULL;
639 dbus_int32_t flags_v;
640 dbus_uint32_t size_v;
646 con = osso_get_dbus_connection (osso_ctx);
649 g_warning ("Could not get dbus connection\n");
655 msg = dbus_message_new_method_call (MODEST_DBUS_SERVICE,
658 MODEST_DBUS_METHOD_SEARCH);
661 //ULOG_ERR_F("dbus_message_new_method_call failed");
665 if (folder == NULL) {
669 sd_v = (dbus_int64_t) start_date;
670 ed_v = (dbus_int64_t) end_date;
671 flags_v = (dbus_int32_t) flags;
672 size_v = (dbus_uint32_t) min_size;
674 res = dbus_message_append_args (msg,
675 DBUS_TYPE_STRING, &query,
676 DBUS_TYPE_STRING, &folder,
677 DBUS_TYPE_INT64, &sd_v,
678 DBUS_TYPE_INT64, &ed_v,
679 DBUS_TYPE_INT32, &flags_v,
680 DBUS_TYPE_UINT32, &size_v,
683 dbus_message_set_auto_start (msg, TRUE);
685 /* Use a long timeout (2 minutes) because the search currently
686 * gets folders and messages from the servers. */
687 timeout = 120000; //milliseconds.
688 //osso_rpc_get_timeout (osso_ctx, &timeout);
690 /*printf("DEBUG: %s: Before dbus_connection_send_with_reply_and_block().\n",
692 /* TODO: Detect the timeout somehow. */
694 dbus_error_init (&err);
695 reply = dbus_connection_send_with_reply_and_block (con,
699 /* printf("DEBUG: %s: dbus_connection_send_with_reply_and_block() finished.\n",
702 dbus_message_unref (msg);
705 g_warning("%s: dbus_connection_send_with_reply_and_block() error: %s",
706 __FUNCTION__, err.message);
710 switch (dbus_message_get_type (reply)) {
712 case DBUS_MESSAGE_TYPE_ERROR:
713 dbus_set_error_from_message (&err, reply);
715 dbus_error_free (&err);
716 dbus_message_unref (reply);
719 case DBUS_MESSAGE_TYPE_METHOD_RETURN:
720 /* ok we are good to go
721 * lets drop outa here and handle that */
724 //ULOG_WARN_F("got unknown message type as reply");
725 //retval->type = DBUS_TYPE_STRING;
726 //retval->value.s = g_strdup("Invalid return value");
728 dbus_message_unref (reply);
732 g_debug ("%s: message return", __FUNCTION__);
734 dbus_message_iter_init (reply, &iter);
735 arg_type = dbus_message_iter_get_arg_type (&iter);
737 dbus_message_iter_recurse (&iter, &child);
741 ModestSearchHit *hit;
743 hit = modest_dbus_message_iter_get_search_hit (&child);
746 *hits = g_list_prepend (*hits, hit);
749 } while (dbus_message_iter_next (&child));
751 dbus_message_unref (reply);
754 /* TODO: This is from osso source, do we need it? */
756 /* Tell TaskNavigator to show "launch banner" */
757 msg = dbus_message_new_method_call (TASK_NAV_SERVICE,
758 APP_LAUNCH_BANNER_METHOD_PATH,
759 APP_LAUNCH_BANNER_METHOD_INTERFACE,
760 APP_LAUNCH_BANNER_METHOD);
763 g_warn ("dbus_message_new_method_call failed");
768 dbus_message_append_args (msg,
773 b = dbus_connection_send (conn, msg, NULL);
776 ULOG_WARN_F("dbus_connection_send failed");
779 dbus_message_unref (msg);
787 modest_folder_result_free (ModestFolderResult *item)
789 g_free (item->folder_name);
790 g_free (item->folder_uri);
791 g_slice_free (ModestFolderResult, item);
795 modest_folder_result_list_free (GList *list)
803 for (iter = list; iter; iter = iter->next) {
804 modest_folder_result_free ((ModestFolderResult *) iter->data);
811 /** Get the values from the complex type (GET_FOLDERS_RESULT_DBUS_TYPE)
812 * in the D-Bus return message. */
813 static ModestFolderResult *
814 modest_dbus_message_iter_get_folder_item (DBusMessageIter *parent)
816 gboolean error = FALSE;
817 ModestFolderResult *item = g_slice_new0 (ModestFolderResult);
819 int arg_type = dbus_message_iter_get_arg_type (parent);
821 if (arg_type != 'r') {
825 DBusMessageIter child;
826 dbus_message_iter_recurse (parent, &child);
829 arg_type = dbus_message_iter_get_arg_type (&child);
831 if (arg_type != DBUS_TYPE_STRING) {
836 item->folder_name = _dbus_iter_get_string_or_null (&child);
839 dbus_bool_t res = dbus_message_iter_next (&child);
846 arg_type = dbus_message_iter_get_arg_type (&child);
848 if (arg_type != DBUS_TYPE_STRING) {
853 item->folder_uri = _dbus_iter_get_string_or_null (&child);
858 g_warning ("%s: Error during unmarshalling", __FUNCTION__);
859 modest_folder_result_free (item);
867 * libmodest_dbus_client_get_folders:
868 * @osso_ctx: A valid #osso_context_t object.
869 * @folders: A pointer to a valid GList pointer that will contain the folder items
870 * (ModestFolderResult). The list and the items must be freed by the caller
871 * with modest_folder_result_list_free().
873 * This method will obtain a list of folders in the default account.
875 * Upon success TRUE is returned and @folders will include the folders or the list
876 * might be empty if there are no folders. The returned
877 * list must be freed with modest_folder_result_list_free ().
879 * NOTE: A folder will only be retrieved if it was previously downloaded by
880 * modest. This function does also not attempt do to remote refreshes (i.e. IMAP).
882 * Return value: TRUE if the request succeded or FALSE for an error.
885 libmodest_dbus_client_get_folders (osso_context_t *osso_ctx,
888 /* Initialize output argument: */
894 DBusConnection *con = osso_get_dbus_connection (osso_ctx);
897 g_warning ("Could not get dbus connection\n");
902 DBusMessage *msg = dbus_message_new_method_call (MODEST_DBUS_SERVICE,
905 MODEST_DBUS_METHOD_GET_FOLDERS);
908 //ULOG_ERR_F("dbus_message_new_method_call failed");
912 dbus_message_set_auto_start (msg, TRUE);
914 /* Use a long timeout (2 minutes) because the search currently
915 * gets folders from the servers. */
916 gint timeout = 120000;
917 //osso_rpc_get_timeout (osso_ctx, &timeout);
920 dbus_error_init (&err);
921 DBusMessage *reply = dbus_connection_send_with_reply_and_block (con,
926 dbus_message_unref (msg);
930 g_warning("%s: dbus_connection_send_with_reply_and_block() error:\n %s",
931 __FUNCTION__, err.message);
935 switch (dbus_message_get_type (reply)) {
937 case DBUS_MESSAGE_TYPE_ERROR:
938 dbus_set_error_from_message (&err, reply);
940 dbus_error_free (&err);
941 dbus_message_unref (reply);
944 case DBUS_MESSAGE_TYPE_METHOD_RETURN:
945 /* ok we are good to go
946 * lets drop outa here and handle that */
949 //ULOG_WARN_F("got unknown message type as reply");
950 //retval->type = DBUS_TYPE_STRING;
951 //retval->value.s = g_strdup("Invalid return value");
953 dbus_message_unref (reply);
957 g_debug ("%s: message return", __FUNCTION__);
959 DBusMessageIter iter;
960 dbus_message_iter_init (reply, &iter);
961 /* int arg_type = dbus_message_iter_get_arg_type (&iter); */
963 DBusMessageIter child;
964 dbus_message_iter_recurse (&iter, &child);
967 ModestFolderResult *item = modest_dbus_message_iter_get_folder_item (&child);
970 *folders = g_list_append (*folders, item);
973 } while (dbus_message_iter_next (&child));
975 dbus_message_unref (reply);
978 /* TODO: This is from osso source, do we need it? */
980 /* Tell TaskNavigator to show "launch banner" */
981 msg = dbus_message_new_method_call (TASK_NAV_SERVICE,
982 APP_LAUNCH_BANNER_METHOD_PATH,
983 APP_LAUNCH_BANNER_METHOD_INTERFACE,
984 APP_LAUNCH_BANNER_METHOD);
987 g_warn ("dbus_message_new_method_call failed");
992 dbus_message_append_args (msg,
997 b = dbus_connection_send (conn, msg, NULL);
1000 ULOG_WARN_F("dbus_connection_send failed");
1003 dbus_message_unref (msg);