Hidden preference to limit PGP autocompletion
[claws.git] / src / plugins / pgpcore / prefs_gpg.c
index 2156de994d5af2471973f8adb632408d7e761841..eb543a31ea224d1c207899b3578f9eba8ad8ffa6 100644 (file)
@@ -1,10 +1,10 @@
 /*
- * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 2004-2007 Hiroyuki Yamamoto & the Claws Mail team
+ * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
+ * Copyright (C) 2004-2015 the Claws Mail team
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * 
  */
 
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#include "claws-features.h"
+#endif
+
 #include <gtk/gtk.h>
 #include <glib.h>
 #include <glib/gi18n.h>
 
+#include <gtk/filesel.h>
+
 #include "defs.h"
-#include "utils.h"
 #include "gtk/gtkutils.h"
+#include "utils.h" 
 #include "prefs.h"
+#include "prefs_common.h"
 #include "prefs_gtk.h"
 #include "prefs_gpg.h"
 #include "sgpgme.h"
@@ -36,7 +44,13 @@ static PrefParam param[] = {
        {"auto_check_signatures", "FALSE",
         &prefs_gpg.auto_check_signatures, P_BOOL,
         NULL, NULL, NULL},
-       {"use_agent_if_available", "TRUE", &prefs_gpg.use_agent_if_available, P_BOOL,
+       {"autocompletion", "FALSE",
+        &prefs_gpg.autocompletion, P_BOOL,
+        NULL, NULL, NULL},
+       {"autocompletion_limit", "0",
+        &prefs_gpg.autocompletion_limit, P_INT,
+        NULL, NULL, NULL},
+       {"use_gpg_agent", "TRUE", &prefs_gpg.use_gpg_agent, P_BOOL,
         NULL, NULL, NULL},
        {"store_passphrase", "FALSE", &prefs_gpg.store_passphrase, P_BOOL,
         NULL, NULL, NULL},
@@ -49,20 +63,29 @@ static PrefParam param[] = {
         NULL, NULL, NULL},
        {"gpg_ask_create_key", "TRUE", &prefs_gpg.gpg_ask_create_key, P_BOOL,
         NULL, NULL, NULL},
+       {"skip_encryption_warning", "", &prefs_gpg.skip_encryption_warning, P_STRING,
+        NULL, NULL, NULL},
+       {"gpg_path", "", &prefs_gpg.gpg_path, P_STRING,
+        NULL, NULL, NULL},
 
        {NULL, NULL, NULL, P_OTHER, NULL, NULL, NULL}
 };
 
+static gchar *saved_gpg_agent_info = NULL;
+static void gpg_path_browse_cb(GtkWidget *widget, gpointer data);
+
 struct GPGPage
 {
        PrefsPage page;
 
        GtkWidget *checkbtn_auto_check_signatures;
-       GtkWidget *checkbtn_use_agent_if_available;
+       GtkWidget *checkbtn_autocompletion;
+       GtkWidget *checkbtn_use_gpg_agent;
         GtkWidget *checkbtn_store_passphrase;  
         GtkWidget *spinbtn_store_passphrase;  
         GtkWidget *checkbtn_passphrase_grab;  
         GtkWidget *checkbtn_gpg_warning;
+       GtkWidget *gpg_path;
 };
 
 static void prefs_gpg_create_widget_func(PrefsPage *_page,
@@ -72,22 +95,21 @@ static void prefs_gpg_create_widget_func(PrefsPage *_page,
        struct GPGPage *page = (struct GPGPage *) _page;
        struct GPGConfig *config;
 
-       GtkWidget *checkbtn_use_agent_if_available;
+       GtkWidget *checkbtn_use_gpg_agent;
        GtkWidget *checkbtn_passphrase_grab;
        GtkWidget *checkbtn_store_passphrase;
        GtkWidget *checkbtn_auto_check_signatures;
+       GtkWidget *checkbtn_autocompletion;
        GtkWidget *checkbtn_gpg_warning;
-       GtkWidget *hbox1;
+       GtkWidget *hbox1, *hbox2;
        GtkWidget *vbox1, *vbox2;
+       GtkWidget *label_gpg_path;
        GtkWidget *label_expire1;
-       GtkObject *spinbtn_store_passphrase_adj;
+       GtkAdjustment *spinbtn_store_passphrase_adj;
        GtkWidget *spinbtn_store_passphrase;
        GtkWidget *label_expire2;
        GtkWidget *frame_passphrase;
-       GtkWidget *label;
-       GtkTooltips *tooltips;
-       
-       tooltips = gtk_tooltips_new();
+       GtkWidget *gpg_path, *gpg_path_btn;
 
        vbox1 = gtk_vbox_new (FALSE, VSPACING);
        gtk_widget_show (vbox1);
@@ -100,30 +122,33 @@ static void prefs_gpg_create_widget_func(PrefsPage *_page,
        PACK_CHECK_BUTTON (vbox2, checkbtn_auto_check_signatures,
                        _("Automatically check signatures"));
 
-       vbox2 = gtkut_get_options_frame(vbox1, &frame_passphrase, _("Passphrase"));
+       PACK_CHECK_BUTTON (vbox2, checkbtn_autocompletion,
+                       _("Use keyring for address autocompletion"));
 
-       PACK_CHECK_BUTTON (vbox2, checkbtn_use_agent_if_available,
-                       _("Use gpg-agent if it is available"));
+       vbox2 = gtkut_get_options_frame(vbox1, &frame_passphrase, _("Passphrase"));
 
-       label = gtk_label_new(_("Else,"));
-       gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
-       gtk_widget_show (label);
+       PACK_CHECK_BUTTON (vbox2, checkbtn_use_gpg_agent,
+                       _("Use gpg-agent to manage passwords"));
+       if (saved_gpg_agent_info == NULL)
+               gtk_widget_set_sensitive(checkbtn_use_gpg_agent, FALSE);
 
-       gtk_box_pack_start(GTK_BOX(vbox2), label, FALSE, FALSE, 0);
-       
        PACK_CHECK_BUTTON (vbox2, checkbtn_store_passphrase,
                        _("Store passphrase in memory"));
 
+       SET_TOGGLE_SENSITIVITY_REVERSE(checkbtn_use_gpg_agent, checkbtn_store_passphrase);
+
        hbox1 = gtk_hbox_new (FALSE, 8);
        gtk_widget_show (hbox1);
        gtk_box_pack_start (GTK_BOX (vbox2), hbox1, FALSE, FALSE, 0);
 
+       SET_TOGGLE_SENSITIVITY_REVERSE(checkbtn_use_gpg_agent, hbox1);
+
        label_expire1 = gtk_label_new(_("Expire after"));
        gtk_widget_show (label_expire1);
        gtk_box_pack_start (GTK_BOX (hbox1), label_expire1, FALSE, FALSE, 0);
 
        spinbtn_store_passphrase_adj =
-           gtk_adjustment_new(1, 0, 1440, 1, 10, 10);
+           GTK_ADJUSTMENT(gtk_adjustment_new(1, 0, 1440, 1, 10, 0));
        spinbtn_store_passphrase =
            gtk_spin_button_new(GTK_ADJUSTMENT
                                (spinbtn_store_passphrase_adj), 1, 0);
@@ -131,10 +156,8 @@ static void prefs_gpg_create_widget_func(PrefsPage *_page,
        gtk_box_pack_start(GTK_BOX(hbox1), spinbtn_store_passphrase, FALSE,
                           FALSE, 0);
        gtk_widget_set_size_request(spinbtn_store_passphrase, 64, -1);
-       gtk_tooltips_set_tip(tooltips, spinbtn_store_passphrase,
-                            _
-                            ("Setting to '0' will store the passphrase for the whole session"),
-                            NULL);
+       CLAWS_SET_TIP(spinbtn_store_passphrase,
+                     _("Setting to '0' will store the passphrase for the whole session"));
        gtk_spin_button_set_numeric(GTK_SPIN_BUTTON
                                    (spinbtn_store_passphrase), TRUE);
 
@@ -157,24 +180,61 @@ static void prefs_gpg_create_widget_func(PrefsPage *_page,
        PACK_CHECK_BUTTON (vbox2, checkbtn_gpg_warning,
                        _("Display warning on start-up if GnuPG doesn't work"));
 
+       hbox2 = gtk_hbox_new(FALSE, 6);
+       label_gpg_path = gtk_label_new(_("Path to GnuPG executable"));
+       gtk_box_pack_start(GTK_BOX(hbox2), label_gpg_path, FALSE, FALSE, 0);
+       gpg_path = gtk_entry_new();
+       gtk_box_pack_start(GTK_BOX(hbox2), gpg_path, TRUE, TRUE, 0);
+       CLAWS_SET_TIP(gpg_path,
+                     _("If left blank the location of the GnuPG executable will be automatically determined."));
+       gpg_path_btn = gtkut_get_browse_file_btn(_("Bro_wse"));
+       gtk_box_pack_start(GTK_BOX(hbox2), gpg_path_btn, FALSE, FALSE, 0);
+       g_signal_connect(G_OBJECT(gpg_path_btn), "clicked",
+                        G_CALLBACK(gpg_path_browse_cb), gpg_path);
+       pref_set_entry_from_pref(GTK_ENTRY(gpg_path), prefs_gpg.gpg_path);
+
+       gtk_box_pack_start(GTK_BOX(vbox2), hbox2, FALSE, FALSE, 0);
+       gtk_widget_show_all(vbox1);
+
        config = prefs_gpg_get_config();
 
        gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_auto_check_signatures), config->auto_check_signatures);
-       gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_use_agent_if_available), config->use_agent_if_available);
-       gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_store_passphrase), config->store_passphrase);
+       gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_autocompletion), config->autocompletion);
+       if (!getenv("GPG_AGENT_INFO"))
+               gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_use_gpg_agent), FALSE);
+       else
+               gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_use_gpg_agent), config->use_gpg_agent);
+       if (!gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(checkbtn_use_gpg_agent)))
+               gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_store_passphrase), config->store_passphrase);
        gtk_spin_button_set_value(GTK_SPIN_BUTTON(spinbtn_store_passphrase), (float) config->store_passphrase_timeout);
        gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_passphrase_grab), config->passphrase_grab);
        gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_gpg_warning), config->gpg_warning);
