source: protocols/nogaim.h @ 66b7741

Last change on this file since 66b7741 was b4f496e, checked in by dequis <dx@…>, at 2016-11-19T07:32:48Z

Improve handling of unknown protocols / missing plugins

Instead of failing to load the config, a fake prpl is created to load
the account, keep its settings, and refuse to log in with a helpful
error message.

Also added a new explain_unknown_protocol() function which returns text
which attempts to explain why a protocol is missing, handling several
typical cases, including the future removal of several dead libpurple
plugins.

That message is shown when logging in to a loaded account with a missing
protocol and when adding a new one with 'account add', with the
difference that the latter doesn't leave a placeholder fake account.
  • Property mode set to 100644
File size: 15.9 KB
Line 
1/********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
4  * Copyright 2002-2012 Wilmer van der Gaast and others                *
5  \********************************************************************/
6
7/*
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.
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)
18 * Copyright 2002-2012 Wilmer van der Gaast <wilmer@gaast.net>
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;
34  if not, write to the Free Software Foundation, Inc., 51 Franklin St.,
35  Fifth Floor, Boston, MA  02110-1301  USA
36*/
37
38#ifndef _NOGAIM_H
39#define _NOGAIM_H
40
41#if (__sun)
42#include <inttypes.h>
43#else
44#include <stdint.h>
45#endif
46
47#include "bitlbee.h"
48#include "account.h"
49#include "proxy.h"
50#include "query.h"
51#include "md5.h"
52#include "ft.h"
53
54#define BUDDY_ALIAS_MAXLEN 388   /* because MSN names can be 387 characters */
55
56#define WEBSITE "http://www.bitlbee.org/"
57
58/* Sharing flags between all kinds of things. I just hope I won't hit any
59   limits before 32-bit machines become extinct. ;-) */
60#define OPT_LOGGED_IN   0x00000001
61#define OPT_LOGGING_OUT 0x00000002
62#define OPT_AWAY        0x00000004
63#define OPT_MOBILE      0x00000008
64#define OPT_DOES_HTML   0x00000010
65#define OPT_LOCALBUDDY  0x00000020 /* For nicks local to one groupchat */
66#define OPT_SLOW_LOGIN  0x00000040 /* I.e. Twitter Oauth @ login time */
67#define OPT_TYPING      0x00000100 /* Some pieces of code make assumptions */
68#define OPT_THINKING    0x00000200 /* about these values... Stupid me! */
69#define OPT_NOOTR       0x00001000 /* protocol not suitable for OTR */
70#define OPT_PONGS       0x00010000 /* Service sends us keep-alives */
71#define OPT_PONGED      0x00020000 /* Received a keep-alive during last interval */
72#define OPT_SELFMESSAGE 0x00080000 /* A message sent by self from another location */
73
74/* ok. now the fun begins. first we create a connection structure */
75struct im_connection {
76        account_t *acc;
77        uint32_t flags;
78
79        /* each connection then can have its own protocol-specific data */
80        void *proto_data;
81
82        /* all connections need an input watcher */
83        int inpa;
84        guint keepalive;
85
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;
91
92        char *away;
93
94        /* BitlBee */
95        bee_t *bee;
96
97        GSList *groupchats;
98        GSList *chatlist;
99};
100
101struct groupchat {
102        struct im_connection *ic;
103
104        /* stuff used just for chat */
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. */
108        GList *in_room;
109        //GList *ignored;
110
111        //struct groupchat *next;
112        /* The title variable contains the ID you gave when you created the
113         * chat using imcb_chat_new(). */
114        char *title;
115        /* Use imcb_chat_topic() to change this variable otherwise the user
116         * won't notice the topic change. */
117        char *topic;
118        char joined;
119        /* This is for you, you can add your own structure here to extend this
120         * structure for your protocol's needs. */
121        void *data;
122        void *ui_data;
123};
124
125struct buddy {
126        char name[80];
127        char show[BUDDY_ALIAS_MAXLEN];
128        int present;
129        time_t signon;
130        time_t idle;
131        int uc;
132        guint caps; /* woohoo! */
133        void *proto_data; /* what a hack */
134        struct im_connection *ic; /* the connection it belongs to */
135};
136
137struct buddy_action {
138        char *name;
139        char *description;
140};
141
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
162        /* This prpl is a placeholder for a missing protocol */
163        PRPL_OPT_UNKNOWN_PROTOCOL = 1 << 13,
164} prpl_options_t;
165
166struct prpl {
167        int options;
168        /* You should set this to the name of your protocol.
169         * - The user sees this name ie. when imcb_log() is used. */
170        const char *name;
171        void *data;
172        /* Maximum Message Size of this protocol.
173         * - Introduced for OTR, in order to fragment large protocol messages.
174         * - 0 means "unlimited". */
175        unsigned int mms;
176
177        /* Added this one to be able to add per-account settings, don't think
178         * it should be used for anything else. You are supposed to use the
179         * set_add() function to add new settings. */
180        void (* init)           (account_t *);
181        /* The typical usage of the login() function:
182         * - Create an im_connection using imcb_new() from the account_t parameter.
183         * - Initialize your myproto_data struct - you should store all your protocol-specific data there.
184         * - Save your custom structure to im_connection->proto_data.
185         * - Use proxy_connect() to connect to the server.
186         */
187        void (* login)          (account_t *);
188        /* Implementing this function is optional. */
189        void (* keepalive)      (struct im_connection *);
190        /* In this function you should:
191         * - Tell the server about you are logging out.
192         * - g_free() your myproto_data struct as BitlBee does not know how to
193         *   properly do so.
194         */
195        void (* logout)         (struct im_connection *);
196
197        /* This function is called when the user wants to send a message to a handle.
198         * - 'to' is a handle, not a nick
199         * - 'flags' may be ignored
200         */
201        int (* buddy_msg)      (struct im_connection *, char *to, char *message, int flags);
202        /* This function is called then the user uses the /away IRC command.
203         * - 'state' contains the away reason.
204         * - 'message' may be ignored if your protocol does not support it.
205         */
206        void (* set_away)       (struct im_connection *, char *state, char *message);
207        /* Implementing this function is optional. */
208        int (* send_typing)    (struct im_connection *, char *who, int flags);
209
210        /* 'name' is a handle to add/remove. For now BitlBee doesn't really
211         * handle groups, just set it to NULL, so you can ignore that
212         * parameter. */
213        void (* add_buddy)      (struct im_connection *, char *name, char *group);
214        void (* remove_buddy)   (struct im_connection *, char *name, char *group);
215
216        /* Block list stuff. Implementing these are optional. */
217        void (* add_permit)     (struct im_connection *, char *who);
218        void (* add_deny)       (struct im_connection *, char *who);
219        void (* rem_permit)     (struct im_connection *, char *who);
220        void (* rem_deny)       (struct im_connection *, char *who);
221
222        /* Request profile info. Free-formatted stuff, the IM module gives back
223           this info via imcb_log(). Implementing these are optional. */
224        void (* get_info)       (struct im_connection *, char *who);
225
226        /* Group chat stuff. */
227        /* This is called when the user uses the /invite IRC command.
228         * - 'who' may be ignored
229         * - 'message' is a handle to invite
230         */
231        void (* chat_invite)    (struct groupchat *, char *who, char *message);
232        /* This is called when the user uses the /kick IRC command.
233         * - 'who' is a handle to kick
234         * - 'message' is a kick message or NULL
235         */
236        void (* chat_kick)      (struct groupchat *, char *who, const char *message);
237        /* This is called when the user uses the /part IRC command in a group
238         * chat. You just should tell the user about it, nothing more. */
239        void (* chat_leave)     (struct groupchat *);
240        /* This is called when the user sends a message to the groupchat.
241         * 'flags' may be ignored. */
242        void (* chat_msg)       (struct groupchat *, char *message, int flags);
243        /* This is called when the user uses the /join #nick IRC command.
244         * - 'who' is the handle of the nick
245         */
246        struct groupchat *
247        (* chat_with)      (struct im_connection *, char *who);
248        /* This is used when the user uses the /join #channel IRC command.  If
249         * your protocol does not support publicly named group chats, then do
250         * not implement this. */
251        struct groupchat *
252        (* chat_join)      (struct im_connection *, const char *room,
253                            const char *nick, const char *password, set_t **sets);
254        /* Change the topic, if supported. Note that BitlBee expects the IM
255           server to confirm the topic change with a regular topic change
256           event. If it doesn't do that, you have to fake it to make it
257           visible to the user. */
258        void (* chat_topic)     (struct groupchat *, char *topic);
259
260        /* If your protocol module needs any special info for joining chatrooms
261           other than a roomname + nickname, add them here. */
262        void (* chat_add_settings)      (account_t *acc, set_t **head);
263        void (* chat_free_settings)     (account_t *acc, set_t **head);
264
265        /* You can tell what away states your protocol supports, so that
266         * BitlBee will try to map the IRC away reasons to them. If your
267         * protocol doesn't have any, just return one generic "Away". */
268        GList *(* away_states)(struct im_connection *ic);
269
270        /* Mainly for AOL, since they think "Bung hole" == "Bu ngho le". *sigh*
271         * - Most protocols will just want to set this to g_strcasecmp().*/
272        int (* handle_cmp) (const char *who1, const char *who2);
273
274        /* Implement these callbacks if you want to use imcb_ask_auth() */
275        void (* auth_allow)     (struct im_connection *, const char *who);
276        void (* auth_deny)      (struct im_connection *, const char *who);
277
278        /* Incoming transfer request */
279        void (* transfer_request) (struct im_connection *, file_transfer_t *ft, char *handle);
280
281        void (* buddy_data_add) (struct bee_user *bu);
282        void (* buddy_data_free) (struct bee_user *bu);
283
284        GList *(* buddy_action_list) (struct bee_user *bu);
285        void *(* buddy_action) (struct bee_user *bu, const char *action, char * const args[], void *data);
286
287        /* If null, equivalent to handle_cmp( ic->acc->user, who ) */
288        gboolean (* handle_is_self) (struct im_connection *, const char *who);
289
290        /* This sets/updates the im_connection->chatlist field with a
291         * bee_chat_info_t GSList. This function should ensure the
292         * bee_chat_list_finish() function gets called at some point
293         * after the chat list is completely updated.
294         */
295        void (* chat_list) (struct im_connection *, const char *server);
296
297        /* Some placeholders so eventually older plugins may cooperate with newer BitlBees. */
298        void *resv1;
299        void *resv2;
300        void *resv3;
301        void *resv4;
302        void *resv5;
303};
304
305struct plugin_info
306{
307        guint abiver;
308        const char *name;
309        const char *version;
310        const char *description;
311        const char *author;
312        const char *url;
313};
314
315#ifdef WITH_PLUGINS
316G_MODULE_EXPORT GList *get_plugins();
317#endif
318
319/* im_api core stuff. */
320void nogaim_init();
321G_MODULE_EXPORT GList *get_protocols();
322G_MODULE_EXPORT GList *get_protocols_disabled();
323G_MODULE_EXPORT GSList *get_connections();
324G_MODULE_EXPORT struct prpl *find_protocol(const char *name);
325G_MODULE_EXPORT gboolean is_protocol_disabled(const char *name);
326G_MODULE_EXPORT struct prpl *make_unknown_protocol(const char *name);
327G_MODULE_EXPORT char *explain_unknown_protocol(const char *name);
328/* When registering a new protocol, you should allocate space for a new prpl
329 * struct, initialize it (set the function pointers to point to your
330 * functions), finally call this function. */
331G_MODULE_EXPORT void register_protocol(struct prpl *);
332
333/* Connection management. */
334/* You will need this function in prpl->login() to get an im_connection from
335 * the account_t parameter. */
336G_MODULE_EXPORT struct im_connection *imcb_new(account_t *acc);
337G_MODULE_EXPORT void imc_free(struct im_connection *ic);
338/* Once you're connected, you should call this function, so that the user will
339 * see the success. */
340G_MODULE_EXPORT void imcb_connected(struct im_connection *ic);
341/* This can be used to disconnect when something went wrong (ie. read error
342 * from the server). You probably want to set the second parameter to TRUE. */
343G_MODULE_EXPORT void imc_logout(struct im_connection *ic, int allow_reconnect);
344
345/* Communicating with the user. */
346/* A printf()-like function to tell the user anything you want. */
347G_MODULE_EXPORT void imcb_log(struct im_connection *ic, char *format, ...) G_GNUC_PRINTF(2, 3);
348/* To tell the user an error, ie. before logging out when an error occurs. */
349G_MODULE_EXPORT void imcb_error(struct im_connection *ic, char *format, ...) G_GNUC_PRINTF(2, 3);
350
351/* To ask a your about something.
352 * - 'msg' is the question.
353 * - 'data' can be your custom struct - it will be passed to the callbacks.
354 * - 'doit' or 'dont' will be called depending of the answer of the user.
355 */
356G_MODULE_EXPORT void imcb_ask(struct im_connection *ic, char *msg, void *data, query_callback doit,
357                              query_callback dont);
358G_MODULE_EXPORT void imcb_ask_with_free(struct im_connection *ic, char *msg, void *data, query_callback doit,
359                                        query_callback dont, query_callback myfree);
360
361/* Two common questions you may want to ask:
362 * - X added you to his contact list, allow?
363 * - X is not in your contact list, want to add?
364 */
365G_MODULE_EXPORT void imcb_ask_auth(struct im_connection *ic, const char *handle, const char *realname);
366G_MODULE_EXPORT void imcb_ask_add(struct im_connection *ic, const char *handle, const char *realname);
367
368/* Buddy management */
369/* This function should be called for each handle which are visible to the
370 * user, usually after a login, or if the user added a buddy and the IM
371 * server confirms that the add was successful. Don't forget to do this! */
372G_MODULE_EXPORT void imcb_add_buddy(struct im_connection *ic, const char *handle, const char *group);
373G_MODULE_EXPORT void imcb_remove_buddy(struct im_connection *ic, const char *handle, char *group);
374G_MODULE_EXPORT void imcb_rename_buddy(struct im_connection *ic, const char *handle, const char *realname);
375G_MODULE_EXPORT void imcb_buddy_nick_hint(struct im_connection *ic, const char *handle, const char *nick);
376G_MODULE_EXPORT void imcb_buddy_nick_change(struct im_connection *ic, const char *handle, const char *nick);
377G_MODULE_EXPORT void imcb_buddy_action_response(bee_user_t *bu, const char *action, char * const args[], void *data);
378
379G_MODULE_EXPORT void imcb_buddy_typing(struct im_connection *ic, const char *handle, guint32 flags);
380G_MODULE_EXPORT struct bee_user *imcb_buddy_by_handle(struct im_connection *ic, const char *handle);
381
382G_GNUC_DEPRECATED G_MODULE_EXPORT void imcb_clean_handle(struct im_connection *ic, char *handle);
383
384/* Actions, or whatever. */
385int imc_away_send_update(struct im_connection *ic);
386int imc_chat_msg(struct groupchat *c, char *msg, int flags);
387
388void imc_add_allow(struct im_connection *ic, char *handle);
389void imc_rem_allow(struct im_connection *ic, char *handle);
390void imc_add_block(struct im_connection *ic, char *handle);
391void imc_rem_block(struct im_connection *ic, char *handle);
392
393/* Misc. stuff */
394char *set_eval_timezone(set_t *set, char *value);
395gboolean auto_reconnect(gpointer data, gint fd, b_input_condition cond);
396void cancel_auto_reconnect(struct account *a);
397
398#endif
Note: See TracBrowser for help on using the repository browser.