pidgin/pidgincontactlist.c

/*
 * Pidgin - Internet Messenger
 * Copyright (C) Pidgin Developers <devel@pidgin.im>
 *
 * Pidgin is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * 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
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <https://www.gnu.org/licenses/>.
 */

#include <glib/gi18n-lib.h>

#include <purple.h>

#include "pidgin/pidgincontactinfomenu.h"
#include "pidgin/pidgincontactlist.h"

struct _PidginContactList {
	GtkBox parent;

	GtkWidget *show_offline;

	GtkFilterListModel *filter_model;
	GtkCustomFilter *account_connected_filter;
	GtkCustomFilter *offline_filter;
	GtkCustomFilter *search_filter;

	GtkWidget *search_entry;
};

G_DEFINE_FINAL_TYPE(PidginContactList, pidgin_contact_list, GTK_TYPE_BOX)

/******************************************************************************
 * Helpers
 *****************************************************************************/
static gboolean
pidgin_contact_list_account_connected_filter(GObject *item,
                                             G_GNUC_UNUSED gpointer data)
{
	PurplePerson *person = PURPLE_PERSON(item);
	PurpleContactInfo *info = NULL;

	info = purple_person_get_priority_contact_info(person);
	if(!PURPLE_IS_CONTACT_INFO(info)) {
		return FALSE;
	}

	/* This should always be a PurpleContact as it's in the contact manager,
	 * but it doesn't hurt to check.
	 */
	if(PURPLE_IS_CONTACT(info)) {
		PurpleConnection *connection = NULL;
		PurpleContact *contact = PURPLE_CONTACT(info);
		PurpleAccount *account = NULL;

		account = purple_contact_get_account(contact);
		connection = purple_account_get_connection(account);

		if(PURPLE_IS_CONNECTION(connection)) {
			PurpleConnectionState state = PURPLE_CONNECTION_STATE_DISCONNECTED;

			state = purple_connection_get_state(connection);

			return (state == PURPLE_CONNECTION_STATE_CONNECTED);
		}

	}

	return FALSE;
}

static void
pidgin_contact_list_account_connected_cb(G_GNUC_UNUSED PurpleAccountManager *manager,
                                         G_GNUC_UNUSED PurpleAccount *account,
                                         gpointer data)
{
	PidginContactList *list = data;

	gtk_filter_changed(GTK_FILTER(list->account_connected_filter),
	                   GTK_FILTER_CHANGE_LESS_STRICT);
}

static void
pidgin_contact_list_account_disconnected_cb(G_GNUC_UNUSED PurpleAccountManager *manager,
                                            G_GNUC_UNUSED PurpleAccount *account,
                                            gpointer data)
{
	PidginContactList *list = data;

	gtk_filter_changed(GTK_FILTER(list->account_connected_filter),
	                   GTK_FILTER_CHANGE_MORE_STRICT);
}

static gboolean
pidgin_contact_list_offline_filter(GObject *item, gpointer data) {
	PidginContactList *list = data;
	PurplePerson *person = PURPLE_PERSON(item);
	PurpleContactInfo *info = NULL;
	PurplePresence *presence = NULL;

	/* If we're showing offline, there's nothing to do here. */
	if(gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(list->show_offline))) {
		return TRUE;
	}

	info = purple_person_get_priority_contact_info(person);
	if(!PURPLE_IS_CONTACT_INFO(info)) {
		return FALSE;
	}

	presence = purple_contact_info_get_presence(info);
	if(PURPLE_IS_PRESENCE(presence)) {
		PurplePresencePrimitive primitive = PURPLE_PRESENCE_PRIMITIVE_OFFLINE;

		primitive = purple_presence_get_primitive(presence);
		if(primitive == PURPLE_PRESENCE_PRIMITIVE_OFFLINE) {
			return FALSE;
		}
	}

	return TRUE;
}

static gboolean
pidgin_contact_list_search_filter(GObject *item, gpointer data) {
	PidginContactList *list = data;
	PurplePerson *person = PURPLE_PERSON(item);
	const char *needle = NULL;

	needle = gtk_editable_get_text(GTK_EDITABLE(list->search_entry));

	return purple_person_matches(person, needle);
}

/******************************************************************************
 * Callbacks
 *****************************************************************************/
static void
pidgin_contact_list_show_offline_toggled_cb(G_GNUC_UNUSED GtkToggleButton *self,
                                            gpointer data)
{
	PidginContactList *list = data;

	gtk_filter_changed(GTK_FILTER(list->offline_filter),
	                   GTK_FILTER_CHANGE_DIFFERENT);
}