+       gtk_entry_set_text(GTK_ENTRY(gpg_path), config->gpg_path);
 
        page->checkbtn_auto_check_signatures = checkbtn_auto_check_signatures;
+       page->checkbtn_autocompletion = checkbtn_autocompletion;
        page->checkbtn_store_passphrase = checkbtn_store_passphrase;
        page->spinbtn_store_passphrase = spinbtn_store_passphrase;
        page->checkbtn_passphrase_grab = checkbtn_passphrase_grab;
        page->checkbtn_gpg_warning = checkbtn_gpg_warning;
-       page->checkbtn_use_agent_if_available = checkbtn_use_agent_if_available;
+       page->checkbtn_use_gpg_agent = checkbtn_use_gpg_agent;
+       page->gpg_path = gpg_path;
        page->page.widget = vbox1;
 }
 
+static void gpg_path_browse_cb(GtkWidget* widget, gpointer data)
+{
+       gchar *filename;
+       GtkEntry *dest = GTK_ENTRY(data);
+
+       filename = filesel_select_file_open(_("Select GnuPG executable"), NULL);
+       if (!filename)
+               return;
+
+       gtk_entry_set_text(GTK_ENTRY(dest), filename);
+       g_free(filename);
+}
+
 static void prefs_gpg_destroy_widget_func(PrefsPage *_page)
 {
 }
