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