static void
pidgin_contact_list_search_changed_cb(GtkSearchEntry *self, gpointer data) {
	PidginContactList *list = data;

	gtk_filter_changed(GTK_FILTER(list->search_filter),
	                   GTK_FILTER_CHANGE_DIFFERENT);

	/* Make sure the search widget has focus, this allows the user to clear a
	 * search that has filtered out every item in the list via their keyboard.
	 */
	if(!gtk_widget_has_focus(GTK_WIDGET(self))) {
		gtk_widget_grab_focus(GTK_WIDGET(self));
	}
}

static GdkTexture *
pidgin_contact_list_avatar_cb(G_GNUC_UNUSED GObject *self,
                              PurplePerson *person,
                              G_GNUC_UNUSED gpointer data)
{
	PurpleAvatar *avatar = NULL;
	PurpleContactInfo *info = NULL;

	/* When filtering we get called for rows that have been filtered out. We
	 * also get called during finalization. I'm not sure why either of these
	 * cases happen, but they do.
	 */
	if(!PURPLE_IS_PERSON(person)) {
		return NULL;
	}

	info = purple_person_get_priority_contact_info(person);
	if(!PURPLE_IS_CONTACT_INFO(info)) {
		return NULL;
	}

	avatar = purple_person_get_avatar_for_display(person);
	if(PURPLE_IS_AVATAR(avatar)) {
		GdkPixbuf *pixbuf = purple_avatar_get_pixbuf(avatar);

		if(GDK_IS_PIXBUF(pixbuf)) {
			return gdk_texture_new_for_pixbuf(pixbuf);
		}
	}

	return NULL;
}

static void
pidgin_contact_list_activate_cb(GtkListView *self, guint position,
                                G_GNUC_UNUSED gpointer data)
{
	PurpleContactInfo *info = NULL;
	PurpleConversation *conversation = NULL;
	PurplePerson *person = NULL;
	GtkSelectionModel *model = NULL;

	model = gtk_list_view_get_model(self);

	person = g_list_model_get_item(G_LIST_MODEL(model), position);
	if(!PURPLE_IS_PERSON(person)) {
		g_warning("we seem to have activated a zombie.. RUN!!!!!!");

		g_clear_object(&person);
		return;
	}

	info = purple_person_get_priority_contact_info(person);
	conversation = purple_contact_find_dm(PURPLE_CONTACT(info));
	if(!PURPLE_IS_CONVERSATION(conversation)) {
		purple_contact_create_dm_async(PURPLE_CONTACT(info), NULL, NULL, NULL);
	}

	g_clear_object(&person);
}

static gboolean
pidgin_contact_list_message_visible_cb(G_GNUC_UNUSED GtkListItem *item,
                                       const char *message)
{
	/* If we have a message, return TRUE because this is bound to the label's
	 * visibility.
	 */
	return !purple_strempty(message);
}

static char *
pidgin_contact_list_get_primitive_as_string(G_GNUC_UNUSED GObject *self,
                                            PurplePresence *presence,
                                            G_GNUC_UNUSED gpointer data)
{
	PurplePresencePrimitive primitive;
	GDateTime *idle = NULL;
	GString *str = g_string_new(NULL);
	const char *tmp = NULL;

	if(!PURPLE_IS_PRESENCE(presence)) {
		return g_string_free(str, FALSE);
	}

	primitive = purple_presence_get_primitive(presence);
	tmp = purple_presence_primitive_to_string(primitive);
	if(tmp != NULL) {
		g_string_append_printf(str, " - %s", tmp);
	}

	idle = purple_presence_get_idle_time(presence);
	if(idle != NULL) {
		GDateTime *now = NULL;
		GTimeSpan duration;
		guint days;
		guint hours;
		guint minutes;

		now = g_date_time_new_now_utc();
		duration = g_date_time_difference(now, idle);
		g_date_time_unref(now);

		days = duration / G_TIME_SPAN_DAY;
		duration %= G_TIME_SPAN_DAY;
		hours = duration / G_TIME_SPAN_HOUR;
		duration %= G_TIME_SPAN_HOUR;
		minutes = duration / G_TIME_SPAN_MINUTE;

		if(days > 0) {
			g_string_append_printf(str, _(" Idle %dd %dh %02dm"), days, hours,
			                       minutes);
		} else if(hours > 0) {
			g_string_append_printf(str, _(" Idle %dh %02dm"), hours, minutes);
		} else if(minutes > 0) {
			g_string_append_printf(str, _(" Idle %02dm"), minutes);
		}
	}

	return g_string_free(str, FALSE);
}