@@ -186,8 +246,10 @@ static void prefs_gpg_save_func(PrefsPage *_page)
 
        config->auto_check_signatures =
                gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->checkbtn_auto_check_signatures));
-       config->use_agent_if_available = 
-               gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->checkbtn_use_agent_if_available));
+       config->autocompletion =
+               gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->checkbtn_autocompletion));
+       config->use_gpg_agent = 
+               gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->checkbtn_use_gpg_agent));
        config->store_passphrase = 
                gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->checkbtn_store_passphrase));
        config->store_passphrase_timeout = 
@@ -196,6 +258,12 @@ static void prefs_gpg_save_func(PrefsPage *_page)
                gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->checkbtn_passphrase_grab));
        config->gpg_warning = 
                gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->checkbtn_gpg_warning));
+       g_free(config->gpg_path);
+       config->gpg_path = g_strdup(gtk_entry_get_text(GTK_ENTRY(page->gpg_path)));
+       if (strcmp(config->gpg_path, "") != 0 && access(config->gpg_path, X_OK) != -1)
+               gpgme_set_engine_info(GPGME_PROTOCOL_OpenPGP, config->gpg_path, NULL);
+
+       prefs_gpg_enable_agent(config->use_gpg_agent);
 
        prefs_gpg_save_config();
 }
@@ -438,9 +506,11 @@ void prefs_gpg_save_config(void)
                prefs_file_close_revert(pfile);
                return;
        }
-       fprintf(pfile->fp, "\n");
-
-       prefs_file_close(pfile);
+        if (fprintf(pfile->fp, "\n") < 0) {
+               FILE_OP_ERROR(rcpath, "fprintf");
+               prefs_file_close_revert(pfile);
+       } else
+               prefs_file_close(pfile);
 }
 
 struct GPGAccountConfig *prefs_gpg_account_get_config(PrefsAccount *account)
