source: protocols/nogaim.h @ 9f03c47

Last change on this file since 9f03c47 was 9f03c47, checked in by dequis <dx@…>, at 2016-11-14T00:37:14Z

Improve support for protocols which don't require a password

This adds a prpl_options_t enum with flags, which mostly just brings
OPT_PROTO_{NO_PASSWORD,PASSWORD_OPTIONAL} from libpurple as
PRPL_OPT_{NO_PASSWORD,PASSWORD_OPTIONAL}

  • Property mode set to 100644
File size: 15.7 KB
RevLine 
[5ebff60]1/********************************************************************\
[b7d3cc34]2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
[0e788f5]4  * Copyright 2002-2012 Wilmer van der Gaast and others                *
[b7d3cc34]5  \********************************************************************/
6
7/*
[6bbb939]8 * nogaim, soon to be known as im_api. Not a separate product (unless
9 * someone would be interested in such a thing), just a new name.
[b7d3cc34]10 *
11 * Gaim without gaim - for BitlBee
12 *
13 * This file contains functions called by the Gaim IM-modules. It contains
14 * some struct and type definitions from Gaim.
15 *
16 * Copyright (C) 1998-1999, Mark Spencer <markster@marko.net>
17 *                          (and possibly other members of the Gaim team)
[0e788f5]18 * Copyright 2002-2012 Wilmer van der Gaast <wilmer@gaast.net>
[b7d3cc34]19 */
20
21/*
22  This program is free software; you can redistribute it and/or modify
23  it under the terms of the GNU General Public License as published by
24  the Free Software Foundation; either version 2 of the License, or
25  (at your option) any later version.
26
27  This program is distributed in the hope that it will be useful,
28  but WITHOUT ANY WARRANTY; without even the implied warranty of
29  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
30  GNU General Public License for more details.
31
32  You should have received a copy of the GNU General Public License with
33  the Debian GNU/Linux distribution in /usr/share/common-licenses/GPL;
[6f10697]34  if not, write to the Free Software Foundation, Inc., 51 Franklin St.,
35  Fifth Floor, Boston, MA  02110-1301  USA
[b7d3cc34]36*/
37
38#ifndef _NOGAIM_H
39#define _NOGAIM_H
40
[5ebff60]41#if (__sun)
[daae10f]42#include <inttypes.h>
43#else
[4cf80bb]44#include <stdint.h>
[daae10f]45#endif
46
[b7d3cc34]47#include "bitlbee.h"
[0a3c243]48#include "account.h"
[b7d3cc34]49#include "proxy.h"
[9143aeb]50#include "query.h"
[b7d3cc34]51#include "md5.h"
[2c2df7d]52#include "ft.h"
[b7d3cc34]53
54#define BUDDY_ALIAS_MAXLEN 388   /* because MSN names can be 387 characters */
55
[1c8a7a2]56#define WEBSITE "http://www.bitlbee.org/"
[b7d3cc34]57
[9624fdf]58/* Sharing flags between all kinds of things. I just hope I won't hit any
59   limits before 32-bit machines become extinct. ;-) */
[6bbb939]60#define OPT_LOGGED_IN   0x00000001
61#define OPT_LOGGING_OUT 0x00000002
62#define OPT_AWAY        0x00000004
[0ebf919]63#define OPT_MOBILE      0x00000008
[6bbb939]64#define OPT_DOES_HTML   0x00000010
[6286f80]65#define OPT_LOCALBUDDY  0x00000020 /* For nicks local to one groupchat */
[748bcdd]66#define OPT_SLOW_LOGIN  0x00000040 /* I.e. Twitter Oauth @ login time */
[df1fb67]67#define OPT_TYPING      0x00000100 /* Some pieces of code make assumptions */
68#define OPT_THINKING    0x00000200 /* about these values... Stupid me! */
[be999a5]69#define OPT_NOOTR       0x00001000 /* protocol not suitable for OTR */
[e132b60]70#define OPT_PONGS       0x00010000 /* Service sends us keep-alives */
71#define OPT_PONGED      0x00020000 /* Received a keep-alive during last interval */
[345577b]72#define OPT_SELFMESSAGE 0x00080000 /* A message sent by self from another location */
[fb62f81f]73
[b7d3cc34]74/* ok. now the fun begins. first we create a connection structure */
[5ebff60]75struct im_connection {
[0a3c243]76        account_t *acc;
[52744f8]77        uint32_t flags;
[5ebff60]78
[192b80a]79        /* each connection then can have its own protocol-specific data */
80        void *proto_data;
[5ebff60]81
[b7d3cc34]82        /* all connections need an input watcher */
83        int inpa;
[192b80a]84        guint keepalive;
[5ebff60]85
[b7d3cc34]86        /* buddy list stuff. there is still a global groups for the buddy list, but
87         * we need to maintain our own set of buddies, and our own permit/deny lists */
88        GSList *permit;
89        GSList *deny;
90        int permdeny;
[5ebff60]91
[b7d3cc34]92        char *away;
[5ebff60]93
[b7d3cc34]94        /* BitlBee */
[81e04e1]95        bee_t *bee;
[5ebff60]96
[aea8b68]97        GSList *groupchats;
[a33ee0f]98        GSList *chatlist;
[b7d3cc34]99};
100
[0da65d5]101struct groupchat {
102        struct im_connection *ic;
[b7d3cc34]103
104        /* stuff used just for chat */
[acd61b9]105        /* The in_room variable is a list of handles (not nicks!), kind of
106         * "nick list". This is how you can check who is in the group chat
107         * already, for example to avoid adding somebody two times. */
[fa29d093]108        GList *in_room;
[aea8b68]109        //GList *ignored;
[5ebff60]110
[aea8b68]111        //struct groupchat *next;
[acd61b9]112        /* The title variable contains the ID you gave when you created the
113         * chat using imcb_chat_new(). */
[fa29d093]114        char *title;
[50e1776]115        /* Use imcb_chat_topic() to change this variable otherwise the user
116         * won't notice the topic change. */
117        char *topic;
[fa29d093]118        char joined;
[acd61b9]119        /* This is for you, you can add your own structure here to extend this
120         * structure for your protocol's needs. */
[fa29d093]121        void *data;
[aea8b68]122        void *ui_data;
[b7d3cc34]123};
124
125struct buddy {
126        char name[80];
127        char show[BUDDY_ALIAS_MAXLEN];
[fa29d093]128        int present;
[b7d3cc34]129        time_t signon;
130        time_t idle;
[fa29d093]131        int uc;
[b7d3cc34]132        guint caps; /* woohoo! */
133        void *proto_data; /* what a hack */
[0da65d5]134        struct im_connection *ic; /* the connection it belongs to */
[b7d3cc34]135};
136
[d88c92a]137struct buddy_action {
138        char *name;
139        char *description;
140};
141
[9f03c47]142/* This enum takes a few things from libpurple and a few things from old OPT_ flags.
143 * The only flag that was used before this struct was PRPL_OPT_NOOTR.
144 *
145 * The libpurple ones only use the same values as the PurpleProtocolOptions
146 * enum for convenience, but there's no promise of direct compatibility with
147 * those values. As of libpurple 2.8.0 they use up to 0x800 (1 << 11), which is
148 * a nice coincidence.
149 */
150typedef enum {
151        /* The protocol doesn't use passwords
152         * Mirrors libpurple's OPT_PROTO_NO_PASSWORD */
153        PRPL_OPT_NO_PASSWORD = 1 << 4,
154
155        /* The protocol doesn't require passwords, but may use them
156         * Mirrors libpurple's OPT_PROTO_PASSWORD_OPTIONAL */
157        PRPL_OPT_PASSWORD_OPTIONAL = 1 << 7,
158
159        /* The protocol is not suitable for OTR, see OPT_NOOTR */
160        PRPL_OPT_NOOTR = 1 << 12,
161} prpl_options_t;
162
[b7d3cc34]163struct prpl {
164        int options;
[acd61b9]165        /* You should set this to the name of your protocol.
166         * - The user sees this name ie. when imcb_log() is used. */
[7b23afd]167        const char *name;
[cd741d8]168        void *data;
[1dd3470]169        /* Maximum Message Size of this protocol.
170         * - Introduced for OTR, in order to fragment large protocol messages.
171         * - 0 means "unlimited". */
172        unsigned int mms;
[b7d3cc34]173
[0da65d5]174        /* Added this one to be able to add per-account settings, don't think
[acd61b9]175         * it should be used for anything else. You are supposed to use the
176         * set_add() function to add new settings. */
[5ebff60]177        void (* init)           (account_t *);
[acd61b9]178        /* The typical usage of the login() function:
179         * - Create an im_connection using imcb_new() from the account_t parameter.
180         * - Initialize your myproto_data struct - you should store all your protocol-specific data there.
181         * - Save your custom structure to im_connection->proto_data.
182         * - Use proxy_connect() to connect to the server.
183         */
[5ebff60]184        void (* login)          (account_t *);
[acd61b9]185        /* Implementing this function is optional. */
[5ebff60]186        void (* keepalive)      (struct im_connection *);
[acd61b9]187        /* In this function you should:
188         * - Tell the server about you are logging out.
189         * - g_free() your myproto_data struct as BitlBee does not know how to
190         *   properly do so.
191         */
[5ebff60]192        void (* logout)         (struct im_connection *);
193
[acd61b9]194        /* This function is called when the user wants to send a message to a handle.
195         * - 'to' is a handle, not a nick
196         * - 'flags' may be ignored
197         */
[5ebff60]198        int (* buddy_msg)      (struct im_connection *, char *to, char *message, int flags);
[acd61b9]199        /* This function is called then the user uses the /away IRC command.
200         * - 'state' contains the away reason.
201         * - 'message' may be ignored if your protocol does not support it.
202         */
[5ebff60]203        void (* set_away)       (struct im_connection *, char *state, char *message);
[acd61b9]204        /* Implementing this function is optional. */
[5ebff60]205        int (* send_typing)    (struct im_connection *, char *who, int flags);
206
[acd61b9]207        /* 'name' is a handle to add/remove. For now BitlBee doesn't really
208         * handle groups, just set it to NULL, so you can ignore that
209         * parameter. */
[5ebff60]210        void (* add_buddy)      (struct im_connection *, char *name, char *group);
211        void (* remove_buddy)   (struct im_connection *, char *name, char *group);
212
[acd61b9]213        /* Block list stuff. Implementing these are optional. */
[5ebff60]214        void (* add_permit)     (struct im_connection *, char *who);
215        void (* add_deny)       (struct im_connection *, char *who);
216        void (* rem_permit)     (struct im_connection *, char *who);
217        void (* rem_deny)       (struct im_connection *, char *who);
218
[0da65d5]219        /* Request profile info. Free-formatted stuff, the IM module gives back
[acd61b9]220           this info via imcb_log(). Implementing these are optional. */
[5ebff60]221        void (* get_info)       (struct im_connection *, char *who);
222
[192b80a]223        /* Group chat stuff. */
[acd61b9]224        /* This is called when the user uses the /invite IRC command.
225         * - 'who' may be ignored
226         * - 'message' is a handle to invite
227         */
[5ebff60]228        void (* chat_invite)    (struct groupchat *, char *who, char *message);
[7821ee8]229        /* This is called when the user uses the /kick IRC command.
230         * - 'who' is a handle to kick
231         * - 'message' is a kick message or NULL
232         */
[5ebff60]233        void (* chat_kick)      (struct groupchat *, char *who, const char *message);
[acd61b9]234        /* This is called when the user uses the /part IRC command in a group
235         * chat. You just should tell the user about it, nothing more. */
[5ebff60]236        void (* chat_leave)     (struct groupchat *);
[acd61b9]237        /* This is called when the user sends a message to the groupchat.
238         * 'flags' may be ignored. */
[5ebff60]239        void (* chat_msg)       (struct groupchat *, char *message, int flags);
[acd61b9]240        /* This is called when the user uses the /join #nick IRC command.
241         * - 'who' is the handle of the nick
242         */
[0da65d5]243        struct groupchat *
[5ebff60]244        (* chat_with)      (struct im_connection *, char *who);
[acd61b9]245        /* This is used when the user uses the /join #channel IRC command.  If
246         * your protocol does not support publicly named group chats, then do
247         * not implement this. */
[0da65d5]248        struct groupchat *
[5ebff60]249        (* chat_join)      (struct im_connection *, const char *room,
250                            const char *nick, const char *password, set_t **sets);
[50e1776]251        /* Change the topic, if supported. Note that BitlBee expects the IM
252           server to confirm the topic change with a regular topic change
253           event. If it doesn't do that, you have to fake it to make it
254           visible to the user. */
[5ebff60]255        void (* chat_topic)     (struct groupchat *, char *topic);
256
[03f3828]257        /* If your protocol module needs any special info for joining chatrooms
258           other than a roomname + nickname, add them here. */
[5ebff60]259        void (* chat_add_settings)      (account_t *acc, set_t **head);
260        void (* chat_free_settings)     (account_t *acc, set_t **head);
261
[acd61b9]262        /* You can tell what away states your protocol supports, so that
[2bc8ac0]263         * BitlBee will try to map the IRC away reasons to them. If your
264         * protocol doesn't have any, just return one generic "Away". */
[0da65d5]265        GList *(* away_states)(struct im_connection *ic);
[5ebff60]266
[acd61b9]267        /* Mainly for AOL, since they think "Bung hole" == "Bu ngho le". *sigh*
268         * - Most protocols will just want to set this to g_strcasecmp().*/
[5b52a48]269        int (* handle_cmp) (const char *who1, const char *who2);
[2ff2076]270
[fa295e36]271        /* Implement these callbacks if you want to use imcb_ask_auth() */
[5ebff60]272        void (* auth_allow)     (struct im_connection *, const char *who);
273        void (* auth_deny)      (struct im_connection *, const char *who);
[2288705]274
[2ff2076]275        /* Incoming transfer request */
[5ebff60]276        void (* transfer_request) (struct im_connection *, file_transfer_t *ft, char *handle);
277
[203a2d2]278        void (* buddy_data_add) (struct bee_user *bu);
279        void (* buddy_data_free) (struct bee_user *bu);
[5ebff60]280
[d88c92a]281        GList *(* buddy_action_list) (struct bee_user *bu);
282        void *(* buddy_action) (struct bee_user *bu, const char *action, char * const args[], void *data);
[5ebff60]283
[be1efa3]284        /* If null, equivalent to handle_cmp( ic->acc->user, who ) */
285        gboolean (* handle_is_self) (struct im_connection *, const char *who);
286
[a33ee0f]287        /* This sets/updates the im_connection->chatlist field with a
288         * bee_chat_info_t GSList. This function should ensure the
289         * bee_chat_list_finish() function gets called at some point
290         * after the chat list is completely updated.
291         */
292        void (* chat_list) (struct im_connection *, const char *server);
293
[03f3828]294        /* Some placeholders so eventually older plugins may cooperate with newer BitlBees. */
295        void *resv1;
296        void *resv2;
297        void *resv3;
298        void *resv4;
299        void *resv5;
[b7d3cc34]300};
301
[d28fe1c4]302struct plugin_info
303{
304        guint abiver;
305        const char *name;
306        const char *version;
307        const char *description;
308        const char *author;
309        const char *url;
310};
311
312#ifdef WITH_PLUGINS
313G_MODULE_EXPORT GList *get_plugins();
314#endif
315
[84b045d]316/* im_api core stuff. */
317void nogaim_init();
[808825e]318G_MODULE_EXPORT GList *get_protocols();
319G_MODULE_EXPORT GList *get_protocols_disabled();
[b7d3cc34]320G_MODULE_EXPORT GSList *get_connections();
[5ebff60]321G_MODULE_EXPORT struct prpl *find_protocol(const char *name);
[ad9ac5d]322G_MODULE_EXPORT gboolean is_protocol_disabled(const char *name);
[acd61b9]323/* When registering a new protocol, you should allocate space for a new prpl
324 * struct, initialize it (set the function pointers to point to your
325 * functions), finally call this function. */
[5ebff60]326G_MODULE_EXPORT void register_protocol(struct prpl *);
[b7d3cc34]327
[84b045d]328/* Connection management. */
[acd61b9]329/* You will need this function in prpl->login() to get an im_connection from
330 * the account_t parameter. */
[5ebff60]331G_MODULE_EXPORT struct im_connection *imcb_new(account_t *acc);
332G_MODULE_EXPORT void imc_free(struct im_connection *ic);
[acd61b9]333/* Once you're connected, you should call this function, so that the user will
334 * see the success. */
[5ebff60]335G_MODULE_EXPORT void imcb_connected(struct im_connection *ic);
[acd61b9]336/* This can be used to disconnect when something went wrong (ie. read error
337 * from the server). You probably want to set the second parameter to TRUE. */
[5ebff60]338G_MODULE_EXPORT void imc_logout(struct im_connection *ic, int allow_reconnect);
[b7d3cc34]339
[84b045d]340/* Communicating with the user. */
[acd61b9]341/* A printf()-like function to tell the user anything you want. */
[5ebff60]342G_MODULE_EXPORT void imcb_log(struct im_connection *ic, char *format, ...) G_GNUC_PRINTF(2, 3);
[acd61b9]343/* To tell the user an error, ie. before logging out when an error occurs. */
[5ebff60]344G_MODULE_EXPORT void imcb_error(struct im_connection *ic, char *format, ...) G_GNUC_PRINTF(2, 3);
[fa295e36]345
[acd61b9]346/* To ask a your about something.
347 * - 'msg' is the question.
348 * - 'data' can be your custom struct - it will be passed to the callbacks.
349 * - 'doit' or 'dont' will be called depending of the answer of the user.
350 */
[5ebff60]351G_MODULE_EXPORT void imcb_ask(struct im_connection *ic, char *msg, void *data, query_callback doit,
352                              query_callback dont);
353G_MODULE_EXPORT void imcb_ask_with_free(struct im_connection *ic, char *msg, void *data, query_callback doit,
354                                        query_callback dont, query_callback myfree);
[fa295e36]355
356/* Two common questions you may want to ask:
357 * - X added you to his contact list, allow?
358 * - X is not in your contact list, want to add?
359 */
[5ebff60]360G_MODULE_EXPORT void imcb_ask_auth(struct im_connection *ic, const char *handle, const char *realname);
361G_MODULE_EXPORT void imcb_ask_add(struct im_connection *ic, const char *handle, const char *realname);
[b7d3cc34]362
[84b045d]363/* Buddy management */
[acd61b9]364/* This function should be called for each handle which are visible to the
[527360f]365 * user, usually after a login, or if the user added a buddy and the IM
366 * server confirms that the add was successful. Don't forget to do this! */
[5ebff60]367G_MODULE_EXPORT void imcb_add_buddy(struct im_connection *ic, const char *handle, const char *group);
368G_MODULE_EXPORT void imcb_remove_buddy(struct im_connection *ic, const char *handle, char *group);
369G_MODULE_EXPORT void imcb_rename_buddy(struct im_connection *ic, const char *handle, const char *realname);
370G_MODULE_EXPORT void imcb_buddy_nick_hint(struct im_connection *ic, const char *handle, const char *nick);
[a42fda4]371G_MODULE_EXPORT void imcb_buddy_nick_change(struct im_connection *ic, const char *handle, const char *nick);
[5ebff60]372G_MODULE_EXPORT void imcb_buddy_action_response(bee_user_t *bu, const char *action, char * const args[], void *data);
[84b045d]373
[345577b]374G_MODULE_EXPORT void imcb_buddy_typing(struct im_connection *ic, const char *handle, guint32 flags);
[5ebff60]375G_MODULE_EXPORT struct bee_user *imcb_buddy_by_handle(struct im_connection *ic, const char *handle);
[d6e2aa8]376
377G_GNUC_DEPRECATED G_MODULE_EXPORT void imcb_clean_handle(struct im_connection *ic, char *handle);
[84b045d]378
379/* Actions, or whatever. */
[5ebff60]380int imc_away_send_update(struct im_connection *ic);
381int imc_chat_msg(struct groupchat *c, char *msg, int flags);
[84b045d]382
[5ebff60]383void imc_add_allow(struct im_connection *ic, char *handle);
384void imc_rem_allow(struct im_connection *ic, char *handle);
385void imc_add_block(struct im_connection *ic, char *handle);
386void imc_rem_block(struct im_connection *ic, char *handle);
[84b045d]387
388/* Misc. stuff */
[5ebff60]389char *set_eval_timezone(set_t *set, char *value);
390gboolean auto_reconnect(gpointer data, gint fd, b_input_condition cond);
391void cancel_auto_reconnect(struct account *a);
[84b045d]392
[b7d3cc34]393#endif
Note: See TracBrowser for help on using the repository browser.