libpurple/protocols/irc/irc.h

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