aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-account-utils.c
blob: 0172abc5535195821106cd46eef4d5e626e96aac (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 */

/**
 * SECTION: e-account-utils
 * @include: e-util/e-account-utils.h
 **/

#include "e-account-utils.h"

#include <string.h>
#include <gconf/gconf-client.h>

static EAccountList *global_account_list;

static gboolean
account_has_transport_url (EAccount *account)
{
    return (account != NULL) &&
        (account->enabled) &&
        (account->transport != NULL) &&
        (account->transport->url != NULL) &&
        (account->transport->url[0] != '\0');
}

/**
 * e_get_account_list:
 *
 * Returns the global #EAccountList.
 *
 * Returns: the global #EAccountList
 **/
EAccountList *
e_get_account_list (void)
{
    if (G_UNLIKELY (global_account_list == NULL)) {
        GConfClient *client;

        client = gconf_client_get_default ();
        global_account_list = e_account_list_new (client);
        g_object_unref (client);
    }

    g_return_val_if_fail (global_account_list != NULL, NULL);

    return global_account_list;
}

/**
 * e_get_default_account:
 *
 * Returns the #EAccount marked as the default mail account.
 *
 * Returns: the default #EAccount
 **/
EAccount *
e_get_default_account (void)
{
    EAccountList *account_list;
    const EAccount *account;

    account_list = e_get_account_list ();
    account = e_account_list_get_default (account_list);

    /* XXX EAccountList misuses const. */
    return (EAccount *) account;
}

/**
 * e_set_default_account:
 * @account: an #EAccount
 *
 * Marks @account as the default mail account.
 **/
void
e_set_default_account (EAccount *account)
{
    EAccountList *account_list;

    g_return_if_fail (E_IS_ACCOUNT (account));

    account_list = e_get_account_list ();
    e_account_list_set_default (account_list, account);
}

/**
 * e_get_account_by_name:
 * @name: a mail account name
 *
 * Returns the #EAccount with the given name, or %NULL if no such
 * account exists.
 *
 * Returns: an #EAccount having the given account name, or %NULL
 **/
EAccount *
e_get_account_by_name (const gchar *name)
{
    EAccountList *account_list;
    const EAccount *account;
    e_account_find_t find;

    g_return_val_if_fail (name != NULL, NULL);

    find = E_ACCOUNT_FIND_NAME;
    account_list = e_get_account_list ();
    account = e_account_list_find (account_list, find, name);

    /* XXX EAccountList misuses const. */
    return (EAccount *) account;
}

/**
 * e_get_account_by_uid:
 * @uid: a mail account UID
 *
 * Returns the #EAccount corresponding to the given unique identity (UID),
 * or %NULL if no such account exists.  The @uid can refer to an #EAccount
 * UID, a #CamelStore UID, or even a #CamelTransport UID.
 *
 * Returns: the corresponding #EAccount, or %NULL
 **/
EAccount *
e_get_account_by_uid (const gchar *uid)
{
    EAccountList *account_list;
    const EAccount *account;
    e_account_find_t find;
    gchar *account_uid;

    g_return_val_if_fail (uid != NULL, NULL);

    /* EAccounts have the following invariant:
     *
     *       CamelStore UID == EAccount UID
     *   CamelTransport UID == EAccount UID + "-transport"
     *
     * Therefore we can detect CamelTransport UIDs and convert them.
     */
    if (g_str_has_suffix (uid, "-transport"))
        account_uid = g_strndup (uid, strlen (uid) - 10);
    else
        account_uid = g_strdup (uid);

    find = E_ACCOUNT_FIND_UID;
    account_list = e_get_account_list ();
    account = e_account_list_find (account_list, find, account_uid);

    g_free (account_uid);

    /* XXX EAccountList misuses const. */
    return (EAccount *) account;
}

/**
 * e_get_any_enabled_account:
 *
 * Returns the default mail account if it's enabled, otherwise the first
 * enabled mail account in the global #EAccountList, or finally %NULL if
 * all mail accounts are disabled or none exist.
 *
 * Returns: an enabled #EAccount, or %NULL if there are none
 **/
EAccount *
e_get_any_enabled_account (void)
{
    EAccount *account;
    EAccountList *account_list;
    EIterator *iter;

    account = e_get_default_account ();
    if (account != NULL && account->enabled)
        return account;

    account = NULL;

    account_list = e_get_account_list ();
    iter = e_list_get_iterator (E_LIST (account_list));

    while (e_iterator_is_valid (iter) && account == NULL) {
        EAccount *candidate;

        /* XXX EIterator misuses const. */
        candidate = (EAccount *) e_iterator_get (iter);

        if (candidate->enabled)
            account = candidate;
        else
            e_iterator_next (iter);
    }

    g_object_unref (iter);

    return account;
}

/**
 * e_get_default_transport:
 *
 * Returns transport information for the default account if it's enabled and
 * has transport information, or else from the first enabled mail account in
 * the global #EAccountList that has transport information, or finally %NULL
 * if no transport information could be found.
 *
 * Returns: an #EAccount with transport info, or %NULL
 **/
EAccount *
e_get_default_transport (void)
{
    EAccountList *account_list;
    EAccount *account;
    EIterator *iterator;

    account = e_get_default_account ();
    if (account_has_transport_url (account))
        return account;

    account_list = e_get_account_list ();
    iterator = e_list_get_iterator (E_LIST (account_list));

    while (e_iterator_is_valid (iterator)) {
        /* XXX EIterator misuses const. */
        account = (EAccount *) e_iterator_get (iterator);
        if (account_has_transport_url (account)) {
            g_object_unref (iterator);
            return account;
        }
        e_iterator_next (iterator);
    }

    g_object_unref (iterator);

    return NULL;
}

/**
 * e_get_subscribable_accounts:
 * @session: a #CamelSession
 *
 * Returns a list of enabled accounts that support folder subscriptions.
 * The #EAccount objects are not referenced, but the list itself should
 * be should be freed with g_list_free().
 *
 * Returns: a list of #EAccount objects
 **/
GList *
e_get_subscribable_accounts (CamelSession *session)
{
    EAccountList *account_list;
    EAccount *account;
    EIterator *iterator;
    GList *subscribable = NULL;

    g_return_val_if_fail (CAMEL_IS_SESSION (session), NULL);

    account_list = e_get_account_list ();
    iterator = e_list_get_iterator (E_LIST (account_list));

    while (e_iterator_is_valid (iterator)) {
        CamelStore *store = NULL;

        /* XXX EIterator misuses const. */
        account = (EAccount *) e_iterator_get (iterator);

        if (account->enabled) {
            CamelService *service;

            service = camel_session_get_service (
                session, account->uid);
            if (CAMEL_IS_STORE (service))
                store = CAMEL_STORE (service);
        }

        e_iterator_next (iterator);

        if (store == NULL)
            continue;

        if (!camel_store_supports_subscriptions (store))
            continue;

        subscribable = g_list_prepend (subscribable, account);
    }

    g_object_unref (iterator);

    return g_list_reverse (subscribable);
}