@@ -509,10 +579,33 @@ void prefs_gpg_account_free_config(GPGAccountConfig *config)
 static struct GPGPage gpg_page;
 static struct GPGAccountPage gpg_account_page;
 
+void prefs_gpg_enable_agent(gboolean enable)
+{
+       if (enable) {
+               if (saved_gpg_agent_info) {
+                       g_setenv("GPG_AGENT_INFO",
+                                saved_gpg_agent_info, TRUE);
+                       debug_print("set GPG_AGENT_INFO=%s\n", 
+                               saved_gpg_agent_info);
+               } else { 
+                       debug_print("Can't enable gpg agent (no GPG_AGENT_INFO)\n");
+               }
+       } else {
+               if (saved_gpg_agent_info) {
+                       g_unsetenv("GPG_AGENT_INFO");
+                       debug_print("unset GPG_AGENT_INFO=%s\n", 
+                               saved_gpg_agent_info);
+               } else {
+                       debug_print("Can't disable gpg agent (no GPG_AGENT_INFO)\n");
+               }
+       }
+}
+
 void prefs_gpg_init()
 {
        static gchar *path[3];
        gchar *rcpath;
+       const gchar *tmp = NULL;
 
        prefs_set_default(param);
        rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
@@ -538,10 +631,85 @@ void prefs_gpg_init()
         gpg_account_page.page.weight = 30.0;
 
         prefs_account_register_page((PrefsPage *) &gpg_account_page);
+       
+       tmp = g_getenv("GPG_AGENT_INFO");
+       if (tmp)
+               saved_gpg_agent_info = g_strdup(tmp);
+
+       prefs_gpg_enable_agent(prefs_gpg_get_config()->use_gpg_agent);
 }
 
 void prefs_gpg_done()
 {
        prefs_gtk_unregister_page((PrefsPage *) &gpg_page);
        prefs_account_unregister_page((PrefsPage *) &gpg_account_page);
+       prefs_gpg_enable_agent(TRUE);
+}
+
+gboolean prefs_gpg_should_skip_encryption_warning(const gchar *systemid)
+{
+       gchar **systems = NULL;
+       int i = 0;
+       if (prefs_gpg_get_config()->skip_encryption_warning == NULL)
+               return FALSE;
+       systems = g_strsplit(prefs_gpg_get_config()->skip_encryption_warning,
+                               ",", -1);
+       while (systems && systems[i]) {
+               debug_print(" cmp %s %s\n", systems[i], systemid);
+               if (!strcmp(systems[i],systemid)) {
+                       g_strfreev(systems);
+                       return TRUE;
+               }
+               i++;
+       }
+       g_strfreev(systems);
+       return FALSE;
+}
+
+void prefs_gpg_add_skip_encryption_warning(const gchar *systemid)
+{
+       gchar *tmp = NULL;
+       if (prefs_gpg_get_config()->skip_encryption_warning == NULL)
+               prefs_gpg_get_config()->skip_encryption_warning =
+                       g_strdup_printf("%s,", systemid);
+       else if (!prefs_gpg_should_skip_encryption_warning(systemid)) {
+               tmp = g_strdup_printf("%s%s,",
+                       prefs_gpg_get_config()->skip_encryption_warning,
+                       systemid);
+               g_free(prefs_gpg_get_config()->skip_encryption_warning);
+               prefs_gpg_get_config()->skip_encryption_warning = tmp;
+       }
+       prefs_gpg_save_config();
+}
+
+void prefs_gpg_remove_skip_encryption_warning(const gchar *systemid)
+{
+       gchar **systems = NULL;
+       int i = 0;
+       if (prefs_gpg_get_config()->skip_encryption_warning == NULL)
+               return;
+
+       if (prefs_gpg_should_skip_encryption_warning(systemid)) {
+               systems = g_strsplit(prefs_gpg_get_config()->skip_encryption_warning,
+                               ",", -1);
+               g_free(prefs_gpg_get_config()->skip_encryption_warning);
+               prefs_gpg_get_config()->skip_encryption_warning = NULL;
+
+               while (systems && systems[i]) {
+                       if (!strcmp(systems[i],systemid)) {
+                               i++;
+                               continue;
+                       }
+                       prefs_gpg_add_skip_encryption_warning(systems[i]);
+                       i++;
+               }
+               
+               g_strfreev(systems);
+       }
+       prefs_gpg_save_config();
+}
+
+gboolean prefs_gpg_auto_check_signatures(void)
+{
+       return prefs_gpg_get_config()->auto_check_signatures;
 }