source: protocols/nogaim.h @ 536dfa1

Last change on this file since 536dfa1 was 536dfa1, checked in by Wilmer van der Gaast <wilmer@…>, at 2012-11-11T22:13:07Z

Cleaning up struct im_connection a little bit.

  • Property mode set to 100644
File size: 13.9 KB
RevLine 
[b7d3cc34]1  /********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
[d860a8d]4  * Copyright 2002-2010 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)
[6bbb939]18 * Copyright 2002-2007 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;
34  if not, write to the Free Software Foundation, Inc., 59 Temple Place,
35  Suite 330, Boston, MA  02111-1307  USA
36*/
37
38#ifndef _NOGAIM_H
39#define _NOGAIM_H
40
[daae10f]41#if(__sun)
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 */
[fb62f81f]70
[b7d3cc34]71/* ok. now the fun begins. first we create a connection structure */
[0da65d5]72struct im_connection
[192b80a]73{
[0a3c243]74        account_t *acc;
[52744f8]75        uint32_t flags;
[b7d3cc34]76       
[192b80a]77        /* each connection then can have its own protocol-specific data */
78        void *proto_data;
79       
[b7d3cc34]80        /* all connections need an input watcher */
81        int inpa;
[192b80a]82        guint keepalive;
[b7d3cc34]83       
84        /* buddy list stuff. there is still a global groups for the buddy list, but
85         * we need to maintain our own set of buddies, and our own permit/deny lists */
86        GSList *permit;
87        GSList *deny;
88        int permdeny;
89       
90        char *away;
91       
92        /* BitlBee */
[81e04e1]93        bee_t *bee;
[b7d3cc34]94       
[aea8b68]95        GSList *groupchats;
[b7d3cc34]96};
97
[0da65d5]98struct groupchat {
99        struct im_connection *ic;
[b7d3cc34]100
101        /* stuff used just for chat */
[acd61b9]102        /* The in_room variable is a list of handles (not nicks!), kind of
103         * "nick list". This is how you can check who is in the group chat
104         * already, for example to avoid adding somebody two times. */
[fa29d093]105        GList *in_room;
[aea8b68]106        //GList *ignored;
[fa29d093]107       
[aea8b68]108        //struct groupchat *next;
[acd61b9]109        /* The title variable contains the ID you gave when you created the
110         * chat using imcb_chat_new(). */
[fa29d093]111        char *title;
[50e1776]112        /* Use imcb_chat_topic() to change this variable otherwise the user
113         * won't notice the topic change. */
114        char *topic;
[fa29d093]115        char joined;
[acd61b9]116        /* This is for you, you can add your own structure here to extend this
117         * structure for your protocol's needs. */
[fa29d093]118        void *data;
[aea8b68]119        void *ui_data;
[b7d3cc34]120};
121
122struct buddy {
123        char name[80];
124        char show[BUDDY_ALIAS_MAXLEN];
[fa29d093]125        int present;
[b7d3cc34]126        time_t signon;
127        time_t idle;
[fa29d093]128        int uc;
[b7d3cc34]129        guint caps; /* woohoo! */
130        void *proto_data; /* what a hack */
[0da65d5]131        struct im_connection *ic; /* the connection it belongs to */
[b7d3cc34]132};
133
[d88c92a]134struct buddy_action {
135        char *name;
136        char *description;
137};
138
[b7d3cc34]139struct prpl {
140        int options;
[acd61b9]141        /* You should set this to the name of your protocol.
142         * - The user sees this name ie. when imcb_log() is used. */
[7b23afd]143        const char *name;
[cd741d8]144        void *data;
[1dd3470]145        /* Maximum Message Size of this protocol.
146         * - Introduced for OTR, in order to fragment large protocol messages.
147         * - 0 means "unlimited". */
148        unsigned int mms;
[b7d3cc34]149
[0da65d5]150        /* Added this one to be able to add per-account settings, don't think
[acd61b9]151         * it should be used for anything else. You are supposed to use the
152         * set_add() function to add new settings. */
[0da65d5]153        void (* init)           (account_t *);
[acd61b9]154        /* The typical usage of the login() function:
155         * - Create an im_connection using imcb_new() from the account_t parameter.
156         * - Initialize your myproto_data struct - you should store all your protocol-specific data there.
157         * - Save your custom structure to im_connection->proto_data.
158         * - Use proxy_connect() to connect to the server.
159         */
[0a3c243]160        void (* login)          (account_t *);
[acd61b9]161        /* Implementing this function is optional. */
[0da65d5]162        void (* keepalive)      (struct im_connection *);
[acd61b9]163        /* In this function you should:
164         * - Tell the server about you are logging out.
165         * - g_free() your myproto_data struct as BitlBee does not know how to
166         *   properly do so.
167         */
[0da65d5]168        void (* logout)         (struct im_connection *);
169       
[acd61b9]170        /* This function is called when the user wants to send a message to a handle.
171         * - 'to' is a handle, not a nick
172         * - 'flags' may be ignored
173         */
[f6c963b]174        int  (* buddy_msg)      (struct im_connection *, char *to, char *message, int flags);
[acd61b9]175        /* This function is called then the user uses the /away IRC command.
176         * - 'state' contains the away reason.
177         * - 'message' may be ignored if your protocol does not support it.
178         */
[0da65d5]179        void (* set_away)       (struct im_connection *, char *state, char *message);
[acd61b9]180        /* Implementing this function is optional. */
[0da65d5]181        void (* get_away)       (struct im_connection *, char *who);
[acd61b9]182        /* Implementing this function is optional. */
[9624fdf]183        int  (* send_typing)    (struct im_connection *, char *who, int flags);
[0da65d5]184       
[acd61b9]185        /* 'name' is a handle to add/remove. For now BitlBee doesn't really
186         * handle groups, just set it to NULL, so you can ignore that
187         * parameter. */
[0da65d5]188        void (* add_buddy)      (struct im_connection *, char *name, char *group);
189        void (* remove_buddy)   (struct im_connection *, char *name, char *group);
190       
[acd61b9]191        /* Block list stuff. Implementing these are optional. */
[0da65d5]192        void (* add_permit)     (struct im_connection *, char *who);
193        void (* add_deny)       (struct im_connection *, char *who);
194        void (* rem_permit)     (struct im_connection *, char *who);
195        void (* rem_deny)       (struct im_connection *, char *who);
[0eb971a]196        /* Doesn't actually have UI hooks. Not used at all, can be removed. */
[0da65d5]197        void (* set_permit_deny)(struct im_connection *);
198       
199        /* Request profile info. Free-formatted stuff, the IM module gives back
[acd61b9]200           this info via imcb_log(). Implementing these are optional. */
[0da65d5]201        void (* get_info)       (struct im_connection *, char *who);
[4452e69]202        /* set_my_name is *DEPRECATED*, not used by the UI anymore. Use the
203           display_name setting instead. */
[0da65d5]204        void (* set_my_name)    (struct im_connection *, char *name);
205        void (* set_name)       (struct im_connection *, char *who, char *name);
[192b80a]206       
207        /* Group chat stuff. */
[acd61b9]208        /* This is called when the user uses the /invite IRC command.
209         * - 'who' may be ignored
210         * - 'message' is a handle to invite
211         */
[0da65d5]212        void (* chat_invite)    (struct groupchat *, char *who, char *message);
[acd61b9]213        /* This is called when the user uses the /part IRC command in a group
214         * chat. You just should tell the user about it, nothing more. */
[0da65d5]215        void (* chat_leave)     (struct groupchat *);
[acd61b9]216        /* This is called when the user sends a message to the groupchat.
217         * 'flags' may be ignored. */
[f6c963b]218        void (* chat_msg)       (struct groupchat *, char *message, int flags);
[acd61b9]219        /* This is called when the user uses the /join #nick IRC command.
220         * - 'who' is the handle of the nick
221         */
[0da65d5]222        struct groupchat *
223             (* chat_with)      (struct im_connection *, char *who);
[acd61b9]224        /* This is used when the user uses the /join #channel IRC command.  If
225         * your protocol does not support publicly named group chats, then do
226         * not implement this. */
[0da65d5]227        struct groupchat *
[03f3828]228             (* chat_join)      (struct im_connection *, const char *room,
229                                 const char *nick, const char *password, set_t **sets);
[50e1776]230        /* Change the topic, if supported. Note that BitlBee expects the IM
231           server to confirm the topic change with a regular topic change
232           event. If it doesn't do that, you have to fake it to make it
233           visible to the user. */
[ef5c185]234        void (* chat_topic)     (struct groupchat *, char *topic);
[192b80a]235       
[03f3828]236        /* If your protocol module needs any special info for joining chatrooms
237           other than a roomname + nickname, add them here. */
238        void (* chat_add_settings)      (account_t *acc, set_t **head);
239        void (* chat_free_settings)     (account_t *acc, set_t **head);
240       
[acd61b9]241        /* You can tell what away states your protocol supports, so that
[2bc8ac0]242         * BitlBee will try to map the IRC away reasons to them. If your
243         * protocol doesn't have any, just return one generic "Away". */
[0da65d5]244        GList *(* away_states)(struct im_connection *ic);
[192b80a]245       
[acd61b9]246        /* Mainly for AOL, since they think "Bung hole" == "Bu ngho le". *sigh*
247         * - Most protocols will just want to set this to g_strcasecmp().*/
[5b52a48]248        int (* handle_cmp) (const char *who1, const char *who2);
[2ff2076]249
[fa295e36]250        /* Implement these callbacks if you want to use imcb_ask_auth() */
251        void (* auth_allow)     (struct im_connection *, const char *who);
252        void (* auth_deny)      (struct im_connection *, const char *who);
[2288705]253
[2ff2076]254        /* Incoming transfer request */
255        void (* transfer_request) (struct im_connection *, file_transfer_t *ft, char *handle );
[03f3828]256       
[203a2d2]257        void (* buddy_data_add) (struct bee_user *bu);
258        void (* buddy_data_free) (struct bee_user *bu);
259       
[d88c92a]260        GList *(* buddy_action_list) (struct bee_user *bu);
261        void *(* buddy_action) (struct bee_user *bu, const char *action, char * const args[], void *data);
262       
[03f3828]263        /* Some placeholders so eventually older plugins may cooperate with newer BitlBees. */
264        void *resv1;
265        void *resv2;
266        void *resv3;
267        void *resv4;
268        void *resv5;
[b7d3cc34]269};
270
[84b045d]271/* im_api core stuff. */
272void nogaim_init();
[b7d3cc34]273G_MODULE_EXPORT GSList *get_connections();
[f6c963b]274G_MODULE_EXPORT struct prpl *find_protocol( const char *name );
[acd61b9]275/* When registering a new protocol, you should allocate space for a new prpl
276 * struct, initialize it (set the function pointers to point to your
277 * functions), finally call this function. */
[f6c963b]278G_MODULE_EXPORT void register_protocol( struct prpl * );
[b7d3cc34]279
[84b045d]280/* Connection management. */
[acd61b9]281/* You will need this function in prpl->login() to get an im_connection from
282 * the account_t parameter. */
[84b045d]283G_MODULE_EXPORT struct im_connection *imcb_new( account_t *acc );
[c0c43fb]284G_MODULE_EXPORT void imc_free( struct im_connection *ic );
[acd61b9]285/* Once you're connected, you should call this function, so that the user will
286 * see the success. */
[84b045d]287G_MODULE_EXPORT void imcb_connected( struct im_connection *ic );
[acd61b9]288/* This can be used to disconnect when something went wrong (ie. read error
289 * from the server). You probably want to set the second parameter to TRUE. */
[c2fb3809]290G_MODULE_EXPORT void imc_logout( struct im_connection *ic, int allow_reconnect );
[b7d3cc34]291
[84b045d]292/* Communicating with the user. */
[acd61b9]293/* A printf()-like function to tell the user anything you want. */
[d11dd2f]294G_MODULE_EXPORT void imcb_log( struct im_connection *ic, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
[acd61b9]295/* To tell the user an error, ie. before logging out when an error occurs. */
[d11dd2f]296G_MODULE_EXPORT void imcb_error( struct im_connection *ic, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
[fa295e36]297
[acd61b9]298/* To ask a your about something.
299 * - 'msg' is the question.
300 * - 'data' can be your custom struct - it will be passed to the callbacks.
301 * - 'doit' or 'dont' will be called depending of the answer of the user.
302 */
[9143aeb]303G_MODULE_EXPORT void imcb_ask( struct im_connection *ic, char *msg, void *data, query_callback doit, query_callback dont );
[d0527c1]304G_MODULE_EXPORT void imcb_ask_with_free( struct im_connection *ic, char *msg, void *data, query_callback doit, query_callback dont, query_callback myfree );
[fa295e36]305
306/* Two common questions you may want to ask:
307 * - X added you to his contact list, allow?
308 * - X is not in your contact list, want to add?
309 */
310G_MODULE_EXPORT void imcb_ask_auth( struct im_connection *ic, const char *handle, const char *realname );
311G_MODULE_EXPORT void imcb_ask_add( struct im_connection *ic, const char *handle, const char *realname );
[b7d3cc34]312
[84b045d]313/* Buddy management */
[acd61b9]314/* This function should be called for each handle which are visible to the
[527360f]315 * user, usually after a login, or if the user added a buddy and the IM
316 * server confirms that the add was successful. Don't forget to do this! */
[c6ca3ee]317G_MODULE_EXPORT void imcb_add_buddy( struct im_connection *ic, const char *handle, const char *group );
318G_MODULE_EXPORT void imcb_remove_buddy( struct im_connection *ic, const char *handle, char *group );
[f0cb961]319G_MODULE_EXPORT struct buddy *imcb_find_buddy( struct im_connection *ic, char *handle );
[c6ca3ee]320G_MODULE_EXPORT void imcb_rename_buddy( struct im_connection *ic, const char *handle, const char *realname );
[fb00989]321G_MODULE_EXPORT void imcb_buddy_nick_hint( struct im_connection *ic, const char *handle, const char *nick );
[d88c92a]322G_MODULE_EXPORT void imcb_buddy_action_response( bee_user_t *bu, const char *action, char * const args[], void *data );
[84b045d]323
[bad41f56]324G_MODULE_EXPORT void imcb_buddy_typing( struct im_connection *ic, const char *handle, uint32_t flags );
[d860a8d]325G_MODULE_EXPORT struct bee_user *imcb_buddy_by_handle( struct im_connection *ic, const char *handle );
[85023c6]326G_MODULE_EXPORT void imcb_clean_handle( struct im_connection *ic, char *handle );
[84b045d]327
328/* Actions, or whatever. */
[58adb7e]329int imc_away_send_update( struct im_connection *ic );
[84b045d]330int imc_chat_msg( struct groupchat *c, char *msg, int flags );
331
332void imc_add_allow( struct im_connection *ic, char *handle );
333void imc_rem_allow( struct im_connection *ic, char *handle );
334void imc_add_block( struct im_connection *ic, char *handle );
335void imc_rem_block( struct im_connection *ic, char *handle );
336
337/* Misc. stuff */
[3e57660]338char *set_eval_timezone( set_t *set, char *value );
[84b045d]339gboolean auto_reconnect( gpointer data, gint fd, b_input_condition cond );
340void cancel_auto_reconnect( struct account *a );
341
[b7d3cc34]342#endif
Note: See TracBrowser for help on using the repository browser.