gtk2/gtk/gtkemojicompletion.c
Matthias Clasen 4e04c39609 emojicompletion: Avoid a memory overrun
Don't read beyond the beginning of the string.

Fixes: 
2020-10-15 16:32:55 -04:00

664 lines
18 KiB
C

/* gtkemojicompletion.c: An Emoji picker widget
* Copyright 2017, Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include "config.h"
#include "gtkemojicompletion.h"
#include "gtktextprivate.h"
#include "gtkeditable.h"
#include "gtkbox.h"
#include "gtkcssprovider.h"
#include "gtklistbox.h"
#include "gtklabel.h"
#include "gtkpopover.h"
#include "gtkintl.h"
#include "gtkprivate.h"
#include "gtkgesturelongpress.h"
#include "gtkeventcontrollerkey.h"
#include "gtkflowbox.h"
#include "gtkstack.h"
#include "gtkstylecontext.h"
struct _GtkEmojiCompletion
{
GtkPopover parent_instance;
GtkText *entry;
char *text;
guint length;
guint offset;
gulong changed_id;
guint n_matches;
GtkWidget *list;
GtkWidget *active;
GtkWidget *active_variation;
GVariant *data;
};
struct _GtkEmojiCompletionClass {
GtkPopoverClass parent_class;
};
static void connect_signals (GtkEmojiCompletion *completion,
GtkText *text);
static void disconnect_signals (GtkEmojiCompletion *completion);
static int populate_completion (GtkEmojiCompletion *completion,
const char *text,
guint offset);
#define MAX_ROWS 5
G_DEFINE_TYPE (GtkEmojiCompletion, gtk_emoji_completion, GTK_TYPE_POPOVER)
static void
gtk_emoji_completion_finalize (GObject *object)
{
GtkEmojiCompletion *completion = GTK_EMOJI_COMPLETION (object);
disconnect_signals (completion);
g_free (completion->text);
g_variant_unref (completion->data);
G_OBJECT_CLASS (gtk_emoji_completion_parent_class)->finalize (object);
}
static void
update_completion (GtkEmojiCompletion *completion)
{
const char *text;
guint length;
guint n_matches;
n_matches = 0;
text = gtk_editable_get_text (GTK_EDITABLE (completion->entry));
length = strlen (text);
if (length > 0)
{
gboolean found_candidate = FALSE;
const char *p;
p = text + length;
do
{
next:
p = g_utf8_prev_char (p);
if (*p == ':')
{
if (p + 1 == text + length)
goto next;
if (p == text || !g_unichar_isalnum (g_utf8_get_char (p - 1)))
{
found_candidate = TRUE;
}
break;
}
}
while (p > text &&
(g_unichar_isalnum (g_utf8_get_char (p)) || *p == '_' || *p == ' '));
if (found_candidate)
n_matches = populate_completion (completion, p, 0);
}
if (n_matches > 0)
gtk_popover_popup (GTK_POPOVER (completion));
else
gtk_popover_popdown (GTK_POPOVER (completion));
}
static void
changed_cb (GtkText *text,
GtkEmojiCompletion *completion)
{
update_completion (completion);
}
static void
emoji_activated (GtkWidget *row,
GtkEmojiCompletion *completion)
{
const char *emoji;
guint length;
gtk_popover_popdown (GTK_POPOVER (completion));
emoji = (const char *)g_object_get_data (G_OBJECT (row), "text");
g_signal_handler_block (completion->entry, completion->changed_id);
length = g_utf8_strlen (gtk_editable_get_text (GTK_EDITABLE (completion->entry)), -1);
gtk_editable_select_region (GTK_EDITABLE (completion->entry), length - completion->length, length);
gtk_text_enter_text (completion->entry, emoji);
g_signal_handler_unblock (completion->entry, completion->changed_id);
}
static void
row_activated (GtkListBox *list,
GtkListBoxRow *row,
gpointer data)
{
GtkEmojiCompletion *completion = data;
emoji_activated (GTK_WIDGET (row), completion);
}
static void
child_activated (GtkFlowBox *box,
GtkFlowBoxChild *child,
gpointer data)
{
GtkEmojiCompletion *completion = data;
emoji_activated (GTK_WIDGET (child), completion);
}
static void
move_active_row (GtkEmojiCompletion *completion,
int direction)
{
GtkWidget *child;
for (child = gtk_widget_get_first_child (completion->list);
child != NULL;
child = gtk_widget_get_next_sibling (child))
gtk_widget_unset_state_flags (child, GTK_STATE_FLAG_FOCUSED);
if (completion->active != NULL)
{
if (direction == 1)
completion->active = gtk_widget_get_next_sibling (completion->active);
else
completion->active = gtk_widget_get_prev_sibling (completion->active);
}
if (completion->active == NULL)
{
if (direction == 1)
completion->active = gtk_widget_get_first_child (completion->list);
else
completion->active = gtk_widget_get_last_child (completion->list);
}
if (completion->active != NULL)
gtk_widget_set_state_flags (completion->active, GTK_STATE_FLAG_FOCUSED, FALSE);
if (completion->active_variation)
{
gtk_widget_unset_state_flags (completion->active_variation, GTK_STATE_FLAG_FOCUSED);
completion->active_variation = NULL;
}
}
static void
activate_active_row (GtkEmojiCompletion *completion)
{
if (GTK_IS_FLOW_BOX_CHILD (completion->active_variation))
emoji_activated (completion->active_variation, completion);
else if (completion->active != NULL)
emoji_activated (completion->active, completion);
}
static void
show_variations (GtkEmojiCompletion *completion,
GtkWidget *row,
gboolean visible)
{
GtkWidget *stack;
GtkWidget *box;
GtkWidget *child;
gboolean is_visible;
if (!row)
return;
stack = GTK_WIDGET (g_object_get_data (G_OBJECT (row), "stack"));
box = gtk_stack_get_child_by_name (GTK_STACK (stack), "variations");
if (!box)
return;
is_visible = gtk_stack_get_visible_child (GTK_STACK (stack)) == box;
if (is_visible == visible)
return;
gtk_stack_set_visible_child_name (GTK_STACK (stack), visible ? "variations" : "text");
for (child = gtk_widget_get_first_child (box); child; child = gtk_widget_get_next_sibling (child))
gtk_widget_unset_state_flags (child, GTK_STATE_FLAG_FOCUSED);
completion->active_variation = NULL;
}
static gboolean
move_active_variation (GtkEmojiCompletion *completion,
int direction)
{
GtkWidget *base;
GtkWidget *stack;
GtkWidget *box;
GtkWidget *next;
if (!completion->active)
return FALSE;
base = GTK_WIDGET (g_object_get_data (G_OBJECT (completion->active), "base"));
stack = GTK_WIDGET (g_object_get_data (G_OBJECT (completion->active), "stack"));
box = gtk_stack_get_child_by_name (GTK_STACK (stack), "variations");
if (gtk_stack_get_visible_child (GTK_STACK (stack)) != box)
return FALSE;
next = NULL;
if (!completion->active_variation)
next = base;
else if (completion->active_variation == base && direction == 1)
next = gtk_widget_get_first_child (box);
else if (completion->active_variation == gtk_widget_get_first_child (box) && direction == -1)
next = base;
else if (direction == 1)
next = gtk_widget_get_next_sibling (completion->active_variation);
else if (direction == -1)
next = gtk_widget_get_prev_sibling (completion->active_variation);
if (next)
{
if (completion->active_variation)
gtk_widget_unset_state_flags (completion->active_variation, GTK_STATE_FLAG_FOCUSED);
completion->active_variation = next;
gtk_widget_set_state_flags (completion->active_variation, GTK_STATE_FLAG_FOCUSED, FALSE);
}
return next != NULL;
}
static gboolean
key_press_cb (GtkEventControllerKey *key,
guint keyval,
guint keycode,
GdkModifierType modifiers,
GtkEmojiCompletion *completion)
{
if (!gtk_widget_get_visible (GTK_WIDGET (completion)))
return FALSE;
if (keyval == GDK_KEY_Escape)
{
gtk_popover_popdown (GTK_POPOVER (completion));
return TRUE;
}
if (keyval == GDK_KEY_Tab)
{
show_variations (completion, completion->active, FALSE);
guint offset = completion->offset + MAX_ROWS;
if (offset >= completion->n_matches)
offset = 0;
populate_completion (completion, completion->text, offset);
return TRUE;
}
if (keyval == GDK_KEY_Up)
{
show_variations (completion, completion->active, FALSE);
move_active_row (completion, -1);
return TRUE;
}
if (keyval == GDK_KEY_Down)
{
show_variations (completion, completion->active, FALSE);
move_active_row (completion, 1);
return TRUE;
}
if (keyval == GDK_KEY_Return ||
keyval == GDK_KEY_KP_Enter ||
keyval == GDK_KEY_ISO_Enter)
{
activate_active_row (completion);
return TRUE;
}
if (keyval == GDK_KEY_Right)
{
show_variations (completion, completion->active, TRUE);
move_active_variation (completion, 1);
return TRUE;
}
if (keyval == GDK_KEY_Left)
{
if (!move_active_variation (completion, -1))
show_variations (completion, completion->active, FALSE);
return TRUE;
}
return FALSE;
}
static gboolean
focus_out_cb (GtkWidget *text,
GParamSpec *pspec,
GtkEmojiCompletion *completion)
{
if (!gtk_widget_has_focus (text))
gtk_popover_popdown (GTK_POPOVER (completion));
return FALSE;
}
static void
connect_signals (GtkEmojiCompletion *completion,
GtkText *entry)
{
GtkEventController *key_controller;
completion->entry = g_object_ref (entry);
key_controller = gtk_text_get_key_controller (entry);
g_signal_connect (key_controller, "key-pressed", G_CALLBACK (key_press_cb), completion);
completion->changed_id = g_signal_connect (entry, "changed", G_CALLBACK (changed_cb), completion);
g_signal_connect (entry, "notify::has-focus", G_CALLBACK (focus_out_cb), completion);
}
static void
disconnect_signals (GtkEmojiCompletion *completion)
{
GtkEventController *key_controller;
key_controller = gtk_text_get_key_controller (completion->entry);
g_signal_handlers_disconnect_by_func (completion->entry, changed_cb, completion);
g_signal_handlers_disconnect_by_func (key_controller, key_press_cb, completion);
g_signal_handlers_disconnect_by_func (completion->entry, focus_out_cb, completion);
g_clear_object (&completion->entry);
}
static gboolean
has_variations (GVariant *emoji_data)
{
GVariant *codes;
gsize i;
gboolean has_variations;
has_variations = FALSE;
codes = g_variant_get_child_value (emoji_data, 0);
for (i = 0; i < g_variant_n_children (codes); i++)
{
gunichar code;
g_variant_get_child (codes, i, "u", &code);
if (code == 0)
{
has_variations = TRUE;
break;
}
}
g_variant_unref (codes);
return has_variations;
}
static void
get_text (GVariant *emoji_data,
gunichar modifier,
char *text,
gsize length)
{
GVariant *codes;
gsize i;
char *p;
p = text;
codes = g_variant_get_child_value (emoji_data, 0);
for (i = 0; i < g_variant_n_children (codes); i++)
{
gunichar code;
g_variant_get_child (codes, i, "u", &code);
if (code == 0)
code = modifier;
if (code != 0)
p += g_unichar_to_utf8 (code, p);
}
g_variant_unref (codes);
p += g_unichar_to_utf8 (0xFE0F, p); /* U+FE0F is the Emoji variation selector */
p[0] = 0;
}
static void
add_emoji_variation (GtkWidget *box,
GVariant *emoji_data,
gunichar modifier)
{
GtkWidget *child;
GtkWidget *label;
PangoAttrList *attrs;
char text[64];
get_text (emoji_data, modifier, text, 64);
label = gtk_label_new (text);
attrs = pango_attr_list_new ();
pango_attr_list_insert (attrs, pango_attr_scale_new (PANGO_SCALE_X_LARGE));
gtk_label_set_attributes (GTK_LABEL (label), attrs);
pango_attr_list_unref (attrs);
child = g_object_new (GTK_TYPE_FLOW_BOX_CHILD, "css-name", "emoji", NULL);
g_object_set_data_full (G_OBJECT (child), "text", g_strdup (text), g_free);
g_object_set_data_full (G_OBJECT (child), "emoji-data",
g_variant_ref (emoji_data),
(GDestroyNotify)g_variant_unref);
if (modifier != 0)
g_object_set_data (G_OBJECT (child), "modifier", GUINT_TO_POINTER (modifier));
gtk_flow_box_child_set_child (GTK_FLOW_BOX_CHILD (child), label);
gtk_flow_box_insert (GTK_FLOW_BOX (box), child, -1);
}
static void
add_emoji (GtkWidget *list,
GVariant *emoji_data,
GtkEmojiCompletion *completion)
{
GtkWidget *child;
GtkWidget *label;
GtkWidget *box;
PangoAttrList *attrs;
char text[64];
const char *name;
GtkWidget *stack;
gunichar modifier;
get_text (emoji_data, 0, text, 64);
label = gtk_label_new (text);
attrs = pango_attr_list_new ();
pango_attr_list_insert (attrs, pango_attr_scale_new (PANGO_SCALE_X_LARGE));
gtk_label_set_attributes (GTK_LABEL (label), attrs);
pango_attr_list_unref (attrs);
gtk_widget_add_css_class (label, "emoji");
child = g_object_new (GTK_TYPE_LIST_BOX_ROW, "css-name", "emoji-completion-row", NULL);
gtk_widget_set_focus_on_click (child, FALSE);
box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
gtk_list_box_row_set_child (GTK_LIST_BOX_ROW (child), box);
gtk_box_append (GTK_BOX (box), label);
g_object_set_data (G_OBJECT (child), "base", label);
stack = gtk_stack_new ();
gtk_stack_set_hhomogeneous (GTK_STACK (stack), TRUE);
gtk_stack_set_vhomogeneous (GTK_STACK (stack), TRUE);
gtk_stack_set_transition_type (GTK_STACK (stack), GTK_STACK_TRANSITION_TYPE_OVER_RIGHT_LEFT);
gtk_box_append (GTK_BOX (box), stack);
g_object_set_data (G_OBJECT (child), "stack", stack);
g_variant_get_child (emoji_data, 1, "&s", &name);
label = gtk_label_new (name);
gtk_label_set_xalign (GTK_LABEL (label), 0);
gtk_stack_add_named (GTK_STACK (stack), label, "text");
if (has_variations (emoji_data))
{
box = gtk_flow_box_new ();
gtk_flow_box_set_homogeneous (GTK_FLOW_BOX (box), TRUE);
gtk_flow_box_set_min_children_per_line (GTK_FLOW_BOX (box), 5);
gtk_flow_box_set_max_children_per_line (GTK_FLOW_BOX (box), 5);
gtk_flow_box_set_activate_on_single_click (GTK_FLOW_BOX (box), TRUE);
gtk_flow_box_set_selection_mode (GTK_FLOW_BOX (box), GTK_SELECTION_NONE);
g_signal_connect (box, "child-activated", G_CALLBACK (child_activated), completion);
for (modifier = 0x1f3fb; modifier <= 0x1f3ff; modifier++)
add_emoji_variation (box, emoji_data, modifier);
gtk_stack_add_named (GTK_STACK (stack), box, "variations");
}
g_object_set_data_full (G_OBJECT (child), "text", g_strdup (text), g_free);
g_object_set_data_full (G_OBJECT (child), "emoji-data",
g_variant_ref (emoji_data), (GDestroyNotify)g_variant_unref);
gtk_list_box_insert (GTK_LIST_BOX (list), child, -1);
}
static int
populate_completion (GtkEmojiCompletion *completion,
const char *text,
guint offset)
{
guint n_matches;
guint n_added;
GVariantIter iter;
GVariant *item;
GtkWidget *child;
if (completion->text != text)
{
g_free (completion->text);
completion->text = g_strdup (text);
completion->length = g_utf8_strlen (text, -1);
}
completion->offset = offset;
while ((child = gtk_widget_get_first_child (completion->list)))
gtk_list_box_remove (GTK_LIST_BOX (completion->list), child);
completion->active = NULL;
n_matches = 0;
n_added = 0;
g_variant_iter_init (&iter, completion->data);
while ((item = g_variant_iter_next_value (&iter)))
{
const char *name;
g_variant_get_child (item, 1, "&s", &name);
if (g_str_has_prefix (name, text + 1))
{
n_matches++;
if (n_matches > offset && n_added < MAX_ROWS)
{
add_emoji (completion->list, item, completion);
n_added++;
}
}
}
completion->n_matches = n_matches;
if (n_added > 0)
{
completion->active = gtk_widget_get_first_child (completion->list);
gtk_widget_set_state_flags (completion->active, GTK_STATE_FLAG_FOCUSED, FALSE);
}
return n_added;
}
static void
long_pressed_cb (GtkGesture *gesture,
double x,
double y,
gpointer data)
{
GtkEmojiCompletion *completion = data;
GtkWidget *row;
row = GTK_WIDGET (gtk_list_box_get_row_at_y (GTK_LIST_BOX (completion->list), y));
if (!row)
return;
show_variations (completion, row, TRUE);
}
static void
gtk_emoji_completion_init (GtkEmojiCompletion *completion)
{
GBytes *bytes = NULL;
GtkGesture *long_press;
gtk_widget_init_template (GTK_WIDGET (completion));
bytes = get_emoji_data ();
completion->data = g_variant_ref_sink (g_variant_new_from_bytes (G_VARIANT_TYPE ("a(ausasu)"), bytes, TRUE));
g_bytes_unref (bytes);
long_press = gtk_gesture_long_press_new ();
g_signal_connect (long_press, "pressed", G_CALLBACK (long_pressed_cb), completion);
gtk_widget_add_controller (completion->list, GTK_EVENT_CONTROLLER (long_press));
}
static void
gtk_emoji_completion_class_init (GtkEmojiCompletionClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
object_class->finalize = gtk_emoji_completion_finalize;
gtk_widget_class_set_template_from_resource (widget_class, "/org/gtk/libgtk/ui/gtkemojicompletion.ui");
gtk_widget_class_bind_template_child (widget_class, GtkEmojiCompletion, list);
gtk_widget_class_bind_template_callback (widget_class, row_activated);
}
GtkWidget *
gtk_emoji_completion_new (GtkText *text)
{
GtkEmojiCompletion *completion;
completion = GTK_EMOJI_COMPLETION (g_object_new (GTK_TYPE_EMOJI_COMPLETION, NULL));
gtk_widget_set_parent (GTK_WIDGET (completion), GTK_WIDGET (text));
connect_signals (completion, text);
return GTK_WIDGET (completion);
}