source: protocols/nogaim.h @ bad41f56

Last change on this file since bad41f56 was bad41f56, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-08-19T23:42:11Z

libpurple: Fix typing notifications (in and out). Closes #671.

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