pidgin/pidgin

IRCv3: Set the SASL login name to the current nick if not set during connection

15 months ago, Gary Kramlich
e9a794bfe183
IRCv3: Set the SASL login name to the current nick if not set during connection

This _should_ help users make sure they authenticate as the correct user. They
are still able to manually specify a SASL Login Name, but if it isn't set when
a connection is attempted, it will be set to the nick defined on the account.

This should also fix the scenario where a user is adding the account to Pidgin
but already has the same account connected because the login name will be the
nick they entered not the one that's chosen if there's a nick collision.

Testing Done:
Connected an IRCv3 account with the `SASL Login Name` unset and verified it was set after connecting. Then set the `SASL Login Name` to something else, attempted connection, verified a SASL failure and verified that the `SASL Login Name` changed persisted.

Reviewed at https://reviews.imfreedom.org/r/2329/
/*
* purple
*
* 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 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*
*/
#include "chat.h"
#include "purpleprotocolchat.h"
#include "util.h"
typedef struct _PurpleChatPrivate PurpleChatPrivate;
/* Private data for a chat node */
struct _PurpleChatPrivate {
char *alias; /* The display name of this chat. */
PurpleAccount *account; /* The account this chat is attached to */
GHashTable *components; /* the stuff the protocol needs to know to
join the chat */
gboolean is_constructed; /* Indicates if the chat has finished being
constructed. */
};
/* Chat property enums */
enum
{
PROP_0,
PROP_ALIAS,
PROP_ACCOUNT,
PROP_COMPONENTS,
PROP_LAST
};
/******************************************************************************
* Globals
*****************************************************************************/
static GParamSpec *properties[PROP_LAST];
G_DEFINE_TYPE_WITH_PRIVATE(PurpleChat, purple_chat, PURPLE_TYPE_BLIST_NODE);
/******************************************************************************
* API
*****************************************************************************/
const char *purple_chat_get_name(PurpleChat *chat)
{
PurpleChatPrivate *priv = NULL;
g_return_val_if_fail(PURPLE_IS_CHAT(chat), NULL);
priv = purple_chat_get_instance_private(chat);
if ((priv->alias != NULL) && (*priv->alias != '\0'))
return priv->alias;
return purple_chat_get_name_only(chat);
}
const char *purple_chat_get_name_only(PurpleChat *chat)
{
PurpleChatPrivate *priv = NULL;
char *ret = NULL;
PurpleProtocol *protocol = NULL;
g_return_val_if_fail(PURPLE_IS_CHAT(chat), NULL);
priv = purple_chat_get_instance_private(chat);
protocol = purple_account_get_protocol(priv->account);
if (PURPLE_PROTOCOL_IMPLEMENTS(protocol, CHAT, info)) {
PurpleProtocolChatEntry *pce;
GList *parts = purple_protocol_chat_info(PURPLE_PROTOCOL_CHAT(protocol),
purple_account_get_connection(priv->account));
pce = parts->data;
ret = g_hash_table_lookup(priv->components, pce->identifier);
g_list_free_full(parts, g_free);
}
return ret;
}
void
purple_chat_set_alias(PurpleChat *chat, const char *alias)
{
PurpleChatPrivate *priv = NULL;
char *old_alias;
char *new_alias = NULL;
g_return_if_fail(PURPLE_IS_CHAT(chat));
priv = purple_chat_get_instance_private(chat);
if ((alias != NULL) && (*alias != '\0'))
new_alias = purple_utf8_strip_unprintables(alias);
if (!purple_strequal(priv->alias, new_alias)) {
g_free(new_alias);
return;
}
old_alias = priv->alias;
if ((new_alias != NULL) && (*new_alias != '\0'))
priv->alias = new_alias;
else {
priv->alias = NULL;
g_free(new_alias); /* could be "\0" */
}
g_object_notify_by_pspec(G_OBJECT(chat), properties[PROP_ALIAS]);
purple_blist_save_node(purple_blist_get_default(),
PURPLE_BLIST_NODE(chat));
purple_blist_update_node(purple_blist_get_default(),
PURPLE_BLIST_NODE(chat));
purple_signal_emit(purple_blist_get_handle(), "blist-node-aliased",
chat, old_alias);
g_free(old_alias);
}
PurpleGroup *
purple_chat_get_group(PurpleChat *chat)
{
g_return_val_if_fail(PURPLE_IS_CHAT(chat), NULL);
return PURPLE_GROUP(PURPLE_BLIST_NODE(chat)->parent);
}
PurpleAccount *
purple_chat_get_account(PurpleChat *chat)
{
PurpleChatPrivate *priv = NULL;
g_return_val_if_fail(PURPLE_IS_CHAT(chat), NULL);
priv = purple_chat_get_instance_private(chat);
return priv->account;
}
GHashTable *
purple_chat_get_components(PurpleChat *chat)
{
PurpleChatPrivate *priv = NULL;
g_return_val_if_fail(PURPLE_IS_CHAT(chat), NULL);
priv = purple_chat_get_instance_private(chat);
return priv->components;
}
/******************************************************************************
* GObject Stuff
*****************************************************************************/
static void
purple_chat_set_property(GObject *obj, guint param_id, const GValue *value,
GParamSpec *pspec)
{
PurpleChat *chat = PURPLE_CHAT(obj);
PurpleChatPrivate *priv = purple_chat_get_instance_private(chat);
switch (param_id) {
case PROP_ALIAS:
if (priv->is_constructed)
purple_chat_set_alias(chat, g_value_get_string(value));
else
priv->alias =
purple_utf8_strip_unprintables(g_value_get_string(value));
break;
case PROP_ACCOUNT:
priv->account = g_value_get_object(value);
break;
case PROP_COMPONENTS:
priv->components = g_value_get_pointer(value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, param_id, pspec);
break;
}
}
static void
purple_chat_get_property(GObject *obj, guint param_id, GValue *value,
GParamSpec *pspec)
{
PurpleChat *chat = PURPLE_CHAT(obj);
PurpleChatPrivate *priv = purple_chat_get_instance_private(chat);
switch (param_id) {
case PROP_ALIAS:
g_value_set_string(value, priv->alias);
break;
case PROP_ACCOUNT:
g_value_set_object(value, purple_chat_get_account(chat));
break;
case PROP_COMPONENTS:
g_value_set_pointer(value, purple_chat_get_components(chat));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, param_id, pspec);
break;
}
}
/* GObject initialization function */
static void
purple_chat_init(G_GNUC_UNUSED PurpleChat *chat)
{
}
/* Called when done constructing */
static void
purple_chat_constructed(GObject *object)
{
PurpleChat *chat = PURPLE_CHAT(object);
PurpleChatPrivate *priv = purple_chat_get_instance_private(chat);
G_OBJECT_CLASS(purple_chat_parent_class)->constructed(object);
purple_blist_new_node(purple_blist_get_default(),
PURPLE_BLIST_NODE(chat));
priv->is_constructed = TRUE;
}
/* GObject finalize function */
static void
purple_chat_finalize(GObject *object)
{
PurpleChatPrivate *priv =
purple_chat_get_instance_private(PURPLE_CHAT(object));
g_free(priv->alias);
g_hash_table_destroy(priv->components);
G_OBJECT_CLASS(purple_chat_parent_class)->finalize(object);
}
/* Class initializer function */
static void purple_chat_class_init(PurpleChatClass *klass)
{
GObjectClass *obj_class = G_OBJECT_CLASS(klass);
obj_class->finalize = purple_chat_finalize;
/* Setup properties */
obj_class->get_property = purple_chat_get_property;
obj_class->set_property = purple_chat_set_property;
obj_class->constructed = purple_chat_constructed;
properties[PROP_ALIAS] = g_param_spec_string(
"alias",
"Alias",
"The alias for the chat.",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS
);
properties[PROP_ACCOUNT] = g_param_spec_object(
"account",
"Account",
"The account that the chat belongs to.",
PURPLE_TYPE_ACCOUNT,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS
);
properties[PROP_COMPONENTS] = g_param_spec_pointer(
"components",
"Components",
"The protocol components of the chat.",
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS
);
g_object_class_install_properties(obj_class, PROP_LAST, properties);
}
PurpleChat *
purple_chat_new(PurpleAccount *account, const char *alias, GHashTable *components)
{
g_return_val_if_fail(PURPLE_IS_ACCOUNT(account), NULL);
g_return_val_if_fail(components != NULL, NULL);
return g_object_new(PURPLE_TYPE_CHAT,
"account", account,
"alias", alias,
"components", components,
NULL);
}