Skip to content

Commit

Permalink
Merge pull request #71 from facetoe/history_purge_timeout
Browse files Browse the repository at this point in the history 
History purge timeout
  • Loading branch information
@CristianHenzel
CristianHenzel authored Jun 28, 2018
2 parents 4d45052 + ac1fdac commit c419051
Show file tree
Hide file tree
Showing 4 changed files with 160 additions and 55 deletions.
3 changes: 3 additions & 0 deletions src/main.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1041,6 +1041,9 @@ int main(int argc, char **argv) {
/* Init ClipIt */
clipit_init();

/* Create the history_timeout_timer if applicable */
init_history_timeout_timer();

/* Run GTK+ loop */
gtk_main();

Expand Down
52 changes: 27 additions & 25 deletions src/main.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,39 +36,41 @@ G_BEGIN_DECLS
#endif

typedef struct {
gboolean use_copy; /* Use copy */
gboolean use_primary; /* Use primary */
gboolean synchronize; /* Synchronize copy and primary */
gboolean automatic_paste; /* Automatically paste entry after selecting it */
gboolean show_indexes; /* Show index numbers in history menu */
gboolean save_uris; /* Save URIs in history */
gboolean use_rmb_menu; /* Use Right-Mouse-Button Menu */
gboolean use_copy; /* Use copy */
gboolean use_primary; /* Use primary */
gboolean synchronize; /* Synchronize copy and primary */
gboolean automatic_paste; /* Automatically paste entry after selecting it */
gboolean show_indexes; /* Show index numbers in history menu */
gboolean save_uris; /* Save URIs in history */
gboolean use_rmb_menu; /* Use Right-Mouse-Button Menu */

gboolean save_history; /* Save history */
gint history_limit; /* Items in history */
gboolean save_history; /* Save history */
gint history_limit; /* Items in history */
gboolean history_timeout; /* Clear history after timeout */
gint history_timeout_seconds; /* Seconds to wait before clearing history */

gint items_menu; /* Items in history menu */
gboolean statics_show; /* Show statics items in history menu */
gint statics_items; /* Static items in history menu */
gint items_menu; /* Items in history menu */
gboolean statics_show; /* Show statics items in history menu */
gint statics_items; /* Static items in history menu */

gboolean hyperlinks_only; /* Hyperlinks only */
gboolean confirm_clear; /* Confirm clear */
gboolean hyperlinks_only; /* Hyperlinks only */
gboolean confirm_clear; /* Confirm clear */

gboolean single_line; /* Show in a single line */
gboolean reverse_history; /* Show in reverse order */
gint item_length; /* Length of items */
gboolean single_line; /* Show in a single line */
gboolean reverse_history; /* Show in reverse order */
gint item_length; /* Length of items */

gint ellipsize; /* Omitting */
gint ellipsize; /* Omitting */

gchar* history_key; /* History menu hotkey */
gchar* actions_key; /* Actions menu hotkey */
gchar* menu_key; /* ClipIt menu hotkey */
gchar* search_key; /* ClipIt search hotkey */
gchar* offline_key; /* ClipIt offline mode hotkey */
gchar* history_key; /* History menu hotkey */
gchar* actions_key; /* Actions menu hotkey */
gchar* menu_key; /* ClipIt menu hotkey */
gchar* search_key; /* ClipIt search hotkey */
gchar* offline_key; /* ClipIt offline mode hotkey */

gboolean no_icon; /* No icon */
gboolean no_icon; /* No icon */

gboolean offline_mode; /* Offline mode */
gboolean offline_mode; /* Offline mode */
} prefs_t;

extern prefs_t prefs;
Expand Down
96 changes: 96 additions & 0 deletions src/preferences.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ GtkWidget *copy_check,
*save_uris_check,
*use_rmb_menu_check,
*history_spin,
*history_timeout_check,
*history_timeout_spin,
*items_menu,
*statics_show_check,
*statics_items_spin,
Expand All @@ -59,6 +61,9 @@ GtkTreeSelection* actions_selection;
GtkListStore* exclude_list;
GtkTreeSelection* exclude_selection;

/* Reference to the current history_timeout_timer */
guint history_timeout_timer;

/* Apply the new preferences */
static void apply_preferences()
{
Expand Down Expand Up @@ -89,6 +94,8 @@ static void apply_preferences()
prefs.use_rmb_menu = gtk_toggle_button_get_active((GtkToggleButton*)use_rmb_menu_check);
prefs.save_history = gtk_toggle_button_get_active((GtkToggleButton*)save_check);
prefs.history_limit = gtk_spin_button_get_value_as_int((GtkSpinButton*)history_spin);
prefs.history_timeout_seconds = gtk_spin_button_get_value_as_int((GtkSpinButton*)history_timeout_spin);
prefs.history_timeout = gtk_toggle_button_get_active((GtkToggleButton*)history_timeout_check);
prefs.items_menu = gtk_spin_button_get_value_as_int((GtkSpinButton*)items_menu);
prefs.statics_show = gtk_toggle_button_get_active((GtkToggleButton*)statics_show_check);
prefs.statics_items = gtk_spin_button_get_value_as_int((GtkSpinButton*)statics_items_spin);
Expand Down Expand Up @@ -129,6 +136,8 @@ void save_preferences()
g_key_file_set_boolean(rc_key, "rc", "use_rmb_menu", prefs.use_rmb_menu);
g_key_file_set_boolean(rc_key, "rc", "save_history", prefs.save_history);
g_key_file_set_integer(rc_key, "rc", "history_limit", prefs.history_limit);
g_key_file_set_integer(rc_key, "rc", "history_timeout_seconds", prefs.history_timeout_seconds);
g_key_file_set_boolean(rc_key, "rc", "history_timeout", prefs.history_timeout);
g_key_file_set_integer(rc_key, "rc", "items_menu", prefs.items_menu);
g_key_file_set_boolean(rc_key, "rc", "statics_show", prefs.statics_show);
g_key_file_set_integer(rc_key, "rc", "statics_items", prefs.statics_items);
Expand Down Expand Up @@ -239,6 +248,8 @@ void read_preferences()
prefs.use_rmb_menu = g_key_file_get_boolean(rc_key, "rc", "use_rmb_menu", NULL);
prefs.save_history = g_key_file_get_boolean(rc_key, "rc", "save_history", NULL);
prefs.history_limit = g_key_file_get_integer(rc_key, "rc", "history_limit", NULL);
prefs.history_timeout = g_key_file_get_boolean(rc_key, "rc", "history_timeout", NULL);
prefs.history_timeout_seconds = g_key_file_get_integer(rc_key, "rc", "history_timeout_seconds", NULL);
prefs.items_menu = g_key_file_get_integer(rc_key, "rc", "items_menu", NULL);
prefs.statics_show = g_key_file_get_boolean(rc_key, "rc", "statics_show", NULL);
prefs.statics_items = g_key_file_get_integer(rc_key, "rc", "statics_items", NULL);
Expand All @@ -258,6 +269,10 @@ void read_preferences()
/* Check for errors and set default values if any */
if ((!prefs.history_limit) || (prefs.history_limit > 1000) || (prefs.history_limit < 0))
prefs.history_limit = DEF_HISTORY_LIMIT;
if (!prefs.history_timeout)
prefs.history_timeout = DEF_HISTORY_TIMEOUT;
if (!prefs.history_timeout_seconds)
prefs.history_timeout_seconds = DEF_HISTORY_TIMEOUT_SECONDS;
if ((!prefs.items_menu) || (prefs.items_menu > 1000) || (prefs.items_menu < 0))
prefs.items_menu = DEF_ITEMS_MENU;
if ((!prefs.item_length) || (prefs.item_length > 75) || (prefs.item_length < 0))
Expand Down Expand Up @@ -398,6 +413,69 @@ static void check_toggled(GtkToggleButton *togglebutton, gpointer user_data)
} else {
gtk_widget_set_sensitive((GtkWidget*)statics_items_spin, FALSE);
}
/* If history_timeout is disabled, prevent interaction with the history_timeout_spinner */
if (gtk_toggle_button_get_active((GtkToggleButton*)history_timeout_check)) {
gtk_widget_set_sensitive((GtkWidget*)history_timeout_spin, TRUE);
} else {
gtk_widget_set_sensitive((GtkWidget*)history_timeout_spin, FALSE);
}
}


