Hidden preference to limit PGP autocompletion
[claws.git] / src / plugins / pgpcore / autocompletion.c
1 /*
2  * PGP/Core keyring autocompletion
3  *
4  * Copyright (C) 2014 Christian Hesse <mail@eworm.de> and the Claws Mail team
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19  */
20
21
22 #ifdef HAVE_CONFIG_H
23 #  include "config.h"
24 #include "claws-features.h"
25 #endif
26
27 #include <errno.h>
28 #include <inttypes.h>
29 #include <stdlib.h>
30
31 #include <glib.h>
32 #include <glib/gi18n.h>
33
34 #include <gpgme.h>
35
36 #include "autocompletion.h"
37 #include "addr_compl.h"
38 #include "prefs_gpg.h"
39 #include "hooks.h"
40 #include "utils.h"
41
42 static guint autocompletion_hook_id = 0;
43
44 static gboolean pgp_autocompletion_hook(gpointer source, gpointer data)
45 {
46         gpgme_ctx_t ctx;
47         gpgme_key_t key;
48         gpgme_error_t err;
49         gpgme_user_id_t uid;
50         address_entry *ae;
51         GList *addr_list = NULL;
52         gint i;
53
54         /* just return if autocompletion is disabled */
55         if (!prefs_gpg_get_config()->autocompletion)
56                 return EXIT_SUCCESS;
57
58         /* initialize */
59         gpgme_check_version(NULL);
60
61         if ((err = gpgme_new(&ctx)) == 0) {
62                 err = gpgme_op_keylist_start(ctx, NULL, 0);
63
64                 /* walk the available keys */
65                 while (err == 0) {
66                         if ((err = gpgme_op_keylist_next(ctx, &key)) != 0)
67                                 break;
68
69                         /* skip keys that are revoked, expired, ... */
70                         if ((key->revoked || key->expired || key->disabled || key->invalid) == FALSE) {
71                                 uid = key->uids;
72                                 i = 0;
73
74                                 /* walk all user ids within a key */
75                                 while (uid != NULL) {
76                                         if (uid->email != NULL && *uid->email != 0) {
77                                                 ae = g_new0(address_entry, 1);
78
79                                                 ae->address = g_strdup(uid->email);
80                                                 addr_compl_add_address1(ae->address, ae);
81
82                                                 if (uid->name != NULL && *uid->name != 0) {
83                                                         ae->name = g_strdup(uid->name);
84                                                         addr_compl_add_address1(ae->name, ae);
85                                                 } else
86                                                         ae->name = NULL;
87
88                                                 ae->grp_emails = NULL;
89
90                                                 addr_list = g_list_prepend(addr_list, ae);
91
92                                                 debug_print("%s <%s>\n", uid->name, uid->email);
93                                         }
94
95                                         if (prefs_gpg_get_config()->autocompletion_limit > 0 &&
96                                                         prefs_gpg_get_config()->autocompletion_limit == i)
97                                                 break;
98
99                                         uid = uid->next;
100                                         i++;
101                                 }
102                         }
103                         gpgme_key_release(key);
104                 }
105                 gpgme_release(ctx);
106         }
107
108         if (gpg_err_code(err) != GPG_ERR_EOF) {
109                 debug_print("can not list keys: %s\n", gpgme_strerror(err));
110                 return EXIT_FAILURE;
111         }
112         *((GList **)source) = addr_list;
113
114         return EXIT_SUCCESS;
115 }
116
117 gboolean autocompletion_done(void)
118 {
119         if (autocompletion_hook_id > 0)
120         {
121                 hooks_unregister_hook(ADDDRESS_COMPLETION_BUILD_ADDRESS_LIST_HOOKLIST, autocompletion_hook_id);
122
123                 debug_print("PGP address autocompletion hook unregistered\n");
124         }
125
126         return TRUE;
127 }
128
129 gint autocompletion_init(gchar ** error)
130 {
131         if ((autocompletion_hook_id = hooks_register_hook(ADDDRESS_COMPLETION_BUILD_ADDRESS_LIST_HOOKLIST, pgp_autocompletion_hook, NULL)) == -1)
132         {
133                 *error = g_strdup(_("Failed to register PGP address autocompletion hook"));
134                 return -1;
135         }
136         debug_print("PGP address autocompletion hook registered\n");
137
138         return EXIT_SUCCESS;
139 }
140