pidgin/pidgin

Stop automatically adding/remove conversations from the conversation manager

7 weeks ago, Gary Kramlich
8019945e1c21
Stop automatically adding/remove conversations from the conversation manager

This was done to mimic the old conversations API and shouldn't be needed going
forward. However, since we can't create conversations right now, we're probably
missing some edge cases here.

Also make sure to keep a reference around on the conversation while removing to avoid use after frees.

Testing Done:
Trained with the turtles.

Reviewed at https://reviews.imfreedom.org/r/3049/
/*
* Purple - Internet Messaging Library
* Copyright (C) Pidgin Developers <devel@pidgin.im>
*
* Purple 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 library 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 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 General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along with
* this library; if not, see <https://www.gnu.org/licenses/>.
*/
#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
# error "only <purple.h> may be included directly"
#endif
#ifndef PURPLE_CONVERSATION_MANAGER_H
#define PURPLE_CONVERSATION_MANAGER_H
#include <glib.h>
#include "purpleconversation.h"
#include "purpleversion.h"
G_BEGIN_DECLS
#define PURPLE_TYPE_CONVERSATION_MANAGER (purple_conversation_manager_get_type())
/**
* PurpleConversationManager:
*
* #PurpleConversationManager keeps track of all #PurpleConversation's inside
* of libpurple and allows searching of them.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
G_DECLARE_FINAL_TYPE(PurpleConversationManager, purple_conversation_manager,
PURPLE, CONVERSATION_MANAGER, GObject)
/**
* PurpleConversationManagerForeachFunc:
* @conversation: The #PurpleConversation instance.
* @data: User supplied data.
*
* A function to be used as a callback with
* purple_conversation_manager_foreach().
*
* Since: 3.0
*/
PURPLE_AVAILABLE_TYPE_IN_3_0
typedef void (*PurpleConversationManagerForeachFunc)(PurpleConversation *conversation, gpointer data);
/**
* purple_conversation_manager_get_default:
*
* Gets the default instance of #PurpleConversationManager. This instance
* can be used for any of the API including connecting to signals.
*
* Returns: (transfer none): The default #PurpleConversationManager instance.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
PurpleConversationManager *purple_conversation_manager_get_default(void);
/**
* purple_conversation_manager_register:
* @manager: The #PurpleConversationManager instance.
* @conversation: The #PurpleConversation to register.
*
* Registers @conversation with @manager.
*
* Returns: %TRUE if @conversation was not yet registered.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
gboolean purple_conversation_manager_register(PurpleConversationManager *manager, PurpleConversation *conversation);
/**
* purple_conversation_manager_unregister:
* @manager: The #PurpleConversationManager instance.
* @conversation: The #PurpleConversation to unregister.
*
* Unregisters @conversation with @manager.
*
* Returns: %TRUE if @conversation was found and unregistered.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
gboolean purple_conversation_manager_unregister(PurpleConversationManager *manager, PurpleConversation *conversation);
/**
* purple_conversation_manager_is_registered:
* @manager: The #PurpleConversationManager instance.
* @conversation: The #PurpleConversation instance.
*
* Checks if @conversation is registered with @manager.
*
* Returns: %TRUE if @conversation is registered with @manager, %FALSE
* otherwise.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
gboolean purple_conversation_manager_is_registered(PurpleConversationManager *manager, PurpleConversation *conversation);
/**
* purple_conversation_manager_foreach:
* @manager: The #PurpleConversationManager instance.
* @func: (scope call): The #PurpleConversationManagerForeachFunc to call.
* @data: User data to pass to @func.
*
* Calls @func for each #PurpleConversation that @manager knows about.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_manager_foreach(PurpleConversationManager *manager, PurpleConversationManagerForeachFunc func, gpointer data);
/**
* purple_conversation_manager_get_all:
* @manager: The #PurpleConversationManager instance.
*
* Gets a list of all conversations that are registered with @manager.
*
* Returns: (transfer container) (element-type PurpleConversation): A list of
* all of the registered conversations.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
GList *purple_conversation_manager_get_all(PurpleConversationManager *manager);
/**
* purple_conversation_manager_find:
* @manager: The #PurpleConversationManager instance.
* @account: The #PurpleAccount instance whose conversation to find.
* @name: The name of the conversation.
*
* Looks for a registered conversation belonging to @account and named @named.
* This function will return the first one matching the given criteria. If you
* specifically need an im or chat see purple_conversation_manager_find_im()
* or purple_conversation_manager_find_chat().
*
* Returns: (transfer none): The #PurpleConversation if found, otherwise %NULL.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
PurpleConversation *purple_conversation_manager_find(PurpleConversationManager *manager, PurpleAccount *account, const gchar *name);
/**
* purple_conversation_manager_find_im:
* @manager: The #PurpleConversationManager instance.
* @account: The #PurpleAccount instance whose conversation to find.
* @name: The name of the conversation.
*
* Looks for a registered im conversation belonging to @account and named
* @name.
*
* Returns: (transfer none): The #PurpleConversation if found, otherwise %NULL.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
PurpleConversation *purple_conversation_manager_find_im(PurpleConversationManager *manager, PurpleAccount *account, const gchar *name);
/**
* purple_conversation_manager_find_chat:
* @manager: The #PurpleConversationManager instance.
* @account: The #PurpleAccount instance whose conversation to find.
* @name: The name of the conversation.
*
* Looks for a registered chat conversation belonging to @account and named
* @name.
*
* Returns: (transfer none): The #PurpleConversation if found, otherwise %NULL.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
PurpleConversation *purple_conversation_manager_find_chat(PurpleConversationManager *manager, PurpleAccount *account, const gchar *name);
/**
* purple_conversation_manager_find_chat_by_id:
* @manager: The #PurpleConversationManager instance.
* @account: The #PurpleAccount instance whose conversation to find.
* @id: The id of the conversation.
*
* Looks for a registered chat conversation belonging to @account with an id of
* @id.
*
* This is typically only called by protocols.
*
* Returns: (transfer none): The #PurpleConversation if found, otherwise %NULL.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
PurpleConversation *purple_conversation_manager_find_chat_by_id(PurpleConversationManager *manager, PurpleAccount *account, gint id);
/**
* purple_conversation_manager_find_with_id:
* @manager: The instance.
* @account: The account the conversation belongs to.
* @id: The identifier of the conversation.
*
* Looks for a registered conversation belonging to @account with an id of @id.
*
* Returns: (transfer none) (nullable): The [class@PurpleConversation] if
* found, otherwise %NULL.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
PurpleConversation *purple_conversation_manager_find_with_id(PurpleConversationManager *manager, PurpleAccount *account, const char *id);
G_END_DECLS
#endif /* PURPLE_CONVERSATION_MANAGER_H */