* Removed the modest send/receive custom icon
[modest] / src / modest-tny-account.c
1 /* Copyright (c) 2006, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
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.
16  *
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.
28  */
29
30 #include <modest-tny-platform-factory.h>
31 #include <modest-tny-account.h>
32 #include <modest-tny-account-store.h>
33 #include <modest-runtime.h>
34 #include <tny-simple-list.h>
35 #include <modest-tny-folder.h>
36 #include <modest-account-mgr-helpers.h>
37 #include <tny-camel-transport-account.h>
38 #include <tny-camel-imap-store-account.h>
39 #include <tny-camel-pop-store-account.h>
40
41 /* for now, ignore the account ===> the special folders are the same,
42  * local folders for all accounts
43  * this might change, ie, IMAP might have server-side sent-items
44  */
45 TnyFolder *
46 modest_tny_account_get_special_folder (TnyAccount *account,
47                                        TnyFolderType special_type)
48 {
49         TnyList *folders;
50         TnyIterator *iter;
51         TnyFolder *special_folder = NULL;
52         TnyAccount *local_account;
53         
54         g_return_val_if_fail (account, NULL);
55         g_return_val_if_fail (0 <= special_type && special_type < TNY_FOLDER_TYPE_NUM,
56                               NULL);
57         
58         local_account = modest_tny_account_store_get_tny_account_by_id (modest_runtime_get_account_store(),
59                                                                         MODEST_LOCAL_FOLDERS_ACCOUNT_ID);
60         if (!local_account) {
61                 g_printerr ("modest: cannot get local account\n");
62                 return NULL;
63         }
64
65         folders = TNY_LIST (tny_simple_list_new ());
66
67         /* no need to do this _async, as these are local folders */
68         tny_folder_store_get_folders (TNY_FOLDER_STORE (local_account),
69                                       folders, NULL, NULL);
70         iter = tny_list_create_iterator (folders);
71
72         while (!tny_iterator_is_done (iter)) {
73                 TnyFolder *folder =
74                         TNY_FOLDER (tny_iterator_get_current (iter));
75                 if (modest_tny_folder_get_local_folder_type (folder) == special_type) {
76                         special_folder = folder;
77                         break;
78                 }
79                 g_object_unref (G_OBJECT(folder));
80                 tny_iterator_next (iter);
81         }
82         g_object_unref (G_OBJECT (folders));
83         g_object_unref (G_OBJECT (iter));
84
85         return special_folder;
86 }
87
88
89 /**
90  * modest_tny_account_new_from_server_account:
91  * @account_mgr: a valid account mgr instance
92  * @account_name: the server account name for which to create a corresponding tny account
93  * @type: the type of account to create (TNY_ACCOUNT_TYPE_STORE or TNY_ACCOUNT_TYPE_TRANSPORT)
94  * 
95  * get a tnyaccount corresponding to the server_accounts (store or transport) for this account.
96  * NOTE: this function does not set the camel session or the get/forget password functions
97  * 
98  * Returns: a new TnyAccount or NULL in case of error.
99  */
100 static TnyAccount*
101 modest_tny_account_new_from_server_account (ModestAccountMgr *account_mgr,
102                                             ModestServerAccountData *account_data)
103 {
104         TnyAccount *tny_account;
105                 
106         g_return_val_if_fail (account_mgr, NULL);
107         g_return_val_if_fail (account_data, NULL);
108
109         /* sanity checks */
110         if (account_data->proto == MODEST_PROTOCOL_UNKNOWN) {
111                 g_printerr ("modest: '%s' does not provide a protocol\n",
112                             account_data->account_name);
113                 return NULL;
114         }
115
116         switch (account_data->proto) {
117         case MODEST_PROTOCOL_TRANSPORT_SENDMAIL:
118         case MODEST_PROTOCOL_TRANSPORT_SMTP:
119                 tny_account = TNY_ACCOUNT(tny_camel_transport_account_new ()); break;
120         case MODEST_PROTOCOL_STORE_POP:
121                 tny_account = TNY_ACCOUNT(tny_camel_pop_store_account_new ()); break;
122         case MODEST_PROTOCOL_STORE_IMAP:
123                 tny_account = TNY_ACCOUNT(tny_camel_imap_store_account_new ()); break;
124         case MODEST_PROTOCOL_STORE_MAILDIR:
125         case MODEST_PROTOCOL_STORE_MBOX:
126                 tny_account = TNY_ACCOUNT(tny_camel_store_account_new()); break;
127         default:
128                 g_return_val_if_reached (NULL);
129         }
130         if (!tny_account) {
131                 g_printerr ("modest: could not create tny account for '%s'\n",
132                             account_data->account_name);
133                 return NULL;
134         }
135         tny_account_set_id (tny_account, account_data->account_name);
136
137         /* Proto */
138         tny_account_set_proto (tny_account,
139                                modest_protocol_info_get_protocol_name(account_data->proto));
140         if (account_data->uri) 
141                 tny_account_set_url_string (TNY_ACCOUNT(tny_account), account_data->uri);
142         else {
143                 if (account_data->options) {
144                         GSList *options = account_data->options;
145                         while (options) {
146                                 tny_camel_account_add_option (TNY_CAMEL_ACCOUNT (tny_account),
147                                                               options->data);
148                                 options = g_slist_next (options);
149                         }
150                 }
151                 if (account_data->username) 
152                         tny_account_set_user (tny_account, account_data->username);
153                 if (account_data->hostname)
154                         tny_account_set_hostname (tny_account, account_data->hostname);
155         }
156         return tny_account;
157 }
158
159
160 /* we need these dummy functions, or tinymail will complain */
161 static gchar*
162 get_pass_dummy (TnyAccount *account, const gchar *prompt, gboolean *cancel)
163 {
164         return NULL;
165 }
166 static void
167 forget_pass_dummy (TnyAccount *account)
168 {
169         /* intentionally left blank */
170 }
171
172 TnyAccount*
173 modest_tny_account_new_from_account (ModestAccountMgr *account_mgr, const gchar *account_name,
174                                      TnyAccountType type,
175                                      TnySessionCamel *session,
176                                      TnyGetPassFunc get_pass_func,
177                                      TnyForgetPassFunc forget_pass_func) 
178 {
179         TnyAccount *tny_account = NULL;
180         ModestAccountData *account_data = NULL;
181         ModestServerAccountData *server_data = NULL;
182
183         g_return_val_if_fail (account_mgr, NULL);
184         g_return_val_if_fail (account_name, NULL);
185
186         account_data = modest_account_mgr_get_account_data (account_mgr, account_name);
187         if (!account_data) {
188                 g_printerr ("modest: cannot get account data for account %s\n", account_name);
189                 return NULL;
190         }
191
192         if (type == TNY_ACCOUNT_TYPE_STORE && account_data->store_account)
193                 server_data = account_data->store_account;
194         else if (type == TNY_ACCOUNT_TYPE_TRANSPORT && account_data->transport_account)
195                 server_data = account_data->transport_account;
196         if (!server_data) {
197                 g_printerr ("modest: no %s account defined for '%s'\n",
198                             type == TNY_ACCOUNT_TYPE_STORE ? "store" : "transport",
199                             account_data->display_name);
200                 modest_account_mgr_free_account_data (account_mgr, account_data);
201                 return NULL;
202         }
203         
204         tny_account = modest_tny_account_new_from_server_account (account_mgr, server_data);
205         if (!tny_account) { 
206                 g_printerr ("modest: failed to create tny account for %s (%s)\n",
207                             account_data->account_name, server_data->account_name);
208                 modest_account_mgr_free_account_data (account_mgr, account_data);
209                 return NULL;
210         }
211         
212         tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account), session);
213         tny_account_set_forget_pass_func (tny_account,
214                                           forget_pass_func ? forget_pass_func : forget_pass_dummy);
215         tny_account_set_pass_func (tny_account,
216                                    get_pass_func ? get_pass_func: get_pass_dummy);
217
218         /* this name is what shows up in the folder view -- so for some POP/IMAP/... server
219          * account, we set its name to the acount of which it is part */
220         if (account_data->display_name)
221                 tny_account_set_name (tny_account, account_data->display_name); 
222
223         g_object_set_data_full (G_OBJECT(tny_account), "modest_account",
224                                 (gpointer*) g_strdup (account_name), g_free);
225         
226         modest_account_mgr_free_account_data (account_mgr, account_data);
227         return tny_account;
228 }
229
230
231 TnyAccount*
232 modest_tny_account_new_for_local_folders (ModestAccountMgr *account_mgr, TnySessionCamel *session)
233 {
234         TnyStoreAccount *tny_account;
235         CamelURL *url;
236         gchar *maildir, *url_string;
237
238         g_return_val_if_fail (account_mgr, NULL);
239         
240         tny_account = tny_camel_store_account_new ();
241         if (!tny_account) {
242                 g_printerr ("modest: cannot create account for local folders");
243                 return NULL;
244         }
245         tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account), session);
246         
247         maildir = modest_local_folder_info_get_maildir_path ();
248         url = camel_url_new ("maildir:", NULL);
249         camel_url_set_path (url, maildir);
250         url_string = camel_url_to_string (url, 0);
251         
252         tny_account_set_url_string (TNY_ACCOUNT(tny_account), url_string);
253
254         tny_account_set_name (TNY_ACCOUNT(tny_account), MODEST_LOCAL_FOLDERS_DEFAULT_DISPLAY_NAME); 
255         tny_account_set_id (TNY_ACCOUNT(tny_account), MODEST_LOCAL_FOLDERS_ACCOUNT_ID); 
256         tny_account_set_forget_pass_func (TNY_ACCOUNT(tny_account), forget_pass_dummy);
257         tny_account_set_pass_func (TNY_ACCOUNT(tny_account), get_pass_dummy);
258         
259         g_object_set_data (G_OBJECT(tny_account), "modest_account",
260                            (gpointer*)MODEST_LOCAL_FOLDERS_ACCOUNT_ID);
261         
262         camel_url_free (url);
263         g_free (maildir);
264         g_free (url_string);
265
266         return TNY_ACCOUNT(tny_account);
267 }
268