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;
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_open_default_inbox (osso_context_t *osso_context)
210 osso_rpc_t retval = { 0 };
211 const osso_return_t ret = osso_rpc_run_with_defaults(osso_context,
213 MODEST_DBUS_METHOD_OPEN_DEFAULT_INBOX, &retval,
216 if (ret != OSSO_OK) {
217 printf("debug: %s: osso_rpc_run() failed.\n", __FUNCTION__);
220 printf("debug: %s: osso_rpc_run() succeeded.\n", __FUNCTION__);
223 osso_rpc_free_val(&retval);
229 libmodest_dbus_client_open_account (osso_context_t *osso_context,
230 const gchar *account_id)
232 osso_rpc_t retval = { 0 };
233 const osso_return_t ret =
234 osso_rpc_run_with_defaults(osso_context,
236 MODEST_DBUS_METHOD_OPEN_ACCOUNT, &retval,
237 DBUS_TYPE_STRING, account_id,
240 if (ret != OSSO_OK) {
241 printf("debug: %s: osso_rpc_run() failed.\n", __FUNCTION__);
244 printf("debug: %s: osso_rpc_run() succeeded.\n", __FUNCTION__);
247 osso_rpc_free_val(&retval);
253 * libmodest_dbus_client_delete_message:
254 * @osso_context: a valid #osso_context_t object.
255 * @msg_uri: A valid url to a mail
257 * This method will try to find the message supplied
258 * by @msg_uri and if found delete it. It will use
259 * remote procedure calls (rpc) over dbus to do so.
261 * Return value: TRUE on successs, FALSE on error
264 libmodest_dbus_client_delete_message (osso_context_t *osso_ctx,
267 osso_rpc_t retval = { 0 };
270 ret = osso_rpc_run_with_defaults (osso_ctx,
272 MODEST_DBUS_METHOD_DELETE_MESSAGE, &retval,
273 DBUS_TYPE_STRING, msg_uri,
276 if (ret != OSSO_OK) {
277 g_debug ("debug: osso_rpc_run() failed.\n");
279 g_debug ("debug: osso_rpc_run() succeeded.\n");
282 osso_rpc_free_val (&retval);
284 return ret == OSSO_OK;
288 modest_search_hit_free (ModestSearchHit *hit)
291 g_slice_free (ModestSearchHit, hit);
295 modest_search_hit_list_free (GList *hits)
303 for (iter = hits; iter; iter = iter->next) {
304 modest_search_hit_free ((ModestSearchHit *) iter->data);
311 _dbus_iter_get_string_or_null (DBusMessageIter *iter)
313 const char *string = NULL;
316 dbus_message_iter_get_basic (iter, &string);
318 if (string && strlen (string)) {
319 ret = g_strdup (string);
326 _dbus_iter_get_uint64 (DBusMessageIter *iter)
332 dbus_message_iter_get_basic (iter, &ui64v);
334 ret = (guint64) ui64v;
341 _dbus_iter_get_int64 (DBusMessageIter *iter)
347 dbus_message_iter_get_basic (iter, &i64v);
355 _dbus_iter_get_boolean (DBusMessageIter *iter)
362 dbus_message_iter_get_basic (iter, &val);
364 ret = (gboolean) val;
369 /** Get the values from the complex type (SEARCH_HIT_DBUS_TYPE)
370 * in the D-Bus return message. */
371 static ModestSearchHit *
372 modest_dbus_message_iter_get_search_hit (DBusMessageIter *parent)
374 ModestSearchHit *hit;
375 DBusMessageIter child;
381 hit = g_slice_new0 (ModestSearchHit);
383 arg_type = dbus_message_iter_get_arg_type (parent);
385 if (arg_type != 'r') {
389 dbus_message_iter_recurse (parent, &child);
392 arg_type = dbus_message_iter_get_arg_type (&child);
394 if (arg_type != DBUS_TYPE_STRING) {
399 hit->msgid = _dbus_iter_get_string_or_null (&child);
401 res = dbus_message_iter_next (&child);
408 arg_type = dbus_message_iter_get_arg_type (&child);
410 if (arg_type != DBUS_TYPE_STRING) {
415 hit->subject = _dbus_iter_get_string_or_null (&child);
417 res = dbus_message_iter_next (&child);
424 arg_type = dbus_message_iter_get_arg_type (&child);
426 if (arg_type != DBUS_TYPE_STRING) {
431 hit->folder = _dbus_iter_get_string_or_null (&child);
433 res = dbus_message_iter_next (&child);
440 arg_type = dbus_message_iter_get_arg_type (&child);
442 if (arg_type != DBUS_TYPE_STRING) {
447 hit->sender = _dbus_iter_get_string_or_null (&child);
449 res = dbus_message_iter_next (&child);
456 arg_type = dbus_message_iter_get_arg_type (&child);
458 if (arg_type != DBUS_TYPE_UINT64) {
463 hit->msize = _dbus_iter_get_uint64 (&child);
465 res = dbus_message_iter_next (&child);
472 arg_type = dbus_message_iter_get_arg_type (&child);
474 if (arg_type != DBUS_TYPE_BOOLEAN) {
479 hit->has_attachment = _dbus_iter_get_boolean (&child);
481 res = dbus_message_iter_next (&child);
488 arg_type = dbus_message_iter_get_arg_type (&child);
490 if (arg_type != DBUS_TYPE_BOOLEAN) {
495 hit->is_unread = _dbus_iter_get_boolean (&child);
497 res = dbus_message_iter_next (&child);
504 arg_type = dbus_message_iter_get_arg_type (&child);
506 if (arg_type != DBUS_TYPE_INT64) {
511 hit->timestamp = _dbus_iter_get_int64 (&child);
513 res = dbus_message_iter_next (&child);
521 g_warning ("%s: Error during unmarshalling", __FUNCTION__);
522 modest_search_hit_free (hit);
530 * libmodest_dbus_client_search:
531 * @osso_ctx: A valid #osso_context_t object.
532 * @query: The term to search for.
533 * @folder: An url to specific folder or %NULL to search everywhere.
534 * @start_date: Search hits before this date will be ignored.
535 * @end_date: Search hits after this date will be ignored.
536 * @min_size: Messagers smaller then this size will be ingored.
537 * @flags: A list of flags where to search so the documentation
538 * of %ModestDBusSearchFlags for details.
539 * @hits: A pointer to a valid GList pointer that will contain the search
540 * hits (ModestSearchHit). The list and the items must be freed by the caller
541 * with modest_search_hit_list_free().
543 * This method will search the folder specified by a valid url in @folder or all
544 * known accounts (local and remote) if %NULL for matches of the search term(s)
545 * specified in @query. It is legal to specify 0 in @start_date, @end_date and
546 * @min_size to ignore these parameters during the search otherwise those message
547 * that do not meet the specifed dates or size will be ignored.
548 * Where to search, be it subject, sender or the whole body can be specified by
549 * the @flags parameter.
551 * Upon success TRUE is returned and @hits will include the search hits or the list
552 * migh be empty if none of the messages matched the search criteria. The returned
553 * list must be freed with modest_search_hit_list_free (). It is save to pass
554 * %NULL to this function so you can call this function on the result list no matter
555 * if a hit was found or not (means the list is empty - i.e. %NULL)
556 * FALSE will only be return if an error during the remote procedure call (rpc)
557 * occured or if the specified folder could not be found.
559 * NOTE: The body of a message can only be searched if it was previously downloaded by
560 * modest. This function does also not attempt do to remote searches (i.e. IMAP search).
562 * Example to search every account for message containing "no":
563 * <informalexample><programlisting>
564 * ModestDBusSearchFlags flags;
565 * osso_context_t *osso_context;
570 * [...] Initialize osso context [...]
572 * res = libmodest_dbus_client_search (osso_context,
581 * for (iter = hits; iter; iter = iter->next) {
582 * ModestSearchHit *hit = (ModestSearchHit *) iter->data;
584 * [...] Do something with the hit [...]
588 * modest_search_hit_list_free (hits);
589 * </programlisting></informalexample>
591 * Return value: TRUE if the search succeded or FALSE for an error during the search
594 libmodest_dbus_client_search (osso_context_t *osso_ctx,
600 ModestDBusSearchFlags flags,
607 DBusMessageIter iter;
608 DBusMessageIter child;
609 DBusMessage *reply = NULL;
614 dbus_int32_t flags_v;
615 dbus_uint32_t size_v;
621 con = osso_get_dbus_connection (osso_ctx);
624 g_warning ("Could not get dbus connection\n");
630 msg = dbus_message_new_method_call (MODEST_DBUS_SERVICE,
633 MODEST_DBUS_METHOD_SEARCH);
636 //ULOG_ERR_F("dbus_message_new_method_call failed");
640 if (folder == NULL) {
644 sd_v = (dbus_int64_t) start_date;
645 ed_v = (dbus_int64_t) end_date;
646 flags_v = (dbus_int32_t) flags;
647 size_v = (dbus_uint32_t) min_size;
649 res = dbus_message_append_args (msg,
650 DBUS_TYPE_STRING, &query,
651 DBUS_TYPE_STRING, &folder,
652 DBUS_TYPE_INT64, &sd_v,
653 DBUS_TYPE_INT64, &ed_v,
654 DBUS_TYPE_INT32, &flags_v,
655 DBUS_TYPE_UINT32, &size_v,
658 dbus_message_set_auto_start (msg, TRUE);
660 /* Use a long timeout (2 minutes) because the search currently
661 * gets folders and messages from the servers. */
662 timeout = 120000; //milliseconds.
663 //osso_rpc_get_timeout (osso_ctx, &timeout);
665 /*printf("DEBUG: %s: Before dbus_connection_send_with_reply_and_block().\n",
667 /* TODO: Detect the timeout somehow. */
669 dbus_error_init (&err);
670 reply = dbus_connection_send_with_reply_and_block (con,
674 /* printf("DEBUG: %s: dbus_connection_send_with_reply_and_block() finished.\n",
677 dbus_message_unref (msg);
680 g_warning("%s: dbus_connection_send_with_reply_and_block() error: %s",
681 __FUNCTION__, err.message);
685 switch (dbus_message_get_type (reply)) {
687 case DBUS_MESSAGE_TYPE_ERROR:
688 dbus_set_error_from_message (&err, reply);
690 dbus_error_free (&err);
691 dbus_message_unref (reply);
694 case DBUS_MESSAGE_TYPE_METHOD_RETURN:
695 /* ok we are good to go
696 * lets drop outa here and handle that */
699 //ULOG_WARN_F("got unknown message type as reply");
700 //retval->type = DBUS_TYPE_STRING;
701 //retval->value.s = g_strdup("Invalid return value");
703 dbus_message_unref (reply);
707 g_debug ("%s: message return", __FUNCTION__);
709 dbus_message_iter_init (reply, &iter);
710 arg_type = dbus_message_iter_get_arg_type (&iter);
712 dbus_message_iter_recurse (&iter, &child);
716 ModestSearchHit *hit;
718 hit = modest_dbus_message_iter_get_search_hit (&child);
721 *hits = g_list_prepend (*hits, hit);
724 } while (dbus_message_iter_next (&child));
726 dbus_message_unref (reply);
729 /* TODO: This is from osso source, do we need it? */
731 /* Tell TaskNavigator to show "launch banner" */
732 msg = dbus_message_new_method_call (TASK_NAV_SERVICE,
733 APP_LAUNCH_BANNER_METHOD_PATH,
734 APP_LAUNCH_BANNER_METHOD_INTERFACE,
735 APP_LAUNCH_BANNER_METHOD);
738 g_warn ("dbus_message_new_method_call failed");
743 dbus_message_append_args (msg,
748 b = dbus_connection_send (conn, msg, NULL);
751 ULOG_WARN_F("dbus_connection_send failed");
754 dbus_message_unref (msg);
762 modest_folder_result_free (ModestFolderResult *item)
764 g_free (item->folder_name);
765 g_free (item->folder_uri);
766 g_slice_free (ModestFolderResult, item);
770 modest_folder_result_list_free (GList *list)
778 for (iter = list; iter; iter = iter->next) {
779 modest_folder_result_free ((ModestFolderResult *) iter->data);
786 /** Get the values from the complex type (GET_FOLDERS_RESULT_DBUS_TYPE)
787 * in the D-Bus return message. */
788 static ModestFolderResult *
789 modest_dbus_message_iter_get_folder_item (DBusMessageIter *parent)
791 gboolean error = FALSE;
792 ModestFolderResult *item = g_slice_new0 (ModestFolderResult);
794 int arg_type = dbus_message_iter_get_arg_type (parent);
796 if (arg_type != 'r') {
800 DBusMessageIter child;
801 dbus_message_iter_recurse (parent, &child);
804 arg_type = dbus_message_iter_get_arg_type (&child);
806 if (arg_type != DBUS_TYPE_STRING) {
811 item->folder_name = _dbus_iter_get_string_or_null (&child);
814 dbus_bool_t res = dbus_message_iter_next (&child);
821 arg_type = dbus_message_iter_get_arg_type (&child);
823 if (arg_type != DBUS_TYPE_STRING) {
828 item->folder_uri = _dbus_iter_get_string_or_null (&child);
833 g_warning ("%s: Error during unmarshalling", __FUNCTION__);
834 modest_folder_result_free (item);
842 * libmodest_dbus_client_get_folders:
843 * @osso_ctx: A valid #osso_context_t object.
844 * @folders: A pointer to a valid GList pointer that will contain the folder items
845 * (ModestFolderResult). The list and the items must be freed by the caller
846 * with modest_folder_result_list_free().
848 * This method will obtain a list of folders in the default account.
850 * Upon success TRUE is returned and @folders will include the folders or the list
851 * might be empty if there are no folders. The returned
852 * list must be freed with modest_folder_result_list_free ().
854 * NOTE: A folder will only be retrieved if it was previously downloaded by
855 * modest. This function does also not attempt do to remote refreshes (i.e. IMAP).
857 * Return value: TRUE if the request succeded or FALSE for an error.
860 libmodest_dbus_client_get_folders (osso_context_t *osso_ctx,
863 /* Initialize output argument: */
869 DBusConnection *con = osso_get_dbus_connection (osso_ctx);
872 g_warning ("Could not get dbus connection\n");
877 DBusMessage *msg = dbus_message_new_method_call (MODEST_DBUS_SERVICE,
880 MODEST_DBUS_METHOD_GET_FOLDERS);
883 //ULOG_ERR_F("dbus_message_new_method_call failed");
887 dbus_message_set_auto_start (msg, TRUE);
889 /* Use a long timeout (2 minutes) because the search currently
890 * gets folders from the servers. */
891 gint timeout = 120000;
892 //osso_rpc_get_timeout (osso_ctx, &timeout);
895 dbus_error_init (&err);
896 DBusMessage *reply = dbus_connection_send_with_reply_and_block (con,
901 dbus_message_unref (msg);
905 g_warning("%s: dbus_connection_send_with_reply_and_block() error:\n %s",
906 __FUNCTION__, err.message);
910 switch (dbus_message_get_type (reply)) {
912 case DBUS_MESSAGE_TYPE_ERROR:
913 dbus_set_error_from_message (&err, reply);
915 dbus_error_free (&err);
916 dbus_message_unref (reply);
919 case DBUS_MESSAGE_TYPE_METHOD_RETURN:
920 /* ok we are good to go
921 * lets drop outa here and handle that */
924 //ULOG_WARN_F("got unknown message type as reply");
925 //retval->type = DBUS_TYPE_STRING;
926 //retval->value.s = g_strdup("Invalid return value");
928 dbus_message_unref (reply);
932 g_debug ("%s: message return", __FUNCTION__);
934 DBusMessageIter iter;
935 dbus_message_iter_init (reply, &iter);
936 /* int arg_type = dbus_message_iter_get_arg_type (&iter); */
938 DBusMessageIter child;
939 dbus_message_iter_recurse (&iter, &child);
942 ModestFolderResult *item = modest_dbus_message_iter_get_folder_item (&child);
945 *folders = g_list_append (*folders, item);
948 } while (dbus_message_iter_next (&child));
950 dbus_message_unref (reply);
953 /* TODO: This is from osso source, do we need it? */
955 /* Tell TaskNavigator to show "launch banner" */
956 msg = dbus_message_new_method_call (TASK_NAV_SERVICE,
957 APP_LAUNCH_BANNER_METHOD_PATH,
958 APP_LAUNCH_BANNER_METHOD_INTERFACE,
959 APP_LAUNCH_BANNER_METHOD);
962 g_warn ("dbus_message_new_method_call failed");
967 dbus_message_append_args (msg,
972 b = dbus_connection_send (conn, msg, NULL);
975 ULOG_WARN_F("dbus_connection_send failed");
978 dbus_message_unref (msg);