pidgin/pidgin

Add the presence primitive and idle time to the contact list

13 months ago, Gary Kramlich
91d0671d4778
Add the presence primitive and idle time to the contact list

The idle time is getting overwritten by something right now which is unrelated
and will be addressed separately.

Testing Done:
Connected the demo protocol plugin and looked at the contact list.

Reviewed at https://reviews.imfreedom.org/r/2391/
/*
* Purple - Internet Messaging Library
* Copyright (C) Pidgin Developers <devel@pidgin.im>
*
* 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 "purplecontactmanager.h"
#include "purplegdkpixbuf.h"
#include "purpleprivate.h"
#include "util.h"
enum {
SIG_ADDED,
SIG_REMOVED,
SIG_PERSON_ADDED,
SIG_PERSON_REMOVED,
N_SIGNALS,
};
static guint signals[N_SIGNALS] = {0, };
struct _PurpleContactManager {
GObject parent;
GHashTable *accounts;
GPtrArray *people;
};
static PurpleContactManager *default_manager = NULL;
/* Necessary prototype. */
static void purple_contact_manager_contact_person_changed_cb(GObject *obj,
GParamSpec *pspec,
gpointer data);
/******************************************************************************
* Helpers
*****************************************************************************/
static gboolean
purple_contact_manager_find_with_username_helper(gconstpointer a,
gconstpointer b)
{
PurpleContactInfo *info_a = PURPLE_CONTACT_INFO((gpointer)a);
PurpleContactInfo *info_b = PURPLE_CONTACT_INFO((gpointer)b);
const gchar *username_a = NULL;
const gchar *username_b = NULL;
username_a = purple_contact_info_get_username(info_a);
username_b = purple_contact_info_get_username(info_b);
return purple_strequal(username_a, username_b);
}
static gboolean
purple_contact_manager_find_with_id_helper(gconstpointer a, gconstpointer b) {
PurpleContactInfo *info_a = PURPLE_CONTACT_INFO((gpointer)a);
PurpleContactInfo *info_b = PURPLE_CONTACT_INFO((gpointer)b);
const gchar *id_a = NULL;
const gchar *id_b = NULL;
id_a = purple_contact_info_get_id(info_a);
id_b = purple_contact_info_get_id(info_b);
return purple_strequal(id_a, id_b);
}
static gboolean
purple_contact_manager_convert_icon_to_avatar(G_GNUC_UNUSED GBinding *binding,
const GValue *from_value,
GValue *to_value,
G_GNUC_UNUSED gpointer user_data)
{
PurpleBuddyIcon *icon = g_value_get_pointer(from_value);
GdkPixbuf *avatar = NULL;
gconstpointer data = NULL;
size_t len;
if(icon == NULL) {
g_value_set_object(to_value, NULL);
return TRUE;
}
data = purple_buddy_icon_get_data(icon, &len);
avatar = purple_gdk_pixbuf_from_data(data, len);
g_value_take_object(to_value, avatar);
return TRUE;
}
static gboolean
purple_contact_manager_convert_avatar_to_icon(G_GNUC_UNUSED GBinding *binding,
const GValue *from_value,
GValue *to_value,
G_GNUC_UNUSED gpointer user_data)
{
PurpleBuddyIcon *icon = NULL;
GdkPixbuf *avatar = g_value_get_object(from_value);
gchar *buffer = NULL;
gsize len;
gboolean result = FALSE;
if(!GDK_IS_PIXBUF(avatar)) {
g_value_set_pointer(to_value, NULL);
return TRUE;
}
result = gdk_pixbuf_save_to_buffer(avatar, &buffer, &len, "png", NULL,
"compression", "9", NULL);
if(!result) {
return FALSE;
}
purple_buddy_icon_set_data(icon, (guchar *)buffer, len, NULL);
g_free(buffer);
return TRUE;
}
/******************************************************************************
* Callbacks
*****************************************************************************/
static void
purple_contact_manager_contact_person_changed_cb(GObject *obj,
G_GNUC_UNUSED GParamSpec *pspec,
gpointer data)
{
PurpleContact *contact = PURPLE_CONTACT(obj);
PurpleContactManager *manager = data;
PurplePerson *person = NULL;
person = purple_contact_info_get_person(PURPLE_CONTACT_INFO(contact));
/* If the person is now NULL, we leaving the existing person in place as
* we don't want to potentially delete user data.
*/
if(!PURPLE_IS_PERSON(person)) {
return;
}
/* At this point the person changed or is new so we need to add the new
* person.
*/
purple_contact_manager_add_person(manager, person);
}
/******************************************************************************
* GListModel Implementation
*****************************************************************************/
static GType
purple_contact_manager_get_item_type(G_GNUC_UNUSED GListModel *list) {
return PURPLE_TYPE_PERSON;
}
static guint
purple_contact_manager_get_n_items(GListModel *list) {
PurpleContactManager *manager = PURPLE_CONTACT_MANAGER(list);
return manager->people->len;
}
static gpointer
purple_contact_manager_get_item(GListModel *list, guint position) {
PurpleContactManager *manager = PURPLE_CONTACT_MANAGER(list);
PurpleContact *contact = NULL;
if(position < manager->people->len) {
contact = g_object_ref(g_ptr_array_index(manager->people, position));
}
return contact;
}
static void
pidgin_contact_manager_list_model_iface_init(GListModelInterface *iface) {
iface->get_item_type = purple_contact_manager_get_item_type;
iface->get_n_items = purple_contact_manager_get_n_items;
iface->get_item = purple_contact_manager_get_item;
}
/******************************************************************************
* GObject Implementation
*****************************************************************************/
G_DEFINE_FINAL_TYPE_WITH_CODE(PurpleContactManager, purple_contact_manager,
G_TYPE_OBJECT,
G_IMPLEMENT_INTERFACE(G_TYPE_LIST_MODEL,
pidgin_contact_manager_list_model_iface_init))
static void
purple_contact_manager_dispose(GObject *obj) {
PurpleContactManager *manager = NULL;
manager = PURPLE_CONTACT_MANAGER(obj);
g_hash_table_remove_all(manager->accounts);
if(manager->people != NULL) {
g_ptr_array_free(manager->people, TRUE);
manager->people = NULL;
}
G_OBJECT_CLASS(purple_contact_manager_parent_class)->dispose(obj);
}
static void
purple_contact_manager_finalize(GObject *obj) {
PurpleContactManager *manager = NULL;
manager = PURPLE_CONTACT_MANAGER(obj);
g_clear_pointer(&manager->accounts, g_hash_table_destroy);
G_OBJECT_CLASS(purple_contact_manager_parent_class)->finalize(obj);
}
static void
purple_contact_manager_init(PurpleContactManager *manager) {
manager->accounts = g_hash_table_new_full(g_direct_hash, g_direct_equal,
g_object_unref, g_object_unref);
/* 100 Seems like a reasonable default of the number people on your contact
* list. - gk 20221109
*/
manager->people = g_ptr_array_new_full(100,
(GDestroyNotify)g_object_unref);
}
static void
purple_contact_manager_class_init(PurpleContactManagerClass *klass) {
GObjectClass *obj_class = G_OBJECT_CLASS(klass);
obj_class->dispose = purple_contact_manager_dispose;
obj_class->finalize = purple_contact_manager_finalize;
/**
* PurpleContactManager::added:
* @manager: The instance.
* @contact: The [class@Purple.Contact] that was registered.
*
* Emitted after @contact has been added to @manager.
*
* Since: 3.0.0
*/
signals[SIG_ADDED] = g_signal_new_class_handler(
"added",
G_OBJECT_CLASS_TYPE(klass),
G_SIGNAL_RUN_LAST,
NULL,
NULL,
NULL,
NULL,
G_TYPE_NONE,
1,
PURPLE_TYPE_CONTACT);
/**
* PurpleContactManager::removed:
* @manager: The instance.
* @contact: The [class@Purple.Contact] that was removed.
*
* Emitted after @contact has been removed from @manager.
*
* Since: 3.0.0
*/
signals[SIG_REMOVED] = g_signal_new_class_handler(
"removed",
G_OBJECT_CLASS_TYPE(klass),
G_SIGNAL_RUN_LAST,
NULL,
NULL,
NULL,
NULL,
G_TYPE_NONE,
1,
PURPLE_TYPE_CONTACT);
/**
* PurpleContactManager::person-added:
* @manager: The instance.
* @person: The [class@Purple.Person] that was added.
*
* Emitted after @person has been added to @manager. This is typically done
* when a contact is added via [method@Purple.ContactManager.add] but can
* also happen if [method@Purple.ContactManager.add_person] is called.
*
* Since: 3.0.0
*/
signals[SIG_PERSON_ADDED] = g_signal_new_class_handler(
"person-added",
G_OBJECT_CLASS_TYPE(klass),
G_SIGNAL_RUN_LAST,
NULL,
NULL,
NULL,
NULL,
G_TYPE_NONE,
1,
PURPLE_TYPE_PERSON);
/**
* PurpleContactManager::person-removed:
* @manager: The instance.
* @person: The [class@Purple.Person] that was removed.
*
* Emitted after @person has been removed from @manager. This typically
* happens when [method@Purple.ContactManager.remove_person] is called.
*
* Since: 3.0.0
*/
signals[SIG_PERSON_REMOVED] = g_signal_new_class_handler(
"person-removed",
G_OBJECT_CLASS_TYPE(klass),
G_SIGNAL_RUN_LAST,
NULL,
NULL,
NULL,
NULL,
G_TYPE_NONE,
1,
PURPLE_TYPE_PERSON);
}
/******************************************************************************
* Private API
*****************************************************************************/
void
purple_contact_manager_startup(void) {
if(default_manager == NULL) {
default_manager = g_object_new(PURPLE_TYPE_CONTACT_MANAGER, NULL);
g_object_add_weak_pointer(G_OBJECT(default_manager),
(gpointer)&default_manager);
}
}
void
purple_contact_manager_shutdown(void) {
g_clear_object(&default_manager);
}
/******************************************************************************
* Public API
*****************************************************************************/
PurpleContactManager *
purple_contact_manager_get_default(void) {
if(G_UNLIKELY(!PURPLE_IS_CONTACT_MANAGER(default_manager))) {
g_warning("The default contact manager was unexpectedly NULL");
}
return default_manager;
}
void
purple_contact_manager_add(PurpleContactManager *manager,
PurpleContact *contact)
{
PurpleAccount *account = NULL;
GListStore *contacts = NULL;
gboolean added = FALSE;
g_return_if_fail(PURPLE_IS_CONTACT_MANAGER(manager));
g_return_if_fail(PURPLE_IS_CONTACT(contact));
account = purple_contact_get_account(contact);
contacts = g_hash_table_lookup(manager->accounts, account);
if(!G_IS_LIST_STORE(contacts)) {
contacts = g_list_store_new(PURPLE_TYPE_CONTACT);
g_hash_table_insert(manager->accounts, g_object_ref(account), contacts);
g_list_store_append(contacts, contact);
added = TRUE;
} else {
if(g_list_store_find(contacts, contact, NULL)) {
PurpleContactInfo *info = PURPLE_CONTACT_INFO(contact);
const gchar *username = purple_contact_info_get_username(info);
const gchar *id = purple_contact_info_get_id(info);
g_warning("double add detected for contact %s:%s", id, username);
return;
}
g_list_store_append(contacts, contact);
added = TRUE;
}
if(added) {
PurpleContactInfo *info = PURPLE_CONTACT_INFO(contact);
PurplePerson *person = purple_contact_info_get_person(info);
/* If the contact already has a person, add the person to our list of
* people.
*/
if(PURPLE_IS_PERSON(person)) {
purple_contact_manager_add_person(manager, person);
}
/* Add a notify on the person property to track changes. */
g_signal_connect_object(contact, "notify::person",
G_CALLBACK(purple_contact_manager_contact_person_changed_cb),
manager, 0);
g_signal_emit(manager, signals[SIG_ADDED], 0, contact);
}
}
gboolean
purple_contact_manager_remove(PurpleContactManager *manager,
PurpleContact *contact)
{
PurpleAccount *account = NULL;
GListStore *contacts = NULL;
guint position = 0;
g_return_val_if_fail(PURPLE_IS_CONTACT_MANAGER(manager), FALSE);
g_return_val_if_fail(PURPLE_IS_CONTACT(contact), FALSE);
account = purple_contact_get_account(contact);
contacts = g_hash_table_lookup(manager->accounts, account);
if(!G_IS_LIST_STORE(contacts)) {
return FALSE;
}
if(g_list_store_find(contacts, contact, &position)) {
gboolean removed = FALSE;
guint len = 0;
/* Ref the contact to make sure that the instance is valid when we emit
* the removed signal.
*/
g_object_ref(contact);
len = g_list_model_get_n_items(G_LIST_MODEL(contacts));
g_list_store_remove(contacts, position);
if(g_list_model_get_n_items(G_LIST_MODEL(contacts)) < len) {
removed = TRUE;
}
if(removed) {
g_signal_emit(manager, signals[SIG_REMOVED], 0, contact);
}
g_object_unref(contact);
return removed;
}
return FALSE;
}
gboolean
purple_contact_manager_remove_all(PurpleContactManager *manager,
PurpleAccount *account)
{
GListStore *contacts = NULL;
g_return_val_if_fail(PURPLE_IS_CONTACT_MANAGER(manager), FALSE);
g_return_val_if_fail(PURPLE_IS_ACCOUNT(account), FALSE);
/* If there are any contacts for this account, manually iterate them and
* emit the removed signal. This is more efficient than calling remove on
* each one individually as that would require updating the backing
* GListStore for each individual removal.
*/
contacts = g_hash_table_lookup(manager->accounts, account);
if(G_IS_LIST_STORE(contacts)) {
guint n_items = g_list_model_get_n_items(G_LIST_MODEL(contacts));
for(guint i = 0; i < n_items; i++) {
PurpleContact *contact = NULL;
contact = g_list_model_get_item(G_LIST_MODEL(contacts), i);
g_signal_emit(manager, signals[SIG_REMOVED], 0, contact);
g_clear_object(&contact);
}
}
return g_hash_table_remove(manager->accounts, account);
}
GListModel *
purple_contact_manager_get_all(PurpleContactManager *manager,
PurpleAccount *account)
{
g_return_val_if_fail(PURPLE_IS_CONTACT_MANAGER(manager), FALSE);
g_return_val_if_fail(PURPLE_IS_ACCOUNT(account), FALSE);
return g_hash_table_lookup(manager->accounts, account);
}
PurpleContact *
purple_contact_manager_find_with_username(PurpleContactManager *manager,
PurpleAccount *account,
const gchar *username)
{
PurpleContact *needle = NULL;
GListStore *contacts = NULL;
guint position = 0;
gboolean found = FALSE;
g_return_val_if_fail(PURPLE_IS_CONTACT_MANAGER(manager), FALSE);
g_return_val_if_fail(PURPLE_IS_ACCOUNT(account), FALSE);
g_return_val_if_fail(username != NULL, FALSE);
contacts = g_hash_table_lookup(manager->accounts, account);
if(!G_IS_LIST_STORE(contacts)) {
return NULL;
}
needle = purple_contact_new(account, NULL);
purple_contact_info_set_username(PURPLE_CONTACT_INFO(needle), username);
found = g_list_store_find_with_equal_func(contacts, needle,
purple_contact_manager_find_with_username_helper,
&position);
g_clear_object(&needle);
if(found) {
return g_list_model_get_item(G_LIST_MODEL(contacts), position);
}
return NULL;
}
PurpleContact *
purple_contact_manager_find_with_id(PurpleContactManager *manager,
PurpleAccount *account, const gchar *id)
{
PurpleContact *needle = NULL;
GListStore *contacts = NULL;
guint position = 0;
gboolean found = FALSE;
g_return_val_if_fail(PURPLE_IS_CONTACT_MANAGER(manager), FALSE);
g_return_val_if_fail(PURPLE_IS_ACCOUNT(account), FALSE);
g_return_val_if_fail(id != NULL, FALSE);
contacts = g_hash_table_lookup(manager->accounts, account);
if(!G_IS_LIST_STORE(contacts)) {
return NULL;
}
needle = purple_contact_new(account, id);
found = g_list_store_find_with_equal_func(contacts, needle,
purple_contact_manager_find_with_id_helper,
&position);
g_clear_object(&needle);
if(found) {
return g_list_model_get_item(G_LIST_MODEL(contacts), position);
}
return NULL;
}
/******************************************************************************
* Migration API
*****************************************************************************/
void
purple_contact_manager_add_buddy(PurpleContactManager *manager,
PurpleBuddy *buddy)
{
PurpleAccount *account = NULL;
PurpleContact *contact = NULL;
PurpleContactInfo *info = NULL;
PurplePerson *person = NULL;
PurplePresence *buddy_presence = NULL;
PurplePresence *contact_presence = NULL;
const gchar *id = NULL;
g_return_if_fail(PURPLE_IS_CONTACT_MANAGER(manager));
g_return_if_fail(PURPLE_IS_BUDDY(buddy));
/* Create the new contact. */
account = purple_buddy_get_account(buddy);
id = purple_buddy_get_id(buddy);
contact = purple_contact_new(account, id);
info = PURPLE_CONTACT_INFO(contact);
person = purple_person_new();
purple_contact_info_set_person(info, person);
purple_person_add_contact_info(person, info);
/* Bind all of the properties. */
g_object_bind_property(buddy, "name", contact, "username",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy, "local-alias", contact, "alias",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy, "server-alias", contact, "display-name",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
buddy_presence = purple_buddy_get_presence(buddy);
contact_presence = purple_contact_info_get_presence(info);
g_object_bind_property(buddy_presence, "idle", contact_presence, "idle",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy_presence, "idle-time", contact_presence,
"idle-time",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy_presence, "login-time", contact_presence,
"login-time",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy_presence, "active-status", contact_presence,
"active-status",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy_presence, "message", contact_presence,
"message",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy_presence, "emoji", contact_presence,
"emoji",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy_presence, "mobile", contact_presence,
"mobile",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy_presence, "primitive", contact_presence,
"primitive",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property_full(buddy, "icon", contact, "avatar",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL,
purple_contact_manager_convert_icon_to_avatar,
purple_contact_manager_convert_avatar_to_icon,
NULL, NULL);
/* Finally add it to the manager. */
purple_contact_manager_add(manager, contact);
/* purple_contact_manager_add adds its own reference, so free our copy. */
g_clear_object(&contact);
}
void
purple_contact_manager_add_person(PurpleContactManager *manager,
PurplePerson *person)
{
guint index = 0;
g_return_if_fail(PURPLE_IS_CONTACT_MANAGER(manager));
g_return_if_fail(PURPLE_IS_PERSON(person));
/* If the person is already known, bail. */
if(g_ptr_array_find(manager->people, person, &index)) {
return;
}
/* Add the person and emit our signals. */
g_ptr_array_add(manager->people, g_object_ref(person));
g_list_model_items_changed(G_LIST_MODEL(manager), index, 0, 1);
g_signal_emit(manager, signals[SIG_PERSON_ADDED], 0, person);
}
void
purple_contact_manager_remove_person(PurpleContactManager *manager,
PurplePerson *person,
gboolean remove_contacts)
{
guint index = 0;
g_return_if_fail(PURPLE_IS_CONTACT_MANAGER(manager));
g_return_if_fail(PURPLE_IS_PERSON(person));
if(!g_ptr_array_find(manager->people, person, &index)) {
return;
}
if(remove_contacts) {
guint n = g_list_model_get_n_items(G_LIST_MODEL(person));
for(guint i = 0; i < n; i++) {
PurpleContact *contact = NULL;
contact = g_list_model_get_item(G_LIST_MODEL(person), i);
if(PURPLE_IS_CONTACT(contact)) {
purple_contact_manager_remove(manager, contact);
g_object_unref(contact);
}
}
}
/* Add a ref to the person, so we can emit the removed signal after it
* was actually removed, as our GPtrArray may be holding the last
* reference.
*/
g_object_ref(person);
g_ptr_array_remove_index(manager->people, index);
g_list_model_items_changed(G_LIST_MODEL(manager), index, 1, 0);
/* Emit the removed signal and clear our temporary reference. */
g_signal_emit(manager, signals[SIG_PERSON_REMOVED], 0, person);
g_object_unref(person);
}