1 /* bot_NeonHelp.c - NeonServ v5.4
2 * Copyright (C) 2011-2012 Philipp Kreil (pk910)
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 #include "../module.h"
20 #include "bot_NeonHelp.h"
21 #include "../../modcmd.h"
22 #include "cmd_neonhelp.h"
23 #include "../../lang.h"
24 #include "../../mysqlConn.h"
25 #include "../../ClientSocket.h"
26 #include "../../UserNode.h"
27 #include "../../ChanNode.h"
28 #include "../../ChanUser.h"
29 #include "../../IRCEvents.h"
30 #include "../../IRCParser.h"
31 #include "../../bots.h"
32 #include "../../DBHelper.h"
33 #include "../../WHOHandler.h"
35 #define BOTID NEONHELP_BOTID
36 #define BOTALIAS "NeonHelp"
38 static const struct default_language_entry msgtab[] = {
39 {"NH_NOT_ON_CHAN_1", "You cannot open this request as you are not in %s."}, /* {ARGS: "#test"} */
40 {"NH_NOT_ON_CHAN_2", "You cannot open this request as you are not in %s or %s."}, /* {ARGS: "test", "#test-support"} */
41 {"NH_REQUEST_RECORDED", "Your message has been recorded and assigned request ID#%d A helper should contact you shortly."}, /* {ARGS: 5} */
42 {"NH_REQUEST_OTHERS_0", "There are no other unhandled requests."},
43 {"NH_REQUEST_OTHERS_1", "There is 1 other unhandled request."},
44 {"NH_REQUEST_OTHERS_2", "There are %d other unhandled requests."}, /* {ARGS: 1337} */
45 {"NH_REQUEST_FOOTER_1", "Everything you tell me until you are helped (or you leave %1$s) will be recorded. If you part %1$s, your request will be lost."}, /* {ARGS: "#test"} */
46 {"NH_REQUEST_FOOTER_2", "Everything you tell me until you are helped (or you leave %1$s or %2$s) will be recorded. If you part %1$s or %2$s, your request will be lost."}, /* {ARGS: "#test", "#test-support"} */
47 {"NH_NEW_REQUEST", "New request #%d by %s: %s"}, /* {ARGS: 5, "pk910", "Help, I've fallen and I can't get up!"} */
48 {"NH_NEXT_NONE", "No more requests."},
49 {"NH_NEXT_NOT_FOUND", "No request found."},
50 {"NH_NEXT_HEADER", "$bNext request: #%d %s$b"}, /* {ARGS: 5, "pk910"} */
51 {"NH_NEXT_HELPER", "Your helper for request ID#%d is %s (Current nick: %s)."}, /* {ARGS: 5, "pk910", "Skynet"} */
52 {"NH_NEXT_JOIN", "Please /join %s now."}, /* {ARGS: "#test-support"} */
53 {"NH_DELETED", "Your request ID#%d has been deleted."}, /* {ARGS: 5} */
54 {"NH_DELETED_STAFF", "Request deleted: #%d (%s)"}, /* {ARGS: 5, "pk910"} */
55 {"NH_REMIND_OPEN_REQUESTS_1", "There is %d unhandled request!"}, /* {ARGS: 1} */
56 {"NH_REMIND_OPEN_REQUESTS_2", "There are %d unhandled requests!"}, /* {ARGS: 4} */
57 {"NH_REQUESTS_HEADER_ID", "ID"},
58 {"NH_REQUESTS_HEADER_STATUS", "State"},
59 {"NH_REQUESTS_HEADER_NICK", "Nick"},
60 {"NH_REQUESTS_HEADER_TIME", "Time"},
61 {"NH_REQUESTS_HEADER_REQUEST", "Question"},
62 {"NH_REQUESTS_STATE_ACTIVE", "active"},
63 {"NH_REQUESTS_STATE_PENDING", "pending"},
64 {"NH_REQUESTS_STATE_ERROR", "ERROR"},
65 {"NH_STATS_HEADER_USER", "User"},
66 {"NH_STATS_HEADER_LAST_24H", "last 24h"},
67 {"NH_STATS_HEADER_LAST_7DAY", "last 7d"},
68 {"NH_STATS_HEADER_LAST_30DAY", "last 30d"},
72 static void neonhelp_bot_ready(struct ClientSocket *client) {
76 printf_mysql_query("SELECT `automodes` FROM `bots` WHERE `id` = '%d'", client->clientid);
78 if ((row = mysql_fetch_row(res)) != NULL) {
79 putsock(client, "MODE %s +%s", client->user->nick, row[0]);
82 printf_mysql_query("SELECT `channel_name`, `channel_key` FROM `bot_channels` LEFT JOIN `channels` ON `chanid` = `channel_id` WHERE `botid` = '%d' AND `suspended` = '0'", client->clientid);
85 while ((row = mysql_fetch_row(res)) != NULL) {
86 putsock(client, "JOIN %s %s", row[0], row[1]);
90 static void neonhelp_trigger_callback(int clientid, struct ChanNode *chan, char *trigger) {
93 loadChannelSettings(chan);
94 if(!(chan->flags & CHANFLAG_CHAN_REGISTERED)) {
98 printf_mysql_query("SELECT `trigger`, `defaulttrigger` FROM `bot_channels` LEFT JOIN `bots` ON `botid` = `bots`.`id` WHERE `chanid` = '%d' AND `botclass` = '%d'", chan->channel_id, BOTID);
100 if(!(row = mysql_fetch_row(res))) {
101 strcpy(trigger, "!");
104 if(row[0] && *row[0])
105 strcpy(trigger, row[0]);
107 strcpy(trigger, ((row[1] && *row[1]) ? row[1] : "!"));
110 static void start_bots(int type) {
111 struct ClientSocket *client;
112 MYSQL_RES *res, *res2;
115 if(type == MODSTATE_STARTSTOP) {
116 printf_mysql_query("SELECT `nick`, `ident`, `realname`, `server`, `port`, `pass`, `textbot`, `id`, `queue`, `ssl`, `bind` FROM `bots` WHERE `botclass` = '%d' AND `active` = '1'", BOTID);
119 while ((row = mysql_fetch_row(res)) != NULL) {
120 client = create_socket(row[3], atoi(row[4]), row[10], row[5], row[0], row[1], row[2]);
121 client->flags |= (strcmp(row[6], "0") ? SOCKET_FLAG_PREFERRED : 0);
122 client->flags |= (strcmp(row[8], "0") ? SOCKET_FLAG_USE_QUEUE : 0);
123 client->flags |= (strcmp(row[9], "0") ? SOCKET_FLAG_SSL : 0);
124 client->flags |= SOCKET_FLAG_SILENT;
125 client->botid = BOTID;
126 client->clientid = atoi(row[7]);
127 connect_socket(client);
128 //close old, still opened requests
129 printf_mysql_query("UPDATE `helpserv_requests` SET `status` = '2' WHERE `botid` = '%d'", client->clientid);
133 printf_mysql_query("SELECT `command`, `function`, `parameters`, `global_access`, `chan_access`, `flags` FROM `bot_binds` WHERE `botclass` = '%d'", BOTID);
135 while ((row = mysql_fetch_row(res2)) != NULL) {
136 if(bind_cmd_to_command(BOTID, row[0], row[1])) {
137 if(row[2] && strcmp(row[2], "")) {
138 bind_set_parameters(BOTID, row[0], row[2]);
141 bind_set_global_access(BOTID, row[0], atoi(row[3]));
144 bind_set_channel_access(BOTID, row[0], row[4]);
146 if(strcmp(row[5], "0"))
147 bind_set_bind_flags(BOTID, row[0], atoi(row[5]));
150 bind_unbound_required_functions(BOTID);
153 static void neonhelp_event_privmsg_async(struct ClientSocket *client, struct UserNode *user, struct UserNode *target, char *message);
154 static USERAUTH_CALLBACK(neonhelp_event_privmsg_nick_lookup);
155 struct neonhelp_event_privmsg_cache {
156 struct ClientSocket *client;
157 struct UserNode *user, *target;
161 static void neonhelp_event_privmsg(struct UserNode *user, struct UserNode *target, char *message) {
162 struct ClientSocket *client;
163 for(client = getBots(SOCKET_FLAG_READY, NULL); client; client = getBots(SOCKET_FLAG_READY, client)) {
164 if(client->user == target) {
165 if(client->botid != BOTID) return;
169 if(!client) return; //we got the message but we have no client that could receive it???
170 if(user->flags & USERFLAG_ISAUTHED) {
171 neonhelp_event_privmsg_async(client, user, target, message);
173 struct neonhelp_event_privmsg_cache *cache = malloc(sizeof(*cache));
175 cache->client = client;
177 cache->target = target;
178 cache->message = strdup(message);
179 get_userauth(user, module_id, neonhelp_event_privmsg_nick_lookup, cache);
183 static USERAUTH_CALLBACK(neonhelp_event_privmsg_nick_lookup) {
184 struct neonhelp_event_privmsg_cache *cache = data;
185 neonhelp_event_privmsg_async(cache->client, cache->user, cache->target, cache->message);
186 free(cache->message);
190 static TIMEQ_CALLBACK(neonhelp_remind_open_requests);
192 static void neonhelp_event_privmsg_async(struct ClientSocket *client, struct UserNode *user, struct UserNode *target, char *message) {
195 printf_mysql_query("SELECT `helpserv_support`, `helpserv_public`, `helpserv_intern`, `helpserv_intern_announce` FROM `helpserv_settings` WHERE `helpserv_botid` = '%d'", client->clientid);
197 if (!(row = mysql_fetch_row(res))) return;
198 //check if the user is a supporter (access in the support channel)
199 if((user->flags & USERFLAG_ISAUTHED)) {
202 if(user->flags & USERFLAG_HAS_USERID)
203 userid = user->user_id;
205 printf_mysql_query("SELECT `user_id` FROM `users` WHERE `user_user` = '%s'", escape_string(user->auth));
207 if ((row2 = mysql_fetch_row(res)) != NULL) {
208 userid = atoi(row2[0]);
209 user->user_id = userid;
210 user->flags |= USERFLAG_HAS_USERID;
214 printf_mysql_query("SELECT `chanuser_access`, `chanuser_flags` FROM `chanusers` LEFT JOIN `channels` ON `chanuser_cid` = `channel_id` WHERE `chanuser_uid` = '%d' AND `channel_name` = '%s'", userid, escape_string(row[0]));
216 if ((row2 = mysql_fetch_row(res)) != NULL) {
217 int cflags = atoi(row2[1]);
218 if(!(cflags & DB_CHANUSER_SUSPENDED))
219 caccess = atoi(row2[0]);
221 if(caccess) return; //ignore messages from supporters
223 //check if the user is in one of the bot's channels
224 struct ChanUser *chanuser;
225 struct ChanNode *chan;
226 for(chanuser = getUserChannels(target, NULL); chanuser; chanuser = getUserChannels(target, chanuser)) {
227 chan = chanuser->chan;
228 if((!stricmp(chan->name, row[0]) || (row[1] && !stricmp(chan->name, row[1]))) && isUserOnChan(user, chan))
233 reply(client, user, "NH_NOT_ON_CHAN_2", row[0], row[1]);
235 reply(client, user, "NH_NOT_ON_CHAN_1", row[0]);
238 //check if there is already a support request
240 if(client->flags & SOCKET_HAVE_HELPNODE) {
241 struct NeonHelpNode *helpnode;
242 for(helpnode = client->botclass_helpnode; helpnode; helpnode = helpnode->next) {
243 if(helpnode->user == user) {
244 //simply append the message to the database
245 printf_mysql_query("SELECT `text` FROM `helpserv_requests` WHERE `id` = %d", helpnode->suppid);
247 if ((row2 = mysql_fetch_row(res)) != NULL) {
248 char *old_msg = escape_string(row2[0]);
249 char *new_msg = escape_string(message);
250 printf_long_mysql_query(1024 + strlen(old_msg) + strlen(new_msg), "UPDATE `helpserv_requests` SET `text` = '%s\n%s' WHERE `id` = %d", old_msg, new_msg, helpnode->suppid);
258 struct NeonHelpNode *helpnode = malloc(sizeof(*helpnode));
259 if(!helpnode) return;
260 helpnode->user = user;
261 helpnode->logchan = getChanByName(row[0]);
262 helpnode->status = 0;
263 helpnode->announce = (row[2] && strcmp(row[3], "0") ? 1 : 0);
264 if(helpnode->announce) {
266 sprintf(nameBuf, "neonhelp_%d", client->clientid);
267 if(!timeq_name_exists(nameBuf)) {
268 int *cidptr = malloc(sizeof(int));
269 *cidptr = client->clientid;
270 timeq_add_name(nameBuf, 300, module_id, neonhelp_remind_open_requests, cidptr);
273 printf_mysql_query("INSERT INTO `helpserv_requests` (`botid`, `host`, `hand`, `nick`, `status`, `supporter`, `time`, `text`) VALUES ('%d', '%s@%s', '%s', '%s', '0', '-1', UNIX_TIMESTAMP(), '%s')", client->clientid, escape_string(user->ident), escape_string(user->host), ((user->flags & USERFLAG_ISAUTHED) ? escape_string(user->auth) : "*"), escape_string(user->nick), escape_string(message));
274 helpnode->suppid = (int) mysql_insert_id(get_mysql_conn());
275 helpnode->log = NULL;
276 helpnode->next = ((client->flags & SOCKET_HAVE_HELPNODE) ? client->botclass_helpnode : NULL);
277 client->botclass_helpnode = helpnode;
278 client->flags |= SOCKET_HAVE_HELPNODE;
279 //build the user reply...
280 char user_reply[MAXLEN];
281 int user_reply_pos = 0;
282 char reply_buff[MAXLEN];
283 //1st part: NH_REQUEST_RECORDED
284 strcpy(user_reply + user_reply_pos, build_language_string(user, reply_buff, "NH_REQUEST_RECORDED", helpnode->suppid));
285 user_reply_pos += strlen(reply_buff);
286 //2nd part: NH_REQUEST_OTHERS_0 / NH_REQUEST_OTHERS_1 / NH_REQUEST_OTHERS_2
287 user_reply[user_reply_pos++] = ' ';
289 strcpy(user_reply + user_reply_pos, build_language_string(user, reply_buff, (others ? "NH_REQUEST_OTHERS_1" : "NH_REQUEST_OTHERS_0")));
291 strcpy(user_reply + user_reply_pos, build_language_string(user, reply_buff, "NH_REQUEST_OTHERS_2", others));
292 user_reply_pos += strlen(reply_buff);
293 //3th part: NH_REQUEST_FOOTER_1 / NH_REQUEST_FOOTER_2
294 user_reply[user_reply_pos++] = ' ';
296 strcpy(user_reply + user_reply_pos, build_language_string(user, reply_buff, "NH_REQUEST_FOOTER_2", row[0], row[1]));
298 strcpy(user_reply + user_reply_pos, build_language_string(user, reply_buff, "NH_REQUEST_FOOTER_1", row[0]));
299 user_reply_pos += strlen(reply_buff);
300 reply(client, user, "%s", user_reply);
301 //sent a message to the internal channel / onotice to supp channel
302 build_language_string(user, reply_buff, "NH_NEW_REQUEST", helpnode->suppid, user->nick, message);
304 putsock(client, "PRIVMSG %s :%s", row[2], reply_buff);
306 putsock(client, "NOTICE @%s :%s", row[0], reply_buff);
310 static TIMEQ_CALLBACK(neonhelp_remind_open_requests) {
311 int clientid = *((int*)data);
314 printf_mysql_query("SELECT `helpserv_support`, `helpserv_public`, `helpserv_intern`, `helpserv_intern_announce` FROM `helpserv_settings` WHERE `helpserv_botid` = '%d'", clientid);
316 if (!(row = mysql_fetch_row(res)) || !row[2]) {
320 struct ClientSocket *client;
321 for(client = getBots(SOCKET_FLAG_READY, NULL); client; client = getBots(SOCKET_FLAG_READY, client)) {
322 if(client->clientid == clientid)
329 //count open requests
331 struct NeonHelpNode *helpnode;
332 if(client->flags & SOCKET_HAVE_HELPNODE) {
333 for(helpnode = client->botclass_helpnode; helpnode; helpnode = helpnode->next) {
334 if(helpnode->status == 0) {
341 sprintf(nameBuf, "neonhelp_%d", client->clientid);
342 if(!timeq_name_exists(nameBuf)) {
343 timeq_add_name(nameBuf, 300, module_id, neonhelp_remind_open_requests, data);
345 char replybuf[MAXLEN];
346 build_language_string(NULL, replybuf, (requests == 1 ? "NH_REMIND_OPEN_REQUESTS_1" : "NH_REMIND_OPEN_REQUESTS_2"), requests);
347 putsock(client, "PRIVMSG %s :%s", row[2], replybuf);
352 static void neonhelp_event_chanmsg(struct UserNode *user, struct ChanNode *chan, char *message) {
353 char logline[MAXLEN];
354 sprintf(logline, "<%s> %s", user->nick, message);
355 struct ClientSocket *client;
356 for(client = getBots(SOCKET_FLAG_READY, NULL); client; client = getBots(SOCKET_FLAG_READY, client)) {
357 if(client->botid == BOTID) {
358 struct NeonHelpNode *helpnode;
359 if(client->flags & SOCKET_HAVE_HELPNODE) {
360 for(helpnode = client->botclass_helpnode; helpnode; helpnode = helpnode->next) {
361 if(helpnode->logchan == chan && helpnode->status == 1) {
363 helpnode->log = calloc(LOGBUFFERLINES, sizeof(char*));
364 if(!helpnode->log) return;
367 for(i = 0; i < LOGBUFFERLINES; i++) {
368 if(!helpnode->log[i]) {
369 helpnode->log[i] = strdup(logline);
373 if(i == LOGBUFFERLINES) {
374 //write buffer to database
375 char logbuff[MAXLEN * LOGBUFFERLINES];
377 for(i = 0; i < LOGBUFFERLINES; i++) {
378 len += sprintf(logbuff + len, "%s\n", helpnode->log[i]);
379 free(helpnode->log[i]);
380 helpnode->log[i] = NULL;
382 printf_long_mysql_query(1024 + len, "UPDATE `helpserv_requests` SET `log` = CONCAT(`log`, '%s') WHERE `id` = %d", escape_string(logbuff), helpnode->suppid);
392 static void destroy_support_request(struct ClientSocket *client, struct NeonHelpNode *helpnode, int do_reply) {
393 //write buffer to database
394 char logbuff[MAXLEN * LOGBUFFERLINES];
398 for(i = 0; i < LOGBUFFERLINES; i++) {
399 if(!helpnode->log[i]) break;
400 len += sprintf(logbuff + len, "%s\n", helpnode->log[i]);
401 free(helpnode->log[i]);
402 helpnode->log[i] = NULL;
407 printf_long_mysql_query(1024 + len, "UPDATE `helpserv_requests` SET `status`='2', `log` = CONCAT(`log`, '%s') WHERE `id` = %d", escape_string(logbuff), helpnode->suppid);
409 reply(client, helpnode->user, "NH_DELETED", helpnode->suppid);
414 static void neonhelp_event_kick(struct UserNode *user, struct ChanUser *target, char *reason) {
415 struct ClientSocket *client;
418 struct ChanNode *support, *public;
420 for(client = getBots(SOCKET_FLAG_READY, NULL); client; client = getBots(SOCKET_FLAG_READY, client)) {
421 if(client->botid == BOTID && isUserOnChan(client->user, target->chan)) {
423 struct NeonHelpNode *helpnode, *prev_helpnode = NULL;
424 if(client->flags & SOCKET_HAVE_HELPNODE) {
425 for(helpnode = client->botclass_helpnode; helpnode; helpnode = helpnode->next) {
426 if(helpnode->user == target->user) {
430 prev_helpnode = helpnode;
433 if(!userHasRequest) continue;
434 printf_mysql_query("SELECT `helpserv_support`, `helpserv_public`, `helpserv_intern` FROM `helpserv_settings` WHERE `helpserv_botid` = '%d'", client->clientid);
436 if (!(row = mysql_fetch_row(res))) continue;
437 support = getChanByName(row[0]);
438 public = (row[1] ? getChanByName(row[1]) : NULL);
439 if(target->chan == support || !((support && isUserOnChan(target->user, support)) || (public && isUserOnChan(target->user, public)))) {
440 //free the user's support request
442 prev_helpnode->next = helpnode->next;
444 client->botclass_helpnode = helpnode->next;
445 destroy_support_request(client, helpnode, 1);
451 static void neonhelp_event_part(struct ChanUser *target, char *reason) {
452 struct ClientSocket *client;
455 struct ChanNode *support, *public;
457 for(client = getBots(SOCKET_FLAG_READY, NULL); client; client = getBots(SOCKET_FLAG_READY, client)) {
458 if(client->botid == BOTID && isUserOnChan(client->user, target->chan)) {
460 struct NeonHelpNode *helpnode, *prev_helpnode = NULL;
461 if(client->flags & SOCKET_HAVE_HELPNODE) {
462 for(helpnode = client->botclass_helpnode; helpnode; helpnode = helpnode->next) {
463 if(helpnode->user == target->user) {
467 prev_helpnode = helpnode;
470 if(!userHasRequest) continue;
471 printf_mysql_query("SELECT `helpserv_support`, `helpserv_public`, `helpserv_intern` FROM `helpserv_settings` WHERE `helpserv_botid` = '%d'", client->clientid);
473 if (!(row = mysql_fetch_row(res))) continue;
474 support = getChanByName(row[0]);
475 public = (row[1] ? getChanByName(row[1]) : NULL);
476 if(target->chan == support || !((support && isUserOnChan(target->user, support)) || (public && isUserOnChan(target->user, public)))) {
477 //free the user's support request
479 prev_helpnode->next = helpnode->next;
481 client->botclass_helpnode = helpnode->next;
482 destroy_support_request(client, helpnode, 1);
488 static void neonhelp_event_quit(struct UserNode *target, char *reason) {
489 struct ClientSocket *client;
491 for(client = getBots(SOCKET_FLAG_READY, NULL); client; client = getBots(SOCKET_FLAG_READY, client)) {
492 if(client->botid == BOTID) {
494 struct NeonHelpNode *helpnode, *prev_helpnode = NULL;
495 if(client->flags & SOCKET_HAVE_HELPNODE) {
496 for(helpnode = client->botclass_helpnode; helpnode; helpnode = helpnode->next) {
497 if(helpnode->user == target) {
501 prev_helpnode = helpnode;
504 if(!userHasRequest) continue;
505 //free the user's support request
507 prev_helpnode->next = helpnode->next;
509 client->botclass_helpnode = helpnode->next;
510 destroy_support_request(client, helpnode, 0);
515 void init_NeonHelp(int type) {
516 set_bot_alias(BOTID, BOTALIAS);
519 if(type == MODSTATE_REBIND) return;
522 bind_bot_ready(neonhelp_bot_ready, module_id);
523 bind_privmsg(neonhelp_event_privmsg, module_id);
524 bind_chanmsg(neonhelp_event_chanmsg, module_id);
525 bind_part(neonhelp_event_part, module_id);
526 bind_kick(neonhelp_event_kick, module_id);
527 bind_quit(neonhelp_event_quit, module_id);
529 set_trigger_callback(BOTID, module_id, neonhelp_trigger_callback);
531 register_default_language_table(msgtab);
534 void loop_NeonHelp() {
538 void free_NeonHelp(int type) {
539 unbind_allcmd(BOTID);
540 if(type == MODSTATE_STARTSTOP) {
541 //disconnect all our bots
542 struct ClientSocket *client;
543 for(client = getBots(0, NULL); client; client = getBots(0, client)) {
544 if(client->botid == BOTID) {
545 unbind_botwise_allcmd(0, client->clientid);
546 close_socket(client);