libpurple/protocols/irc/irc.h

   1 /**
   2  * @file irc.h
   3  *
   4  * purple
   5  *
   6  * Copyright (C) 2003, 2012 Ethan Blanton <elb@pidgin.im>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  21  */
  22
  23 #ifndef _PURPLE_IRC_H
  24 #define _PURPLE_IRC_H
  25
  26 #include <glib.h>
  27
  28 #ifdef HAVE_CYRUS_SASL
  29 #include <sasl/sasl.h>
  30 #endif
  31
  32 #include "circbuffer.h"
  33 #include "ft.h"
  34 #include "roomlist.h"
  35 #include "sslconn.h"
  36
  37 #define IRC_DEFAULT_SERVER "irc.freenode.net"
  38 #define IRC_DEFAULT_PORT 6667
  39 #define IRC_DEFAULT_SSL_PORT 994
  40
  41 #define IRC_DEFAULT_CHARSET "UTF-8"
  42 #define IRC_DEFAULT_AUTODETECT FALSE
  43 #define IRC_DEFAULT_ALIAS "purple"
  44
  45 #define IRC_DEFAULT_QUIT "Leaving."
  46
  47 #define IRC_INITIAL_BUFSIZE 1024
  48
  49 #define IRC_MAX_MSG_SIZE 512
  50
  51 #define IRC_NAMES_FLAG "irc-namelist"
  52
  53
  54 enum { IRC_USEROPT_SERVER, IRC_USEROPT_PORT, IRC_USEROPT_CHARSET };
  55 enum irc_state { IRC_STATE_NEW, IRC_STATE_ESTABLISHED };
  56
  57 struct irc_conn {
  58         PurpleAccount *account;
  59         GHashTable *msgs;
  60         GHashTable *cmds;
  61         char *server;
  62         int fd;
  63         guint timer;
  64         GHashTable *buddies;
  65
  66         gboolean ison_outstanding;
  67         GList *buddies_outstanding;
  68
  69         char *inbuf;
  70         int inbuflen;
  71         int inbufused;
  72
  73         GString *motd;
  74         GString *names;
  75         struct _whois {
  76                 char *nick;
  77                 char *real;
  78                 char *login;
  79                 char *ident;
  80                 char *host;
  81                 char *away;
  82                 char *server;
  83                 char *serverinfo;
  84                 GString *channels;
  85                 int ircop;
  86                 int identified;
  87                 int idle;
  88                 time_t signon;
  89         } whois;
  90         PurpleRoomlist *roomlist;
  91         PurpleSslConnection *gsc;
  92
  93         gboolean quitting;
  94
  95         PurpleCircBuffer *outbuf;
  96         guint writeh;
  97
  98         time_t recv_time;
  99
 100         char *mode_chars;
 101         char *reqnick;
 102         gboolean nickused;
 103 #ifdef HAVE_CYRUS_SASL
 104         sasl_conn_t *sasl_conn;
 105         const char *current_mech;
 106         GString *sasl_mechs;
 107         gboolean mech_works;
 108         sasl_callback_t *sasl_cb;
 109 #endif
 110 };
 111
 112 struct irc_buddy {
 113         char *name;
 114         gboolean online;
 115         gboolean flag;
 116         gboolean new_online_status;
 117         int ref;
 118 };
 119
 120 typedef int (*IRCCmdCallback) (struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 121
 122 int irc_send(struct irc_conn *irc, const char *buf);
 123 int irc_send_len(struct irc_conn *irc, const char *buf, int len);
 124 gboolean irc_blist_timeout(struct irc_conn *irc);
 125 gboolean irc_who_channel_timeout(struct irc_conn *irc);
 126 void irc_buddy_query(struct irc_conn *irc);
 127
 128 char *irc_escape_privmsg(const char *text, gssize length);
 129
 130 char *irc_mirc2html(const char *string);
 131 char *irc_mirc2txt(const char *string);
 132
 133 const char *irc_nick_skip_mode(struct irc_conn *irc, const char *string);
 134
 135 gboolean irc_ischannel(const char *string);
 136
 137 void irc_register_commands(void);
 138 void irc_msg_table_build(struct irc_conn *irc);
 139 void irc_parse_msg(struct irc_conn *irc, char *input);
 140 char *irc_parse_ctcp(struct irc_conn *irc, const char *from, const char *to, const char *msg, int notice);
 141 char *irc_format(struct irc_conn *irc, const char *format, ...);
 142
 143 void irc_msg_default(struct irc_conn *irc, const char *name, const char *from, char **args);
 144 void irc_msg_away(struct irc_conn *irc, const char *name, const char *from, char **args);
 145 void irc_msg_badmode(struct irc_conn *irc, const char *name, const char *from, char **args);
 146 void irc_msg_badnick(struct irc_conn *irc, const char *name, const char *from, char **args);
 147 void irc_msg_ban(struct irc_conn *irc, const char *name, const char *from, char **args);
 148 void irc_msg_banfull(struct irc_conn *irc, const char *name, const char *from, char **args);
 149 void irc_msg_banned(struct irc_conn *irc, const char *name, const char *from, char **args);
 150 void irc_msg_chanmode(struct irc_conn *irc, const char *name, const char *from, char **args);
 151 void irc_msg_endwhois(struct irc_conn *irc, const char *name, const char *from, char **args);
 152 void irc_msg_features(struct irc_conn *irc, const char *name, const char *from, char **args);
 153 void irc_msg_invite(struct irc_conn *irc, const char *name, const char *from, char **args);
 154 void irc_msg_inviteonly(struct irc_conn *irc, const char *name, const char *from, char **args);
 155 void irc_msg_ison(struct irc_conn *irc, const char *name, const char *from, char **args);
 156 void irc_msg_join(struct irc_conn *irc, const char *name, const char *from, char **args);
 157 void irc_msg_kick(struct irc_conn *irc, const char *name, const char *from, char **args);
 158 void irc_msg_list(struct irc_conn *irc, const char *name, const char *from, char **args);
 159 void irc_msg_luser(struct irc_conn *irc, const char *name, const char *from, char **args);
 160 void irc_msg_mode(struct irc_conn *irc, const char *name, const char *from, char **args);
 161 void irc_msg_motd(struct irc_conn *irc, const char *name, const char *from, char **args);
 162 void irc_msg_names(struct irc_conn *irc, const char *name, const char *from, char **args);
 163 void irc_msg_nick(struct irc_conn *irc, const char *name, const char *from, char **args);
 164 void irc_msg_nickused(struct irc_conn *irc, const char *name, const char *from, char **args);
 165 void irc_msg_nochan(struct irc_conn *irc, const char *name, const char *from, char **args);
 166 void irc_msg_nonick(struct irc_conn *irc, const char *name, const char *from, char **args);
 167 void irc_msg_nochangenick(struct irc_conn *irc, const char *name, const char *from, char **args);
 168 void irc_msg_nosend(struct irc_conn *irc, const char *name, const char *from, char **args);
 169 void irc_msg_notice(struct irc_conn *irc, const char *name, const char *from, char **args);
 170 void irc_msg_notinchan(struct irc_conn *irc, const char *name, const char *from, char **args);
 171 void irc_msg_notop(struct irc_conn *irc, const char *name, const char *from, char **args);
 172 void irc_msg_part(struct irc_conn *irc, const char *name, const char *from, char **args);
 173 void irc_msg_ping(struct irc_conn *irc, const char *name, const char *from, char **args);
 174 void irc_msg_pong(struct irc_conn *irc, const char *name, const char *from, char **args);
 175 void irc_msg_privmsg(struct irc_conn *irc, const char *name, const char *from, char **args);
 176 void irc_msg_quit(struct irc_conn *irc, const char *name, const char *from, char **args);
 177 void irc_msg_regonly(struct irc_conn *irc, const char *name, const char *from, char **args);
 178 void irc_msg_time(struct irc_conn *irc, const char *name, const char *from, char **args);
 179 void irc_msg_topic(struct irc_conn *irc, const char *name, const char *from, char **args);
 180 void irc_msg_topicinfo(struct irc_conn *irc, const char *name, const char *from, char **args);
 181 void irc_msg_unavailable(struct irc_conn *irc, const char *name, const char *from, char **args);
 182 void irc_msg_unknown(struct irc_conn *irc, const char *name, const char *from, char **args);
 183 void irc_msg_wallops(struct irc_conn *irc, const char *name, const char *from, char **args);
 184 void irc_msg_whois(struct irc_conn *irc, const char *name, const char *from, char **args);
 185 void irc_msg_who(struct irc_conn *irc, const char *name, const char *from, char **args);
 186 #ifdef HAVE_CYRUS_SASL
 187 void irc_msg_cap(struct irc_conn *irc, const char *name, const char *from, char **args);
 188 void irc_msg_auth(struct irc_conn *irc, char *arg);
 189 void irc_msg_authok(struct irc_conn *irc, const char *name, const char *from, char **args);
 190 void irc_msg_authtryagain(struct irc_conn *irc, const char *name, const char *from, char **args);
 191 void irc_msg_authfail(struct irc_conn *irc, const char *name, const char *from, char **args);
 192 #endif
 193
 194 void irc_msg_ignore(struct irc_conn *irc, const char *name, const char *from, char **args);
 195
 196 void irc_cmd_table_build(struct irc_conn *irc);
 197
 198 int irc_cmd_default(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 199 int irc_cmd_away(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 200 int irc_cmd_ctcp(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 201 int irc_cmd_ctcp_action(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 202 int irc_cmd_ctcp_version(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 203 int irc_cmd_invite(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 204 int irc_cmd_join(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 205 int irc_cmd_kick(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 206 int irc_cmd_list(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 207 int irc_cmd_mode(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 208 int irc_cmd_names(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 209 int irc_cmd_nick(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 210 int irc_cmd_op(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 211 int irc_cmd_privmsg(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 212 int irc_cmd_part(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 213 int irc_cmd_ping(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 214 int irc_cmd_quit(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 215 int irc_cmd_quote(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 216 int irc_cmd_query(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 217 int irc_cmd_remove(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 218 int irc_cmd_service(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 219 int irc_cmd_time(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 220 int irc_cmd_topic(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 221 int irc_cmd_wallops(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 222 int irc_cmd_whois(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 223 int irc_cmd_whowas(struct irc_conn *irc, const char *cmd, const char *target, const char **args);
 224
 225 PurpleXfer *irc_dccsend_new_xfer(PurpleConnection *gc, const char *who);
 226 void irc_dccsend_send_file(PurpleConnection *gc, const char *who, const char *file);
 227 void irc_dccsend_recv(struct irc_conn *irc, const char *from, const char *msg);
 228 #endif /* _PURPLE_IRC_H */