src/plugins/libravatar/libravatar_prefs.c

   1 /*
   2  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2015 Hiroyuki Yamamoto and the Claws Mail Team
   4  * Copyright (C) 2015 Ricardo Mones
   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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 #  include "config.h"
  22 #include "claws-features.h"
  23 #endif
  24
  25 #include <glib.h>
  26 #include <glib/gi18n.h>
  27
  28 #include "libravatar.h"
  29
  30 #include <gtk/gtk.h>
  31 #include <gtk/filesel.h>
  32
  33 #include "defs.h"
  34 #include "libravatar_prefs.h"
  35 #include "prefs_common.h"
  36 #include "prefs_gtk.h"
  37
  38 #define PREFS_BLOCK_NAME "Libravatar"
  39 #define NUM_DEF_BUTTONS 7
  40 #define CUSTOM_URL_BUTTON_INDEX 6
  41 /* cache interval goes from 1 hour to 30 days */
  42 #define INTERVAL_MIN_H 1.0
  43 #define INTERVAL_MAX_H 720.0
  44 /* timeout interval goes from 0 seconds (= use general timeout value)
  45    to (general timeout value - 1) seconds */
  46 #define TIMEOUT_MIN_S 0.0
  47
  48 LibravatarPrefs libravatarprefs;
  49 GHashTable *libravatarmisses;
  50
  51 struct LibravatarPrefsPage
  52 {
  53         PrefsPage page;
  54
  55         GtkWidget *cache_interval_spin;
  56         GtkWidget *cache_icons_check;
  57         GtkWidget *defm_radio[NUM_DEF_BUTTONS];
  58         GtkWidget *defm_url_text;
  59         GtkWidget *allow_redirects_check;
  60 #if (defined USE_GNUTLS && GLIB_CHECK_VERSION(2,22,0))
  61         GtkWidget *allow_federated_check;
  62 #endif
  63         GtkWidget *timeout;
  64 };
  65
  66 struct LibravatarPrefsPage libravatarprefs_page;
  67
  68 static PrefParam param[] = {
  69         { "base_url", "http://cdn.libravatar.org/avatar",
  70           &libravatarprefs.base_url,
  71           P_STRING, NULL, NULL, NULL },
  72         { "cache_interval", "24",
  73           &libravatarprefs.cache_interval,
  74           P_INT, NULL, NULL, NULL },
  75         { "cache_icons", "TRUE",
  76           &libravatarprefs.cache_icons,
  77           P_BOOL, NULL, NULL, NULL },
  78         { "default_mode", "0",
  79           &libravatarprefs.default_mode,
  80           P_INT, NULL, NULL, NULL },
  81         { "default_mode_url", "",
  82           &libravatarprefs.default_mode_url,
  83           P_STRING, NULL, NULL, NULL },
  84         { "allow_redirects", "TRUE",
  85           &libravatarprefs.allow_redirects,
  86           P_BOOL, NULL, NULL, NULL },
  87 #if (defined USE_GNUTLS && GLIB_CHECK_VERSION(2,22,0))
  88         { "allow_federated", "TRUE",
  89           &libravatarprefs.allow_federated,
  90           P_BOOL, NULL, NULL, NULL },
  91 #endif
  92         { "timeout", "0",
  93           &libravatarprefs.timeout,
  94           P_INT, NULL, NULL, NULL },
  95         {NULL, NULL, NULL, P_OTHER, NULL, NULL, NULL}
  96 };
  97
  98 static GtkWidget *create_checkbox(gchar *label, gchar *hint)
  99 {
 100         GtkWidget *cb = gtk_check_button_new_with_mnemonic(label);
 101         CLAWS_SET_TIP(cb, hint);
 102         gtk_widget_show(cb);
 103
 104         return cb;
 105 }
 106
 107 static void cache_icons_check_toggled_cb(GtkToggleButton *button, gpointer data)
 108 {
 109         gtk_widget_set_sensitive(libravatarprefs_page.cache_interval_spin,
 110                                  gtk_toggle_button_get_active(button));
 111 }
 112
 113 static GtkWidget *labeled_spinner_box(gchar *label, GtkWidget *spinner, gchar *units, gchar *hint)
 114 {
 115         GtkWidget *lbl, *lbla, *hbox;
 116
 117         lbl = gtk_label_new(label);
 118         gtk_widget_show(lbl);
 119         lbla = gtk_label_new(units);
 120         gtk_widget_show(lbla);
 121         hbox = gtk_hbox_new(FALSE, 6);
 122         if (hint != NULL) {
 123                 CLAWS_SET_TIP(spinner, hint);
 124         }
 125         gtk_box_pack_start(GTK_BOX(hbox), lbl, FALSE, FALSE, 0);
 126         gtk_box_pack_start(GTK_BOX(hbox), spinner, FALSE, FALSE, 0);
 127         gtk_box_pack_start(GTK_BOX(hbox), lbla, FALSE, FALSE, 0);
 128
 129         return hbox;
 130 }
 131
 132 static GtkWidget *p_create_frame_cache(struct LibravatarPrefsPage *page)
 133 {
 134         GtkWidget *vbox, *checkbox, *spinner, *hbox;
 135         GtkAdjustment *adj;
 136
 137         vbox =  gtk_vbox_new(FALSE, 6);
 138
 139         checkbox = create_checkbox(_("_Use cached icons"),
 140                                    _("Keep icons on disk for reusing instead "
 141                                      "of making another network request"));
 142         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbox),
 143                                      libravatarprefs.cache_icons);
 144         g_signal_connect(checkbox, "toggled",
 145                          G_CALLBACK(cache_icons_check_toggled_cb), NULL);
 146         page->cache_icons_check = checkbox;
 147
 148         adj = (GtkAdjustment *) gtk_adjustment_new(
 149                                         libravatarprefs.cache_interval,
 150                                         INTERVAL_MIN_H, INTERVAL_MAX_H, 1.0,
 151                                         0.0, 0.0);
 152         spinner = gtk_spin_button_new(adj, 1.0, 0);
 153         gtk_widget_show(spinner);
 154         gtk_widget_set_sensitive(spinner, libravatarprefs.cache_icons);
 155         hbox = labeled_spinner_box(_("Cache refresh interval"), spinner, _("hours"), NULL);
 156         page->cache_interval_spin = spinner;
 157
 158         gtk_box_pack_start(GTK_BOX(vbox), checkbox, FALSE, FALSE, 0);
 159         gtk_box_pack_start(GTK_BOX(vbox), hbox, FALSE, FALSE, 0);
 160
 161         return vbox;
 162 }
 163
 164 static void default_mode_radio_button_cb(GtkToggleButton *button, gpointer data)
 165 {
 166         guint mode;
 167         gboolean is_url;
 168
 169         if (gtk_toggle_button_get_active(button) != TRUE)
 170                 return;
 171
 172         mode = *((guint *)data);
 173         is_url = (mode == DEF_MODE_URL)? TRUE: FALSE;
 174
 175         gtk_widget_set_sensitive(libravatarprefs_page.defm_url_text, is_url);
 176         if (is_url) /* custom URL requires following redirects */
 177                 gtk_toggle_button_set_active(
 178                         GTK_TOGGLE_BUTTON(libravatarprefs_page.allow_redirects_check),
 179                         TRUE);
 180
 181         if (mode == DEF_MODE_NONE) {
 182                 prefs_common_get_prefs()->enable_avatars = AVATARS_ENABLE_BOTH;
 183         } else {
 184                 /* don't waste time with headers that won't be displayed */
 185                 prefs_common_get_prefs()->enable_avatars = AVATARS_DISABLE;
 186                 /* empty missing cache when switching to generated */
 187                 g_hash_table_remove_all(libravatarmisses);
 188         }
 189 }
 190
 191 static const guint radio_value[] = {
 192         DEF_MODE_NONE,
 193         DEF_MODE_MM,
 194         DEF_MODE_IDENTICON,
 195         DEF_MODE_MONSTERID,
 196         DEF_MODE_WAVATAR,
 197         DEF_MODE_RETRO,
 198         DEF_MODE_URL
 199 };
 200
 201 static GtkWidget *p_create_frame_missing(struct LibravatarPrefsPage *page)
 202 {
 203         GtkWidget *vbox, *radio[NUM_DEF_BUTTONS], *hbox, *entry;
 204         gboolean enable = FALSE;
 205         int i, e = 0;
 206         gchar *radio_label[] = {
 207                 _("None"),
 208                 _("Mystery man"),
 209                 _("Identicon"),
 210                 _("MonsterID"),
 211                 _("Wavatar"),
 212                 _("Retro"),
 213                 _("Custom URL")
 214         };
 215         gchar *radio_hint[] = {
 216                 _("A blank image"),
 217                 _("The unobtrusive low-contrast greyish silhouette"),
 218                 _("A generated geometric pattern"),
 219                 _("A generated full-body monster"),
 220                 _("A generated almost unique face"),
 221                 _("A generated 8-bit arcade-style pixelated image"),
 222                 _("Redirect to a user provided URL")
 223         };
 224
 225         vbox =  gtk_vbox_new(FALSE, 6);
 226
 227         for (i = 0; i < NUM_DEF_BUTTONS; ++i) {
 228                 enable = (libravatarprefs.default_mode == radio_value[i])? TRUE: FALSE;
 229                 e += enable? 1: 0;
 230                 radio[i] = gtk_radio_button_new_with_label_from_widget(
 231                                 (i > 0)? GTK_RADIO_BUTTON(radio[i - 1]): NULL, radio_label[i]);
 232                 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(radio[i]), enable);
 233                 if (i == CUSTOM_URL_BUTTON_INDEX) {
 234                         /* set related entry next to radio button */
 235                         entry = gtk_entry_new_with_max_length(MAX_URL_LENGTH);
 236                         CLAWS_SET_TIP(entry, _("Enter the URL you want to be "
 237                                 "redirected when no user icon is available. "
 238                                 "Leave an empty URL to use the default "
 239                                 "libravatar orange icon."));
 240                         gtk_widget_show(entry);
 241                         gtk_entry_set_text(GTK_ENTRY(entry),
 242                                 libravatarprefs.default_mode_url);
 243                         hbox = gtk_hbox_new(FALSE, 6);
 244                         gtk_box_pack_start(GTK_BOX(hbox), radio[i], FALSE, FALSE, 0);
 245                         gtk_box_pack_start(GTK_BOX(hbox), entry, TRUE, TRUE, 0);
 246                         gtk_widget_set_sensitive(entry,
 247                                 (libravatarprefs.default_mode == DEF_MODE_URL)
 248                                 ? TRUE: FALSE);
 249                         page->defm_url_text = entry;
 250                         gtk_box_pack_start(GTK_BOX(vbox), hbox, FALSE, FALSE, 0);
 251                 } else {
 252                         gtk_box_pack_start(GTK_BOX(vbox), radio[i], FALSE, FALSE, 0);
 253                 }
 254                 g_signal_connect(radio[i], "toggled",
 255                                  G_CALLBACK(default_mode_radio_button_cb),
 256                                  (gpointer) &(radio_value[i]));
 257                 CLAWS_SET_TIP(radio[i], radio_hint[i]);
 258                 gtk_widget_show(radio[i]);
 259                 page->defm_radio[i] = radio[i];
 260         }
 261         if (e == 0) { /* unknown value, go default */
 262                 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(radio[0]), TRUE);
 263                 libravatarprefs.default_mode = DEF_MODE_NONE;
 264         }
 265         /* don't waste time with headers that won't be displayed */
 266         prefs_common_get_prefs()->enable_avatars =
 267                 (libravatarprefs.default_mode == DEF_MODE_NONE)
 268                 ? AVATARS_ENABLE_BOTH: AVATARS_DISABLE;
 269
 270
 271
 272         return vbox;
 273 }
 274
 275 static GtkWidget *p_create_frame_network(struct LibravatarPrefsPage *page)
 276 {
 277         GtkWidget *vbox, *chk_redirects, *spinner, *hbox;
 278         GtkAdjustment *adj;
 279 #if (defined USE_GNUTLS && GLIB_CHECK_VERSION(2,22,0))
 280         GtkWidget *chk_federated;
 281 #endif
 282
 283         vbox =  gtk_vbox_new(FALSE, 6);
 284
 285         chk_redirects = create_checkbox(_("_Allow redirects to other sites"),
 286                                    _("Follow redirect responses received from "
 287                                      "libravatar server to other avatar "
 288                                      "services like gravatar.com"));
 289         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(chk_redirects),
 290                                      libravatarprefs.allow_redirects);
 291         page->allow_redirects_check = chk_redirects;
 292         gtk_box_pack_start(GTK_BOX(vbox), chk_redirects, FALSE, FALSE, 0);
 293
 294 #if (defined USE_GNUTLS && GLIB_CHECK_VERSION(2,22,0))
 295         chk_federated = create_checkbox(_("_Enable federated servers"),
 296                                 _("Try to get avatar from sender's domain "
 297                                   "libravatar server"));
 298         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(chk_federated),
 299                                      libravatarprefs.allow_federated);
 300         page->allow_federated_check = chk_federated;
 301         gtk_box_pack_start(GTK_BOX(vbox), chk_federated, FALSE, FALSE, 0);
 302 #endif
 303
 304         adj = (GtkAdjustment *) gtk_adjustment_new(
 305                                         libravatarprefs.timeout,
 306                                         TIMEOUT_MIN_S,
 307                                         (prefs_common_get_prefs()->io_timeout_secs > 0)
 308                                         ? (prefs_common_get_prefs()->io_timeout_secs - 1)
 309                                         : 0,
 310                                         1.0, 0.0, 0.0);
 311         spinner = gtk_spin_button_new(adj, 1.0, 0);
 312         gtk_widget_show(spinner);
 313         hbox = labeled_spinner_box(_("Request timeout"), spinner, _("seconds"),
 314                 _("Set to 0 to use global socket I/O timeout. "
 315                   "Maximum value must be also less than global socket "
 316                   "I/O timeout."));
 317         page->timeout = spinner;
 318         gtk_box_pack_start(GTK_BOX(vbox), hbox, FALSE, FALSE, 0);
 319
 320         return vbox;
 321 }
 322
 323 /*
 324   ┌─Icon cache───────────────────────────────────────────┐
 325   │ [✔] Use cached icons                                 │
 326   │ Cache refresh interval [ 24 |⬘] hours                │
 327   └──────────────────────────────────────────────────────┘
 328   ┌─Default missing icon mode────────────────────────────┐
 329   │ (•) None                                             │
 330   │ ( ) Mystery man                                      │
 331   │ ( ) Identicon                                        │
 332   │ ( ) MonsterID                                        │
 333   │ ( ) Wavatar                                          │
 334   │ ( ) Retro                                            │
 335   │ ( ) Custom URL [___________________________________] │
 336   └──────────────────────────────────────────────────────┘
 337   ┌─Network──────────────────────────────────────────────┐
 338   │ [✔] Allow redirects                                  │
 339   │ [✔] Federated servers                                │
 340   │ Timeout [ 10 |⬘] seconds                             │
 341   └──────────────────────────────────────────────────────┘
 342  */
 343 static void libravatar_prefs_create_widget_func(PrefsPage * _page,
 344                                                 GtkWindow * window,
 345                                                 gpointer data)
 346 {
 347         struct LibravatarPrefsPage *page = (struct LibravatarPrefsPage *) _page;
 348         GtkWidget *vbox, *vbox1, *vbox2, *vbox3, *frame;
 349
 350         vbox1 = p_create_frame_cache(page);
 351         vbox2 = p_create_frame_missing(page);
 352         vbox3 = p_create_frame_network(page);
 353
 354         vbox = gtk_vbox_new(FALSE, 6);
 355         gtk_container_set_border_width(GTK_CONTAINER(vbox), VBOX_BORDER);
 356
 357         PACK_FRAME (vbox, frame, _("Icon cache"));
 358         gtk_container_set_border_width(GTK_CONTAINER(vbox1), 6);
 359         gtk_container_add(GTK_CONTAINER(frame), vbox1);
 360
 361         PACK_FRAME (vbox, frame, _("Default missing icon mode"));
 362         gtk_container_set_border_width(GTK_CONTAINER(vbox2), 6);
 363         gtk_container_add(GTK_CONTAINER(frame), vbox2);
 364
 365         PACK_FRAME (vbox, frame, _("Network"));
 366         gtk_container_set_border_width(GTK_CONTAINER(vbox3), 6);
 367         gtk_container_add(GTK_CONTAINER(frame), vbox3);
 368
 369         gtk_widget_show_all(vbox);
 370         page->page.widget = vbox;
 371 }
 372
 373 static void libravatar_prefs_destroy_widget_func(PrefsPage *_page)
 374 {
 375         /* nothing */
 376 }
 377
 378 static void libravatar_save_config(void)
 379 {
 380         PrefFile *pfile;
 381         gchar *rcpath;
 382
 383         debug_print("Saving Libravatar Page\n");
 384
 385         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
 386         pfile = prefs_write_open(rcpath);
 387         g_free(rcpath);
 388         if (!pfile || (prefs_set_block_label(pfile, PREFS_BLOCK_NAME) < 0))
 389                 return;
 390
 391         if (prefs_write_param(param, pfile->fp) < 0) {
 392                 g_warning("Failed to write Libravatar configuration to file\n");
 393                 prefs_file_close_revert(pfile);
 394                 return;
 395         }
 396         if (fprintf(pfile->fp, "\n") < 0) {
 397                 FILE_OP_ERROR(rcpath, "fprintf");
 398                 prefs_file_close_revert(pfile);
 399         } else
 400                 prefs_file_close(pfile);
 401 }
 402
 403 static void libravatar_prefs_save_func(PrefsPage * _page)
 404 {
 405         struct LibravatarPrefsPage *page = (struct LibravatarPrefsPage *) _page;
 406         int i;
 407
 408         /* cache */
 409         libravatarprefs.cache_icons = gtk_toggle_button_get_active(
 410                 GTK_TOGGLE_BUTTON(page->cache_icons_check));
 411         /* cache interval */
 412         libravatarprefs.cache_interval = gtk_spin_button_get_value_as_int(
 413                 GTK_SPIN_BUTTON(page->cache_interval_spin));
 414         /* default mode */
 415         for (i = 0; i < NUM_DEF_BUTTONS; ++i) {
 416                 if (gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->defm_radio[i]))) {
 417                         libravatarprefs.default_mode = radio_value[i];
 418                         break;
 419                 }
 420         }
 421         /* custom url */
 422         if (libravatarprefs.default_mode_url != NULL) {
 423                 g_free(libravatarprefs.default_mode_url);
 424         }
 425         libravatarprefs.default_mode_url = gtk_editable_get_chars(
 426                 GTK_EDITABLE(page->defm_url_text), 0, -1);
 427         /* redirects */
 428         libravatarprefs.allow_redirects = gtk_toggle_button_get_active(
 429                 GTK_TOGGLE_BUTTON(page->allow_redirects_check));
 430         /* federation */
 431 #if (defined USE_GNUTLS && GLIB_CHECK_VERSION(2,22,0))
 432         libravatarprefs.allow_federated = gtk_toggle_button_get_active(
 433                 GTK_TOGGLE_BUTTON(page->allow_federated_check));
 434 #endif
 435         /* timeout */
 436         libravatarprefs.timeout = gtk_spin_button_get_value_as_int(
 437                 GTK_SPIN_BUTTON(page->timeout));
 438
 439         libravatar_save_config();
 440 }
 441
 442 void libravatar_prefs_init(void)
 443 {
 444         static gchar *path[3];
 445         gchar *rcpath;
 446
 447         path[0] = _("Plugins");
 448         path[1] = _("Libravatar");
 449         path[2] = NULL;
 450
 451         prefs_set_default(param);
 452         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
 453         prefs_read_config(param, PREFS_BLOCK_NAME, rcpath, NULL);
 454         g_free(rcpath);
 455
 456         libravatarprefs_page.page.path = path;
 457         libravatarprefs_page.page.create_widget = libravatar_prefs_create_widget_func;
 458         libravatarprefs_page.page.destroy_widget = libravatar_prefs_destroy_widget_func;
 459         libravatarprefs_page.page.save_page = libravatar_prefs_save_func;
 460         libravatarprefs_page.page.weight = 40.0;
 461
 462         prefs_gtk_register_page((PrefsPage *) &libravatarprefs_page);
 463 }
 464
 465 void libravatar_prefs_done(void)
 466 {
 467         prefs_gtk_unregister_page((PrefsPage *) &libravatarprefs_page);
 468 }
 469