static void start_purge_timer(gint timeout_seconds);
static void stop_purge_timer();

/* Purge history if history_timeout is enabled. This function is called every prefs.history_timeout_seconds */
static gboolean purge_history() {
if (prefs.history_timeout) {
g_list_free(history);
history = NULL;
save_history();
clear_main_data();
return TRUE;
}
stop_purge_timer();
return FALSE;
}

/* Start the history_purge_timer. If another timer exists, it will be replaced */
void start_purge_timer(gint timeout_seconds) {
if (history_timeout_timer)
g_source_remove(history_timeout_timer);
history_timeout_timer = g_timeout_add_seconds(timeout_seconds, purge_history, NULL);
}

/* Stop the history_purge_timer. If no timer exists, nothing is done */
static void stop_purge_timer() {
if (history_timeout_timer) {
g_source_remove(history_timeout_timer);
history_timeout_timer = 0;
}
}

/* When the history_timeout_spin's value changes, create a new history_timeout_timer with the updated value */
static void handle_history_spinner(GtkSpinButton *spinbutton, gpointer user_data) {
gint spinner_value = gtk_spin_button_get_value_as_int((GtkSpinButton*)history_timeout_spin);
if (gtk_toggle_button_get_active((GtkToggleButton*)history_timeout_check))
start_purge_timer(spinner_value);
}