static void
pidgin_contact_list_context_cb(GtkGestureSingle *self,
                               G_GNUC_UNUSED gint n_press,
                               gdouble x,
                               gdouble y,
                               gpointer data)
{
	PurpleAccount *account = NULL;
	PurpleContactInfo *info = NULL;
	PurplePerson *person = NULL;
	GtkWidget *parent = NULL;
	GtkListItem *item = data;

	parent = gtk_event_controller_get_widget(GTK_EVENT_CONTROLLER(self));

	/* Maybe eventually we'll make this show all contacts, but for now we'll
	 * just show the priority contact's menu.
	 */
	person = gtk_list_item_get_item(item);
	info = purple_person_get_priority_contact_info(person);

	/* We know the info is a PurpleContact because that's what the contact list
	 * is made of so this cast is fine.
	 */
	account = purple_contact_get_account(PURPLE_CONTACT(info));

	pidgin_contact_info_menu_popup(info, account, parent, x, y);
}

/******************************************************************************
 * GObject Implementation
 *****************************************************************************/
static void
pidgin_contact_list_init(PidginContactList *list) {
	PurpleAccountManager *account_manager = NULL;
	PurpleContactManager *contact_manager = NULL;

	gtk_widget_init_template(GTK_WIDGET(list));

	contact_manager = purple_contact_manager_get_default();
	gtk_filter_list_model_set_model(list->filter_model,
	                                G_LIST_MODEL(contact_manager));


	/* Setup the filter connected accounts. */
	account_manager = purple_account_manager_get_default();
	gtk_custom_filter_set_filter_func(list->account_connected_filter,
	                                  (GtkCustomFilterFunc)pidgin_contact_list_account_connected_filter,
	                                  list, NULL);
	g_signal_connect_object(account_manager, "account-connected",
	                        G_CALLBACK(pidgin_contact_list_account_connected_cb),
	                        list, 0);
	g_signal_connect_object(account_manager, "account-disconnected",
	                        G_CALLBACK(pidgin_contact_list_account_disconnected_cb),
	                        list, 0);

	/* Set the filter function for the offline filter. */
	gtk_custom_filter_set_filter_func(list->offline_filter,
	                                  (GtkCustomFilterFunc)pidgin_contact_list_offline_filter,
	                                  list, NULL);

	/* Setup the search filter and forwarding widget. */
	gtk_custom_filter_set_filter_func(list->search_filter,
	                                  (GtkCustomFilterFunc)pidgin_contact_list_search_filter,
	                                  list, NULL);

	gtk_search_entry_set_key_capture_widget(GTK_SEARCH_ENTRY(list->search_entry),
	                                        GTK_WIDGET(list));
}

static void
pidgin_contact_list_class_init(PidginContactListClass *klass) {
	GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);

	gtk_widget_class_set_template_from_resource(
	    widget_class,
	    "/im/pidgin/Pidgin3/contactlist.ui"
	);

	gtk_widget_class_bind_template_child(widget_class, PidginContactList,
	                                     filter_model);
	gtk_widget_class_bind_template_child(widget_class, PidginContactList,
	                                     account_connected_filter);
	gtk_widget_class_bind_template_child(widget_class, PidginContactList,
	                                     show_offline);
	gtk_widget_class_bind_template_child(widget_class, PidginContactList,
	                                     offline_filter);
	gtk_widget_class_bind_template_child(widget_class, PidginContactList,
	                                     search_filter);

	gtk_widget_class_bind_template_child(widget_class, PidginContactList,
	                                     search_entry);

	gtk_widget_class_bind_template_callback(widget_class,
	                                        pidgin_contact_list_show_offline_toggled_cb);
	gtk_widget_class_bind_template_callback(widget_class,
	                                        pidgin_contact_list_search_changed_cb);
	gtk_widget_class_bind_template_callback(widget_class,
	                                        pidgin_contact_list_avatar_cb);
	gtk_widget_class_bind_template_callback(widget_class,
	                                        pidgin_contact_list_activate_cb);
	gtk_widget_class_bind_template_callback(widget_class,
	                                        pidgin_contact_list_message_visible_cb);
	gtk_widget_class_bind_template_callback(widget_class,
	                                        pidgin_contact_list_get_primitive_as_string);
	gtk_widget_class_bind_template_callback(widget_class,
	                                        pidgin_contact_list_context_cb);
}

/******************************************************************************
 * API
 *****************************************************************************/
GtkWidget *
pidgin_contact_list_new(void) {
	return g_object_new(PIDGIN_TYPE_CONTACT_LIST, NULL);
}