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_open_edit_accounts_dialog (osso_context_t *osso_context)
280 osso_rpc_t retval = { 0 };
281 const osso_return_t ret =
282 osso_rpc_run_with_defaults(osso_context,
284 MODEST_DBUS_METHOD_OPEN_EDIT_ACCOUNTS_DIALOG, &retval,
287 if (ret != OSSO_OK) {
288 printf("debug: %s: osso_rpc_run() failed.\n", __FUNCTION__);
291 printf("debug: %s: osso_rpc_run() succeeded.\n", __FUNCTION__);
294 osso_rpc_free_val(&retval);
300 * libmodest_dbus_client_delete_message:
301 * @osso_context: a valid #osso_context_t object.
302 * @msg_uri: A valid url to a mail
304 * This method will try to find the message supplied
305 * by @msg_uri and if found delete it. It will use
306 * remote procedure calls (rpc) over dbus to do so.
308 * Return value: TRUE on successs, FALSE on error
311 libmodest_dbus_client_delete_message (osso_context_t *osso_ctx,
314 osso_rpc_t retval = { 0 };
317 ret = osso_rpc_run_with_defaults (osso_ctx,
319 MODEST_DBUS_METHOD_DELETE_MESSAGE, &retval,
320 DBUS_TYPE_STRING, msg_uri,
323 if (ret != OSSO_OK) {
324 g_debug ("debug: osso_rpc_run() failed.\n");
326 g_debug ("debug: osso_rpc_run() succeeded.\n");
329 osso_rpc_free_val (&retval);
331 return ret == OSSO_OK;
335 modest_search_hit_free (ModestSearchHit *hit)
338 g_slice_free (ModestSearchHit, hit);
342 modest_search_hit_list_free (GList *hits)
350 for (iter = hits; iter; iter = iter->next) {
351 modest_search_hit_free ((ModestSearchHit *) iter->data);
358 _dbus_iter_get_string_or_null (DBusMessageIter *iter)
360 const char *string = NULL;
363 dbus_message_iter_get_basic (iter, &string);
365 if (string && strlen (string)) {
366 ret = g_strdup (string);
373 _dbus_iter_get_uint64 (DBusMessageIter *iter)
379 dbus_message_iter_get_basic (iter, &ui64v);
381 ret = (guint64) ui64v;
388 _dbus_iter_get_int64 (DBusMessageIter *iter)
394 dbus_message_iter_get_basic (iter, &i64v);
402 _dbus_iter_get_boolean (DBusMessageIter *iter)
409 dbus_message_iter_get_basic (iter, &val);
411 ret = (gboolean) val;
416 /** Get the values from the complex type (SEARCH_HIT_DBUS_TYPE)
417 * in the D-Bus return message. */
418 static ModestSearchHit *
419 modest_dbus_message_iter_get_search_hit (DBusMessageIter *parent)
421 ModestSearchHit *hit;
422 DBusMessageIter child;
428 hit = g_slice_new0 (ModestSearchHit);
430 arg_type = dbus_message_iter_get_arg_type (parent);
432 if (arg_type != 'r') {
436 dbus_message_iter_recurse (parent, &child);
439 arg_type = dbus_message_iter_get_arg_type (&child);
441 if (arg_type != DBUS_TYPE_STRING) {
446 hit->msgid = _dbus_iter_get_string_or_null (&child);
448 res = dbus_message_iter_next (&child);
455 arg_type = dbus_message_iter_get_arg_type (&child);
457 if (arg_type != DBUS_TYPE_STRING) {
462 hit->subject = _dbus_iter_get_string_or_null (&child);
464 res = dbus_message_iter_next (&child);
471 arg_type = dbus_message_iter_get_arg_type (&child);
473 if (arg_type != DBUS_TYPE_STRING) {
478 hit->folder = _dbus_iter_get_string_or_null (&child);
480 res = dbus_message_iter_next (&child);
487 arg_type = dbus_message_iter_get_arg_type (&child);
489 if (arg_type != DBUS_TYPE_STRING) {
494 hit->sender = _dbus_iter_get_string_or_null (&child);
496 res = dbus_message_iter_next (&child);
503 arg_type = dbus_message_iter_get_arg_type (&child);
505 if (arg_type != DBUS_TYPE_UINT64) {
510 hit->msize = _dbus_iter_get_uint64 (&child);
512 res = dbus_message_iter_next (&child);
519 arg_type = dbus_message_iter_get_arg_type (&child);
521 if (arg_type != DBUS_TYPE_BOOLEAN) {
526 hit->has_attachment = _dbus_iter_get_boolean (&child);
528 res = dbus_message_iter_next (&child);
535 arg_type = dbus_message_iter_get_arg_type (&child);
537 if (arg_type != DBUS_TYPE_BOOLEAN) {
542 hit->is_unread = _dbus_iter_get_boolean (&child);
544 res = dbus_message_iter_next (&child);
551 arg_type = dbus_message_iter_get_arg_type (&child);
553 if (arg_type != DBUS_TYPE_INT64) {
558 hit->timestamp = _dbus_iter_get_int64 (&child);
560 res = dbus_message_iter_next (&child);
568 g_warning ("%s: Error during unmarshalling", __FUNCTION__);
569 modest_search_hit_free (hit);
577 * libmodest_dbus_client_search:
578 * @osso_ctx: A valid #osso_context_t object.
579 * @query: The term to search for.
580 * @folder: An url to specific folder or %NULL to search everywhere.
581 * @start_date: Search hits before this date will be ignored.
582 * @end_date: Search hits after this date will be ignored.
583 * @min_size: Messagers smaller then this size will be ingored.
584 * @flags: A list of flags where to search so the documentation
585 * of %ModestDBusSearchFlags for details.
586 * @hits: A pointer to a valid GList pointer that will contain the search
587 * hits (ModestSearchHit). The list and the items must be freed by the caller
588 * with modest_search_hit_list_free().
590 * This method will search the folder specified by a valid url in @folder or all
591 * known accounts (local and remote) if %NULL for matches of the search term(s)
592 * specified in @query. It is legal to specify 0 in @start_date, @end_date and
593 * @min_size to ignore these parameters during the search otherwise those message
594 * that do not meet the specifed dates or size will be ignored.
595 * Where to search, be it subject, sender or the whole body can be specified by
596 * the @flags parameter.
598 * Upon success TRUE is returned and @hits will include the search hits or the list
599 * migh be empty if none of the messages matched the search criteria. The returned
600 * list must be freed with modest_search_hit_list_free (). It is save to pass
601 * %NULL to this function so you can call this function on the result list no matter
602 * if a hit was found or not (means the list is empty - i.e. %NULL)
603 * FALSE will only be return if an error during the remote procedure call (rpc)
604 * occured or if the specified folder could not be found.
606 * NOTE: The body of a message can only be searched if it was previously downloaded by
607 * modest. This function does also not attempt do to remote searches (i.e. IMAP search).
609 * Example to search every account for message containing "no":
610 * <informalexample><programlisting>
611 * ModestDBusSearchFlags flags;
612 * osso_context_t *osso_context;
617 * [...] Initialize osso context [...]
619 * res = libmodest_dbus_client_search (osso_context,
628 * for (iter = hits; iter; iter = iter->next) {
629 * ModestSearchHit *hit = (ModestSearchHit *) iter->data;
631 * [...] Do something with the hit [...]
635 * modest_search_hit_list_free (hits);
636 * </programlisting></informalexample>
638 * Return value: TRUE if the search succeded or FALSE for an error during the search
641 libmodest_dbus_client_search (osso_context_t *osso_ctx,
647 ModestDBusSearchFlags flags,
654 DBusMessageIter iter;
655 DBusMessageIter child;
656 DBusMessage *reply = NULL;
661 dbus_int32_t flags_v;
662 dbus_uint32_t size_v;
668 con = osso_get_dbus_connection (osso_ctx);
671 g_warning ("Could not get dbus connection\n");
677 msg = dbus_message_new_method_call (MODEST_DBUS_SERVICE,
680 MODEST_DBUS_METHOD_SEARCH);
683 //ULOG_ERR_F("dbus_message_new_method_call failed");
687 if (folder == NULL) {
691 sd_v = (dbus_int64_t) start_date;
692 ed_v = (dbus_int64_t) end_date;
693 flags_v = (dbus_int32_t) flags;
694 size_v = (dbus_uint32_t) min_size;
696 res = dbus_message_append_args (msg,
697 DBUS_TYPE_STRING, &query,
698 DBUS_TYPE_STRING, &folder,
699 DBUS_TYPE_INT64, &sd_v,
700 DBUS_TYPE_INT64, &ed_v,
701 DBUS_TYPE_INT32, &flags_v,
702 DBUS_TYPE_UINT32, &size_v,
705 dbus_message_set_auto_start (msg, TRUE);
707 /* Use a long timeout (2 minutes) because the search currently
708 * gets folders and messages from the servers. */
709 timeout = 120000; //milliseconds.
710 //osso_rpc_get_timeout (osso_ctx, &timeout);
712 /*printf("DEBUG: %s: Before dbus_connection_send_with_reply_and_block().\n",
714 /* TODO: Detect the timeout somehow. */
716 dbus_error_init (&err);
717 reply = dbus_connection_send_with_reply_and_block (con,
721 /* printf("DEBUG: %s: dbus_connection_send_with_reply_and_block() finished.\n",
724 dbus_message_unref (msg);
727 g_warning("%s: dbus_connection_send_with_reply_and_block() error: %s",
728 __FUNCTION__, err.message);
732 switch (dbus_message_get_type (reply)) {
734 case DBUS_MESSAGE_TYPE_ERROR:
735 dbus_set_error_from_message (&err, reply);
737 dbus_error_free (&err);
738 dbus_message_unref (reply);
741 case DBUS_MESSAGE_TYPE_METHOD_RETURN:
742 /* ok we are good to go
743 * lets drop outa here and handle that */
746 //ULOG_WARN_F("got unknown message type as reply");
747 //retval->type = DBUS_TYPE_STRING;
748 //retval->value.s = g_strdup("Invalid return value");
750 dbus_message_unref (reply);
754 g_debug ("%s: message return", __FUNCTION__);
756 dbus_message_iter_init (reply, &iter);
757 arg_type = dbus_message_iter_get_arg_type (&iter);
759 dbus_message_iter_recurse (&iter, &child);
763 ModestSearchHit *hit;
765 hit = modest_dbus_message_iter_get_search_hit (&child);
768 *hits = g_list_prepend (*hits, hit);
771 } while (dbus_message_iter_next (&child));
773 dbus_message_unref (reply);
776 /* TODO: This is from osso source, do we need it? */
778 /* Tell TaskNavigator to show "launch banner" */
779 msg = dbus_message_new_method_call (TASK_NAV_SERVICE,
780 APP_LAUNCH_BANNER_METHOD_PATH,
781 APP_LAUNCH_BANNER_METHOD_INTERFACE,
782 APP_LAUNCH_BANNER_METHOD);
785 g_warn ("dbus_message_new_method_call failed");
790 dbus_message_append_args (msg,
795 b = dbus_connection_send (conn, msg, NULL);
798 ULOG_WARN_F("dbus_connection_send failed");
801 dbus_message_unref (msg);
809 modest_folder_result_free (ModestFolderResult *item)
811 g_free (item->folder_name);
812 g_free (item->folder_uri);
813 g_slice_free (ModestFolderResult, item);
817 modest_folder_result_list_free (GList *list)
825 for (iter = list; iter; iter = iter->next) {
826 modest_folder_result_free ((ModestFolderResult *) iter->data);
833 /** Get the values from the complex type (GET_FOLDERS_RESULT_DBUS_TYPE)
834 * in the D-Bus return message. */
835 static ModestFolderResult *
836 modest_dbus_message_iter_get_folder_item (DBusMessageIter *parent)
838 gboolean error = FALSE;
839 ModestFolderResult *item = g_slice_new0 (ModestFolderResult);
841 int arg_type = dbus_message_iter_get_arg_type (parent);
843 if (arg_type != 'r') {
847 DBusMessageIter child;
848 dbus_message_iter_recurse (parent, &child);
851 arg_type = dbus_message_iter_get_arg_type (&child);
853 if (arg_type != DBUS_TYPE_STRING) {
858 item->folder_name = _dbus_iter_get_string_or_null (&child);
861 dbus_bool_t res = dbus_message_iter_next (&child);
868 arg_type = dbus_message_iter_get_arg_type (&child);
870 if (arg_type != DBUS_TYPE_STRING) {
875 item->folder_uri = _dbus_iter_get_string_or_null (&child);
880 g_warning ("%s: Error during unmarshalling", __FUNCTION__);
881 modest_folder_result_free (item);
889 * libmodest_dbus_client_get_folders:
890 * @osso_ctx: A valid #osso_context_t object.
891 * @folders: A pointer to a valid GList pointer that will contain the folder items
892 * (ModestFolderResult). The list and the items must be freed by the caller
893 * with modest_folder_result_list_free().
895 * This method will obtain a list of folders in the default account.
897 * Upon success TRUE is returned and @folders will include the folders or the list
898 * might be empty if there are no folders. The returned
899 * list must be freed with modest_folder_result_list_free ().
901 * NOTE: A folder will only be retrieved if it was previously downloaded by
902 * modest. This function does also not attempt do to remote refreshes (i.e. IMAP).
904 * Return value: TRUE if the request succeded or FALSE for an error.
907 libmodest_dbus_client_get_folders (osso_context_t *osso_ctx,
910 /* Initialize output argument: */
916 DBusConnection *con = osso_get_dbus_connection (osso_ctx);
919 g_warning ("Could not get dbus connection\n");
924 DBusMessage *msg = dbus_message_new_method_call (MODEST_DBUS_SERVICE,
927 MODEST_DBUS_METHOD_GET_FOLDERS);
930 //ULOG_ERR_F("dbus_message_new_method_call failed");
934 dbus_message_set_auto_start (msg, TRUE);
936 /* Use a long timeout (2 minutes) because the search currently
937 * gets folders from the servers. */
938 gint timeout = 120000;
939 //osso_rpc_get_timeout (osso_ctx, &timeout);
942 dbus_error_init (&err);
943 DBusMessage *reply = dbus_connection_send_with_reply_and_block (con,
948 dbus_message_unref (msg);
952 g_warning("%s: dbus_connection_send_with_reply_and_block() error:\n %s",
953 __FUNCTION__, err.message);
957 switch (dbus_message_get_type (reply)) {
959 case DBUS_MESSAGE_TYPE_ERROR:
960 dbus_set_error_from_message (&err, reply);
962 dbus_error_free (&err);
963 dbus_message_unref (reply);
966 case DBUS_MESSAGE_TYPE_METHOD_RETURN:
967 /* ok we are good to go
968 * lets drop outa here and handle that */
971 //ULOG_WARN_F("got unknown message type as reply");
972 //retval->type = DBUS_TYPE_STRING;
973 //retval->value.s = g_strdup("Invalid return value");
975 dbus_message_unref (reply);
979 g_debug ("%s: message return", __FUNCTION__);
981 DBusMessageIter iter;
982 dbus_message_iter_init (reply, &iter);
983 /* int arg_type = dbus_message_iter_get_arg_type (&iter); */
985 DBusMessageIter child;
986 dbus_message_iter_recurse (&iter, &child);
989 ModestFolderResult *item = modest_dbus_message_iter_get_folder_item (&child);
992 *folders = g_list_append (*folders, item);
995 } while (dbus_message_iter_next (&child));
997 dbus_message_unref (reply);
1000 /* TODO: This is from osso source, do we need it? */
1002 /* Tell TaskNavigator to show "launch banner" */
1003 msg = dbus_message_new_method_call (TASK_NAV_SERVICE,
1004 APP_LAUNCH_BANNER_METHOD_PATH,
1005 APP_LAUNCH_BANNER_METHOD_INTERFACE,
1006 APP_LAUNCH_BANNER_METHOD);
1009 g_warn ("dbus_message_new_method_call failed");
1014 dbus_message_append_args (msg,
1019 b = dbus_connection_send (conn, msg, NULL);
1022 ULOG_WARN_F("dbus_connection_send failed");
1025 dbus_message_unref (msg);