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 - 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 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/>.
*/
#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
# error "only <purple.h> may be included directly"
#endif
#ifndef PURPLE_REQUEST_GROUP_H
#define PURPLE_REQUEST_GROUP_H
#include <stdlib.h>
#include <glib.h>
#include <glib-object.h>
/**
* PurpleRequestGroup:
*
* A group of fields with a title.
*/
typedef struct _PurpleRequestGroup PurpleRequestGroup;
#include "purplerequestfield.h"
#define PURPLE_TYPE_REQUEST_GROUP (purple_request_group_get_type())
G_DECLARE_FINAL_TYPE(PurpleRequestGroup, purple_request_group,
PURPLE, REQUEST_GROUP, GObject)
G_BEGIN_DECLS
/**
* purple_request_group_new:
* @title: (nullable): The title to give the group.
*
* Creates a fields group with an optional title.
*
* Returns: (transfer full): A new fields group
*/
PurpleRequestGroup *purple_request_group_new(const char *title);
/**
* purple_request_group_add_field:
* @group: The group to add the field to.
* @field: (transfer full): The field to add to the group.
*
* Adds a field to the group.
*/
void purple_request_group_add_field(PurpleRequestGroup *group, PurpleRequestField *field);
/**
* purple_request_group_get_title:
* @group: The group.
*
* Returns the title of a fields group.
*
* Returns: (nullable): The title, if set.
*/
const char *purple_request_group_get_title(PurpleRequestGroup *group);
/**
* purple_request_group_get_fields:
* @group: The group.
*
* Returns a list of all fields in a group.
*
* Returns: (element-type PurpleRequestField) (transfer none): The list of fields in the group.
*/
GList *purple_request_group_get_fields(PurpleRequestGroup *group);
/**
* purple_request_group_get_page:
* @group: The group.
*
* Returns a list of all fields in a group.
*
* Returns: (transfer none): The list of fields in the group.
*/
PurpleRequestPage *purple_request_group_get_page(PurpleRequestGroup *group);
G_END_DECLS
#endif /* PURPLE_REQUEST_GROUP_H */