aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/misc/e-account-combo-box.c
blob: ed3615a2766f8dcf24000fb2feca9049820392fe (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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
/*
 * e-account-combo-box.c
 *
 * 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)
 *
 */

#include "e-account-combo-box.h"

#include <string.h>

enum {
    COLUMN_STRING,
    COLUMN_ACCOUNT
};

enum {
    REFRESHED,
    LAST_SIGNAL
};

struct _EAccountComboBoxPrivate {
    EAccountList *account_list;
    GHashTable *index;
    gint num_displayed_accounts;
};

static CamelSession *camel_session;
static guint signal_ids[LAST_SIGNAL];

G_DEFINE_TYPE (
    EAccountComboBox,
    e_account_combo_box,
    GTK_TYPE_COMBO_BOX)

static gboolean
account_combo_box_has_dupes (GList *list,
                             const gchar *address)
{
    GList *iter;
    guint count = 0;

    /* Look for duplicates of the given email address. */
    for (iter = list; iter != NULL; iter = iter->next) {
        EAccount *account = iter->data;

        if (g_ascii_strcasecmp (account->id->address, address) == 0)
            count++;
    }

    return (count > 1);
}

static EAccount *
account_combo_box_choose_account (EAccountComboBox *combo_box)
{
    EAccountList *account_list;
    EAccount *account;
    GtkTreeModel *model;
    GtkTreeIter iter;

    account_list = e_account_combo_box_get_account_list (combo_box);
    g_return_val_if_fail (account_list != NULL, NULL);

    /* First try the default account. */

    /* XXX EAccountList misuses const. */
    account = (EAccount *)
        e_account_list_get_default (account_list);

    /* If there is no default account, give up. */
    if (account == NULL)
        return NULL;

    /* Make sure the default account appears in the combo box. */
    if (g_hash_table_lookup (combo_box->priv->index, account) != NULL)
        return account;

    /* Default account is disabled or otherwise unusable,
     * so fall back to the first account in the combo box. */

    model = gtk_combo_box_get_model (GTK_COMBO_BOX (combo_box));

    if (!gtk_tree_model_get_iter_first (model, &iter))
        return NULL;

    gtk_tree_model_get (model, &iter, COLUMN_ACCOUNT, &account, -1);

    return account;
}

static gboolean
account_combo_box_test_account (EAccount *account)
{
    CamelStore *store;
    const gchar *url;
    gboolean writable = FALSE;

    /* Account must be enabled. */
    if (!account->enabled)
        return FALSE;

    /* Account must have a non-empty email address. */
    if (account->id->address == NULL || *account->id->address == '\0')
        return FALSE;

    /* XXX Not sure I understand this part. */
    if (account->parent_uid == NULL)
        return TRUE;

    /* Account must be writable. */
    url = e_account_get_string (account, E_ACCOUNT_SOURCE_URL);
    store = CAMEL_STORE (camel_session_get_service (
        camel_session, url, CAMEL_PROVIDER_STORE, NULL));
    if (store != NULL) {
        writable = (store->mode & CAMEL_STORE_WRITE);
        g_object_unref (store);
    }

    return writable;
}

static void
account_combo_box_refresh_cb (EAccountList *account_list,
                              EAccount *unused,
                              EAccountComboBox *combo_box)
{
    GtkListStore *store;
    GtkTreeModel *model;
    EIterator *account_iter;
    EAccount *account;
    GHashTable *index;
    GList *list = NULL;
    GList *iter;

    combo_box->priv->num_displayed_accounts = 0;

    store = gtk_list_store_new (2, G_TYPE_STRING, E_TYPE_ACCOUNT);
    model = GTK_TREE_MODEL (store);
    index = combo_box->priv->index;

    g_hash_table_remove_all (index);

    if (account_list == NULL)
        goto skip;

    /* Build a list of EAccounts to display. */
    account_iter = e_list_get_iterator (E_LIST (account_list));
    while (e_iterator_is_valid (account_iter)) {
        EAccount *account;

        /* XXX EIterator misuses const. */
        account = (EAccount *) e_iterator_get (account_iter);
        if (account_combo_box_test_account (account))
            list = g_list_prepend (list, account);
        e_iterator_next (account_iter);
    }
    g_object_unref (account_iter);

    list = g_list_reverse (list);

    /* Populate the list store and index. */
    for (iter = list; iter != NULL; iter = iter->next) {
        GtkTreeRowReference *reference;
        GtkTreeIter tree_iter;
        GtkTreePath *path;
        gchar *string;

        account = iter->data;
        combo_box->priv->num_displayed_accounts++;

        /* Show the account name for duplicate email addresses. */
        if (account_combo_box_has_dupes (list, account->id->address))
            string = g_strdup_printf (
                "%s <%s> (%s)",
                account->id->name,
                account->id->address,
                account->name);
        else
            string = g_strdup_printf (
                "%s <%s>",
                account->id->name,
                account->id->address);

        gtk_list_store_append (store, &tree_iter);
        gtk_list_store_set (
            store, &tree_iter,
            COLUMN_STRING, string,
            COLUMN_ACCOUNT, account, -1);

        path = gtk_tree_model_get_path (model, &tree_iter);
        reference = gtk_tree_row_reference_new (model, path);
        g_hash_table_insert (index, account, reference);
        gtk_tree_path_free (path);

        g_free (string);
    }

    g_list_free (list);

skip:
    /* Restore the previously selected account. */
    account = e_account_combo_box_get_active (combo_box);
    if (account != NULL)
        g_object_ref (account);
    gtk_combo_box_set_model (GTK_COMBO_BOX (combo_box), model);
    e_account_combo_box_set_active (combo_box, account);
    if (account != NULL)
        g_object_unref (account);

    g_signal_emit (combo_box, signal_ids[REFRESHED], 0);
}

static GObject *
account_combo_box_constructor (GType type,
                               guint n_construct_properties,
                               GObjectConstructParam *construct_properties)
{
    GObject *object;
    GObjectClass *parent_class;
    GtkCellRenderer *renderer;

    /* Chain up to parent's constructor() method. */
    parent_class = G_OBJECT_CLASS (e_account_combo_box_parent_class);
    object = parent_class->constructor (
        type, n_construct_properties, construct_properties);

    renderer = gtk_cell_renderer_text_new ();

    gtk_cell_layout_pack_start (
        GTK_CELL_LAYOUT (object), renderer, TRUE);
    gtk_cell_layout_add_attribute (
        GTK_CELL_LAYOUT (object), renderer, "text", COLUMN_STRING);

    return object;
}

static void
account_combo_box_dispose (GObject *object)
{
    EAccountComboBoxPrivate *priv;

    priv = E_ACCOUNT_COMBO_BOX (object)->priv;

    if (priv->account_list != NULL) {
        g_signal_handlers_disconnect_by_func (
            priv->account_list,
            account_combo_box_refresh_cb, object);
        g_object_unref (priv->account_list);
        priv->account_list = NULL;
    }

    g_hash_table_remove_all (priv->index);

    /* Chain up to parent's dispose() method. */
    G_OBJECT_CLASS (e_account_combo_box_parent_class)->dispose (object);
}

static void
account_combo_box_finalize (GObject *object)
{
    EAccountComboBoxPrivate *priv;

    priv = E_ACCOUNT_COMBO_BOX (object)->priv;

    g_hash_table_destroy (priv->index);

    /* Chain up to parent's finalize() method. */
    G_OBJECT_CLASS (e_account_combo_box_parent_class)->finalize (object);
}

static void
e_account_combo_box_class_init (EAccountComboBoxClass *class)
{
    GObjectClass *object_class;

    g_type_class_add_private (class, sizeof (EAccountComboBoxPrivate));

    object_class = G_OBJECT_CLASS (class);
    object_class->constructor = account_combo_box_constructor;
    object_class->dispose = account_combo_box_dispose;
    object_class->finalize = account_combo_box_finalize;

    signal_ids[REFRESHED] = g_signal_new (
        "refreshed",
        G_TYPE_FROM_CLASS (class),
        G_SIGNAL_RUN_LAST,
        0, NULL, NULL,
        g_cclosure_marshal_VOID__VOID,
        G_TYPE_NONE, 0);
}

static void
e_account_combo_box_init (EAccountComboBox *combo_box)
{
    GHashTable *index;

    /* Reverse-lookup index */
    index = g_hash_table_new_full (
        g_direct_hash, g_direct_equal,
        (GDestroyNotify) g_object_unref,
        (GDestroyNotify) gtk_tree_row_reference_free);

    combo_box->priv = G_TYPE_INSTANCE_GET_PRIVATE (combo_box, E_TYPE_ACCOUNT_COMBO_BOX, EAccountComboBoxPrivate);
    combo_box->priv->index = index;
}

GtkWidget *
e_account_combo_box_new (void)
{
    return g_object_new (E_TYPE_ACCOUNT_COMBO_BOX, NULL);
}

void
e_account_combo_box_set_session (CamelSession *session)
{
    /* XXX Really gross hack.
     *
     * We need a CamelSession to test whether a given EAccount is
     * writable.  The global CamelSession object is defined in the
     * mailer, but we're too far down the stack to access it.  So
     * we have to rely on someone passing us a reference to it.
     *
     * A much cleaner solution would be to store the writeability
     * of an account directly into the EAccount, but this would likely
     * require breaking ABI and all the fun that goes along with that.
     */

    camel_session = session;
}

EAccountList *
e_account_combo_box_get_account_list (EAccountComboBox *combo_box)
{
    g_return_val_if_fail (E_IS_ACCOUNT_COMBO_BOX (combo_box), NULL);

    return combo_box->priv->account_list;
}

void
e_account_combo_box_set_account_list (EAccountComboBox *combo_box,
                                      EAccountList *account_list)
{
    EAccountComboBoxPrivate *priv;

    g_return_if_fail (E_IS_ACCOUNT_COMBO_BOX (combo_box));

    if (account_list != NULL)
        g_return_if_fail (E_IS_ACCOUNT_LIST (account_list));

    priv = combo_box->priv;

    if (priv->account_list != NULL) {
        g_signal_handlers_disconnect_by_func (
            priv->account_list,
            account_combo_box_refresh_cb, combo_box);
        g_object_unref (priv->account_list);
        priv->account_list = NULL;
    }

    if (account_list != NULL) {
        priv->account_list = g_object_ref (account_list);

        /* Listen for changes to the account list. */
        g_signal_connect (
            priv->account_list, "account-added",
            G_CALLBACK (account_combo_box_refresh_cb), combo_box);
        g_signal_connect (
            priv->account_list, "account-changed",
            G_CALLBACK (account_combo_box_refresh_cb), combo_box);
        g_signal_connect (
            priv->account_list, "account-removed",
            G_CALLBACK (account_combo_box_refresh_cb), combo_box);
    }

    account_combo_box_refresh_cb (account_list, NULL, combo_box);
}

EAccount *
e_account_combo_box_get_active (EAccountComboBox *combo_box)
{
    EAccount *account;
    GtkTreeModel *model;
    GtkTreeIter iter;
    gboolean iter_set;

    g_return_val_if_fail (E_IS_ACCOUNT_COMBO_BOX (combo_box), NULL);

    iter_set = gtk_combo_box_get_active_iter (
        GTK_COMBO_BOX (combo_box), &iter);
    if (!iter_set)
        return NULL;

    model = gtk_combo_box_get_model (GTK_COMBO_BOX (combo_box));
    gtk_tree_model_get (model, &iter, COLUMN_ACCOUNT, &account, -1);

    return account;
}

gboolean
e_account_combo_box_set_active (EAccountComboBox *combo_box,
                                EAccount *account)
{
    EAccountList *account_list;
    GtkTreeRowReference *reference;
    GtkTreeModel *model;
    GtkTreePath *path;
    GtkTreeIter iter;
    gboolean iter_set;

    g_return_val_if_fail (E_IS_ACCOUNT_COMBO_BOX (combo_box), FALSE);

    if (account != NULL)
        g_return_val_if_fail (E_IS_ACCOUNT (account), FALSE);

    account_list = combo_box->priv->account_list;
    g_return_val_if_fail (account_list != NULL, FALSE);

    /* NULL means choose an account ourselves. */
    if (account == NULL)
        account = account_combo_box_choose_account (combo_box);

    if (account == NULL)
        return FALSE;

    /* Lookup the tree row reference for the account. */
    reference = g_hash_table_lookup (combo_box->priv->index, account);
    if (reference == NULL)
        return FALSE;

    /* Convert the reference to a tree iterator. */
    path = gtk_tree_row_reference_get_path (reference);
    model = gtk_combo_box_get_model (GTK_COMBO_BOX (combo_box));
    iter_set = gtk_tree_model_get_iter (model, &iter, path);
    gtk_tree_path_free (path);

    if (!iter_set)
        return FALSE;

    /* Activate the corresponding combo box item. */
    gtk_combo_box_set_active_iter (GTK_COMBO_BOX (combo_box), &iter);

    return TRUE;
}

const gchar *
e_account_combo_box_get_active_name (EAccountComboBox *combo_box)
{
    EAccount *account;

    g_return_val_if_fail (E_IS_ACCOUNT_COMBO_BOX (combo_box), NULL);

    account = e_account_combo_box_get_active (combo_box);
    return (account != NULL) ? account->name : NULL;
}

gboolean
e_account_combo_box_set_active_name (EAccountComboBox *combo_box,
                                     const gchar *account_name)
{
    EAccountList *account_list;
    EAccount *account;

    g_return_val_if_fail (E_IS_ACCOUNT_COMBO_BOX (combo_box), FALSE);

    account_list = combo_box->priv->account_list;
    g_return_val_if_fail (account_list != NULL, FALSE);

    /* XXX EAccountList misuses const. */
    account = (EAccount *) e_account_list_find (
        account_list, E_ACCOUNT_FIND_NAME, account_name);

    if (account == NULL)
        return FALSE;

    return e_account_combo_box_set_active (combo_box, account);
}

/**
 * e_account_combo_box_count_displayed_accounts:
 * @combo_box: an #EAccountComboBox
 *
 * Counts the number of accounts that are displayed in the @combo_box.  This may not
 * be the actual number of accounts that are configured, as some of those accounts
 * may be disabled by the user.
 *
 * Return value: number of active and valid accounts as shown in the @combo_box.
 */
gint
e_account_combo_box_count_displayed_accounts (EAccountComboBox *combo_box)
{
    g_return_val_if_fail (E_IS_ACCOUNT_COMBO_BOX (combo_box), -1);

    return combo_box->priv->num_displayed_accounts;
}