view libpurple/protocols/jabber/jutil.h @ 29010:db0762fbb60b

jabber: Document jabber_find_unnormalized_im_conv (and my guess as to why it exists instead of using purple_find_conversation_with_account).

/**
 * @file jutil.h utility functions
 *
 * 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
 */
#ifndef PURPLE_JABBER_JUTIL_H_
#define PURPLE_JABBER_JUTIL_H_

typedef struct _JabberID {
	char *node;
	char *domain;
	char *resource;
} JabberID;

#include "jabber.h"

JabberID* jabber_id_new(const char *str);
void jabber_id_free(JabberID *jid);

char *jabber_get_domain(const char *jid);
char *jabber_get_resource(const char *jid);
char *jabber_get_bare_jid(const char *jid);
char *jabber_id_get_bare_jid(const JabberID *jid);

gboolean jabber_jid_is_domain(const char *jid);

const char *jabber_normalize(const PurpleAccount *account, const char *in);

/* Returns true if JID is the bare JID of our server. */
gboolean jabber_is_own_server(JabberStream *js, const char *jid);

/* Returns true if JID is the bare JID of our account. */
gboolean jabber_is_own_account(JabberStream *js, const char *jid);

gboolean jabber_nodeprep_validate(const char *);
gboolean jabber_domain_validate(const char *);
gboolean jabber_resourceprep_validate(const char *);

/**
 * Apply the SASLprep profile of stringprep to the string passed in.
 *
 * @returns A newly allocated string containing the normalized version
 *          of the input, or NULL if an error occurred (the string could
 *          not be normalized)
 */
char *jabber_saslprep(const char *);

/**
 * Search for an IM conversation with this specific user (including resource).
 * This is an alternative to purple_find_conversation_with_account(), which
 * calls purple_normalize (so if a conversation was found, we'd need to compare
 * the conversation name to see if the resources match).
 *
 * This function saves a call to purple_normalize(), at the expense of
 * iterating over every open IM conversation.  For most usages, I think
 * this tradeoff is OK.
 */
PurpleConversation *jabber_find_unnormalized_im_conv(const char *name, PurpleAccount *account);

char *jabber_calculate_data_sha1sum(gconstpointer data, size_t len);
#endif /* PURPLE_JABBER_JUTIL_H_ */