/* When the history_timeout_check button is toggled, either start or stop the history_timeout_timer */
static void handle_history_purge_toggle(GtkWidget *togglebutton, gpointer user_data) {
if (gtk_toggle_button_get_active((GtkToggleButton*)history_timeout_check)) {
gint spinner_value = gtk_spin_button_get_value_as_int((GtkSpinButton*)history_timeout_spin);
save_preferences();
start_purge_timer(spinner_value);
} else {
stop_purge_timer();
}
}

/* Initialize the history_timeout_timer on startup */
void init_history_timeout_timer() {
if (prefs.history_timeout) {
start_purge_timer(prefs.history_timeout_seconds);
}
}

/* Called when Add... button is clicked */
Expand Down Expand Up @@ -769,6 +847,22 @@ void show_preferences(gint tab) {
gtk_spin_button_set_update_policy((GtkSpinButton*)statics_items_spin, GTK_UPDATE_IF_VALID);
gtk_box_pack_start((GtkBox*)hbox, statics_items_spin, FALSE, FALSE, 0);
gtk_box_pack_start((GtkBox*)vbox_history, frame, FALSE, FALSE, 0);
history_timeout_check = gtk_check_button_new_with_mnemonic(_("Purge history after _timeout"));
g_signal_connect((GObject*)history_timeout_check, "toggled", (GCallback)check_toggled, NULL);
g_signal_connect((GObject*)history_timeout_check, "toggled", (GCallback)handle_history_purge_toggle, NULL);
gtk_box_pack_start((GtkBox*)vbox, history_timeout_check, FALSE, FALSE, 0);
hbox = gtk_hbox_new(FALSE, 4);
gtk_box_pack_start((GtkBox*)vbox, hbox, FALSE, FALSE, 0);
label = gtk_label_new(_("Timeout seconds"));
gtk_misc_set_alignment((GtkMisc*)label, 0.0, 0.50);
gtk_box_pack_start((GtkBox*)hbox, label, FALSE, FALSE, 0);
adjustment_small = gtk_adjustment_new(0, 1, 100, 1, 10, 0);
history_timeout_spin = gtk_spin_button_new((GtkAdjustment*)adjustment_small, 0.0, 0);
g_signal_connect((GObject*)history_timeout_spin, "value-changed", (GCallback)handle_history_spinner, NULL);
gtk_spin_button_set_update_policy((GtkSpinButton*)history_timeout_spin, GTK_UPDATE_IF_VALID);
gtk_box_pack_start((GtkBox*)hbox, history_timeout_spin, FALSE, FALSE, 0);



/* Build the items frame */
frame = gtk_frame_new(NULL);
Expand Down Expand Up @@ -1024,7 +1118,9 @@ void show_preferences(gint tab) {
gtk_toggle_button_set_active((GtkToggleButton*)save_uris_check, prefs.save_uris);
gtk_toggle_button_set_active((GtkToggleButton*)use_rmb_menu_check, prefs.use_rmb_menu);
gtk_toggle_button_set_active((GtkToggleButton*)save_check, prefs.save_history);
gtk_toggle_button_set_active((GtkToggleButton*)history_timeout_check, prefs.history_timeout);
gtk_spin_button_set_value((GtkSpinButton*)history_spin, (gdouble)prefs.history_limit);
gtk_spin_button_set_value((GtkSpinButton*)history_timeout_spin, (gdouble)prefs.history_timeout_seconds);
gtk_spin_button_set_value((GtkSpinButton*)items_menu, (gdouble)prefs.items_menu);
gtk_toggle_button_set_active((GtkToggleButton*)statics_show_check, prefs.statics_show);
gtk_spin_button_set_value((GtkSpinButton*)statics_items_spin, (gdouble)prefs.statics_items);
Expand Down
64 changes: 34 additions & 30 deletions src/preferences.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,37 +25,39 @@

G_BEGIN_DECLS

#define INIT_HISTORY_KEY NULL
#define INIT_ACTIONS_KEY NULL
#define INIT_MENU_KEY NULL
#define INIT_SEARCH_KEY NULL
#define INIT_OFFLINE_KEY NULL
#define INIT_HISTORY_KEY NULL
#define INIT_ACTIONS_KEY NULL
#define INIT_MENU_KEY NULL
#define INIT_SEARCH_KEY NULL
#define INIT_OFFLINE_KEY NULL

#define DEF_USE_COPY TRUE
#define DEF_USE_PRIMARY FALSE
#define DEF_SYNCHRONIZE FALSE
#define DEF_AUTOMATIC_PASTE FALSE
#define DEF_SHOW_INDEXES FALSE
#define DEF_SAVE_URIS TRUE
#define DEF_SAVE_HISTORY TRUE
#define DEF_USE_RMB_MENU FALSE
#define DEF_HISTORY_LIMIT 50
#define DEF_ITEMS_MENU 20
#define DEF_STATICS_SHOW TRUE
#define DEF_STATICS_ITEMS 10
#define DEF_HYPERLINKS_ONLY FALSE
#define DEF_CONFIRM_CLEAR FALSE
#define DEF_SINGLE_LINE TRUE
#define DEF_REVERSE_HISTORY FALSE
#define DEF_ITEM_LENGTH 50
#define DEF_ELLIPSIZE 2
#define DEF_HISTORY_KEY "<Ctrl><Alt>H"
#define DEF_ACTIONS_KEY "<Ctrl><Alt>A"
#define DEF_MENU_KEY "<Ctrl><Alt>P"
#define DEF_SEARCH_KEY "<Ctrl><Alt>F"
#define DEF_OFFLINE_KEY "<Ctrl><Alt>O"
#define DEF_NO_ICON FALSE
#define DEF_OFFLINE_MODE FALSE
#define DEF_USE_COPY TRUE
#define DEF_USE_PRIMARY FALSE
#define DEF_SYNCHRONIZE FALSE
#define DEF_AUTOMATIC_PASTE FALSE
#define DEF_SHOW_INDEXES FALSE
#define DEF_SAVE_URIS TRUE
#define DEF_SAVE_HISTORY TRUE
#define DEF_USE_RMB_MENU FALSE
#define DEF_HISTORY_LIMIT 50
#define DEF_HISTORY_TIMEOUT FALSE
#define DEF_HISTORY_TIMEOUT_SECONDS 30
#define DEF_ITEMS_MENU 20
#define DEF_STATICS_SHOW TRUE
#define DEF_STATICS_ITEMS 10
#define DEF_HYPERLINKS_ONLY FALSE
#define DEF_CONFIRM_CLEAR FALSE
#define DEF_SINGLE_LINE TRUE
#define DEF_REVERSE_HISTORY FALSE
#define DEF_ITEM_LENGTH 50
#define DEF_ELLIPSIZE 2
#define DEF_HISTORY_KEY "<Ctrl><Alt>H"
#define DEF_ACTIONS_KEY "<Ctrl><Alt>A"
#define DEF_MENU_KEY "<Ctrl><Alt>P"
#define DEF_SEARCH_KEY "<Ctrl><Alt>F"
#define DEF_OFFLINE_KEY "<Ctrl><Alt>O"
#define DEF_NO_ICON FALSE
#define DEF_OFFLINE_MODE FALSE

#define ACTIONS_FILE "clipit/actions"
#define EXCLUDES_FILE "clipit/excludes"
Expand All @@ -75,6 +77,8 @@ void save_preferences();

void show_preferences(gint tab);

void init_purge_timer();

G_END_DECLS

#endif

0 comments on commit c419051

Please sign in to comment.