1 /* bot_NeonHelp.c - NeonServ v5.3
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"
19 #include "bot_NeonHelp.h"
20 #include "../../modcmd.h"
21 #include "../../cmd_neonhelp.h"
22 #include "../../lang.h"
23 #include "../../mysqlConn.h"
24 #include "../../ClientSocket.h"
25 #include "../../UserNode.h"
26 #include "../../ChanNode.h"
27 #include "../../ChanUser.h"
28 #include "../../IRCEvents.h"
29 #include "../../IRCParser.h"
30 #include "../../bots.h"
31 #include "../../DBHelper.h"
32 #include "../../WHOHandler.h"
35 #define BOTALIAS "NeonHelp"
37 static const struct default_language_entry msgtab[] = {
38 {"NH_NOT_ON_CHAN_1", "You cannot open this request as you are not in %s."}, /* {ARGS: "#test"} */
39 {"NH_NOT_ON_CHAN_2", "You cannot open this request as you are not in %s or %s."}, /* {ARGS: "test", "#test-support"} */
40 {"NH_REQUEST_RECORDED", "Your message has been recorded and assigned request ID#%d A helper should contact you shortly."}, /* {ARGS: 5} */
41 {"NH_REQUEST_OTHERS_0", "There are no other unhandled requests."},
42 {"NH_REQUEST_OTHERS_1", "There is 1 other unhandled request."},
43 {"NH_REQUEST_OTHERS_2", "There are %d other unhandled requests."}, /* {ARGS: 1337} */
44 {"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"} */
45 {"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"} */
46 {"NH_NEW_REQUEST", "New request #%d by %s: %s"}, /* {ARGS: 5, "pk910", "Help, I've fallen and I can't get up!"} */
47 {"NH_NEXT_NONE", "No more requests."},
48 {"NH_NEXT_NOT_FOUND", "No request found."},
49 {"NH_NEXT_HEADER", "$bNext request: #%d %s$b"}, /* {ARGS: 5, "pk910"} */
50 {"NH_NEXT_HELPER", "Your helper for request ID#%d is %s (Current nick: %s)."}, /* {ARGS: 5, "pk910", "Skynet"} */
51 {"NH_NEXT_JOIN", "Please /join %s now."}, /* {ARGS: "#test-support"} */
52 {"NH_DELETED", "Your request ID#%d has been deleted."}, /* {ARGS: 5} */
53 {"NH_DELETED_STAFF", "Request deleted: #%d (%s)"}, /* {ARGS: 5, "pk910"} */
54 {"NH_REMIND_OPEN_REQUESTS_1", "There is %d unhandled request!"}, /* {ARGS: 1} */
55 {"NH_REMIND_OPEN_REQUESTS_2", "There are %d unhandled requests!"}, /* {ARGS: 4} */
56 {"NH_REQUESTS_HEADER_ID", "ID"},
57 {"NH_REQUESTS_HEADER_STATUS", "State"},
58 {"NH_REQUESTS_HEADER_NICK", "Nick"},
59 {"NH_REQUESTS_HEADER_TIME", "Time"},
60 {"NH_REQUESTS_HEADER_REQUEST", "Question"},
61 {"NH_REQUESTS_STATE_ACTIVE", "active"},
62 {"NH_REQUESTS_STATE_PENDING", "pending"},
63 {"NH_REQUESTS_STATE_ERROR", "ERROR"},
64 {"NH_STATS_HEADER_USER", "User"},
65 {"NH_STATS_HEADER_LAST_24H", "last 24h"},
66 {"NH_STATS_HEADER_LAST_7DAY", "last 7d"},
67 {"NH_STATS_HEADER_LAST_30DAY", "last 30d"},
71 static void neonhelp_bot_ready(struct ClientSocket *client) {
75 printf_mysql_query("SELECT `automodes` FROM `bots` WHERE `id` = '%d'", client->clientid);
77 if ((row = mysql_fetch_row(res)) != NULL) {
78 putsock(client, "MODE %s +%s", client->user->nick, row[0]);
81 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);
84 while ((row = mysql_fetch_row(res)) != NULL) {
85 putsock(client, "JOIN %s %s", row[0], row[1]);
89 static void neonhelp_trigger_callback(int clientid, struct ChanNode *chan, char *trigger) {
92 loadChannelSettings(chan);
93 if(!(chan->flags & CHANFLAG_CHAN_REGISTERED)) {
97 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);
99 if(!(row = mysql_fetch_row(res))) {
100 strcpy(trigger, "!");
103 if(row[0] && *row[0])
104 strcpy(trigger, row[0]);
106 strcpy(trigger, ((row[1] && *row[1]) ? row[1] : "!"));
109 static void start_bots(int type) {
110 struct ClientSocket *client;
111 MYSQL_RES *res, *res2;
114 if(type == MODSTATE_STARTSTOP) {
115 printf_mysql_query("SELECT `nick`, `ident`, `realname`, `server`, `port`, `pass`, `textbot`, `id`, `queue`, `ssl`, `bind` FROM `bots` WHERE `botclass` = '%d' AND `active` = '1'", BOTID);
118 while ((row = mysql_fetch_row(res)) != NULL) {
119 client = create_socket(row[3], atoi(row[4]), row[10], row[5], row[0], row[1], row[2]);
120 client->flags |= (strcmp(row[6], "0") ? SOCKET_FLAG_PREFERRED : 0);
121 client->flags |= (strcmp(row[8], "0") ? SOCKET_FLAG_USE_QUEUE : 0);
122 client->flags |= (strcmp(row[9], "0") ? SOCKET_FLAG_SSL : 0);
123 client->flags |= SOCKET_FLAG_SILENT;
124 client->botid = BOTID;
125 client->clientid = atoi(row[7]);
126 connect_socket(client);
127 //close old, still opened requests
128 printf_mysql_query("UPDATE `helpserv_requests` SET `status` = '2' WHERE `botid` = '%d'", client->clientid);
132 printf_mysql_query("SELECT `command`, `function`, `parameters`, `global_access`, `chan_access`, `flags` FROM `bot_binds` WHERE `botclass` = '%d'", BOTID);
134 while ((row = mysql_fetch_row(res2)) != NULL) {
135 if(bind_cmd_to_command(BOTID, row[0], row[1])) {
136 if(row[2] && strcmp(row[2], "")) {
137 bind_set_parameters(BOTID, row[0], row[2]);
140 bind_set_global_access(BOTID, row[0], atoi(row[3]));
143 bind_set_channel_access(BOTID, row[0], row[4]);
145 if(strcmp(row[5], "0"))
146 bind_set_bind_flags(BOTID, row[0], atoi(row[5]));
149 bind_unbound_required_functions(BOTID);
152 static void neonhelp_event_privmsg_async(struct ClientSocket *client, struct UserNode *user, struct UserNode *target, char *message);
153 static USERAUTH_CALLBACK(neonhelp_event_privmsg_nick_lookup);
154 struct neonhelp_event_privmsg_cache {
155 struct ClientSocket *client;
156 struct UserNode *user, *target;
160 static void neonhelp_event_privmsg(struct UserNode *user, struct UserNode *target, char *message) {
161 struct ClientSocket *client;
162 for(client = getBots(SOCKET_FLAG_READY, NULL); client; client = getBots(SOCKET_FLAG_READY, client)) {
163 if(client->user == target) {
164 if(client->botid != BOTID) return;
168 if(!client) return; //we got the message but we have no client that could receive it???
169 if(user->flags & USERFLAG_ISAUTHED) {
170 neonhelp_event_privmsg_async(client, user, target, message);
172 struct neonhelp_event_privmsg_cache *cache = malloc(sizeof(*cache));
174 cache->client = client;
176 cache->target = target;
177 cache->message = strdup(message);
178 get_userauth(user, neonhelp_event_privmsg_nick_lookup, cache);
182 static USERAUTH_CALLBACK(neonhelp_event_privmsg_nick_lookup) {
183 struct neonhelp_event_privmsg_cache *cache = data;
184 neonhelp_event_privmsg_async(cache->client, cache->user, cache->target, cache->message);
185 free(cache->message);
189 static TIMEQ_CALLBACK(neonhelp_remind_open_requests);
191 static void neonhelp_event_privmsg_async(struct ClientSocket *client, struct UserNode *user, struct UserNode *target, char *message) {
194 printf_mysql_query("SELECT `helpserv_support`, `helpserv_public`, `helpserv_intern`, `helpserv_intern_announce` FROM `helpserv_settings` WHERE `helpserv_botid` = '%d'", client->clientid);
196 if (!(row = mysql_fetch_row(res))) return;
197 //check if the user is a supporter (access in the support channel)
198 if((user->flags & USERFLAG_ISAUTHED)) {
201 if(user->flags & USERFLAG_HAS_USERID)
202 userid = user->user_id;
204 printf_mysql_query("SELECT `user_id` FROM `users` WHERE `user_user` = '%s'", escape_string(user->auth));
206 if ((row2 = mysql_fetch_row(res)) != NULL) {
207 userid = atoi(row2[0]);
208 user->user_id = userid;
209 user->flags |= USERFLAG_HAS_USERID;
213 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]));
215 if ((row2 = mysql_fetch_row(res)) != NULL) {
216 int cflags = atoi(row2[1]);
217 if(!(cflags & DB_CHANUSER_SUSPENDED))
218 caccess = atoi(row2[0]);
220 if(caccess) return; //ignore messages from supporters
222 //check if the user is in one of the bot's channels
223 struct ChanUser *chanuser;
224 struct ChanNode *chan;
225 for(chanuser = getUserChannels(target, NULL); chanuser; chanuser = getUserChannels(target, chanuser)) {
226 chan = chanuser->chan;
227 if((!stricmp(chan->name, row[0]) || (row[1] && !stricmp(chan->name, row[1]))) && isUserOnChan(user, chan))
232 reply(client, user, "NH_NOT_ON_CHAN_2", row[0], row[1]);
234 reply(client, user, "NH_NOT_ON_CHAN_1", row[0]);
237 //check if there is already a support request
239 if(client->flags & SOCKET_HAVE_HELPNODE) {
240 struct NeonHelpNode *helpnode;
241 for(helpnode = client->botclass_helpnode; helpnode; helpnode = helpnode->next) {
242 if(helpnode->user == user) {
243 //simply append the message to the database
244 printf_mysql_query("SELECT `text` FROM `helpserv_requests` WHERE `id` = %d", helpnode->suppid);
246 if ((row2 = mysql_fetch_row(res)) != NULL) {
247 char *old_msg = escape_string(row2[0]);
248 char *new_msg = escape_string(message);
249 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);
257 struct NeonHelpNode *helpnode = malloc(sizeof(*helpnode));
258 if(!helpnode) return;
259 helpnode->user = user;
260 helpnode->logchan = getChanByName(row[0]);
261 helpnode->status = 0;
262 helpnode->announce = (row[2] && strcmp(row[3], "0") ? 1 : 0);
263 if(helpnode->announce) {
265 sprintf(nameBuf, "neonhelp_%d", client->clientid);
266 if(!timeq_name_exists(nameBuf)) {
267 int *cidptr = malloc(sizeof(int));
268 *cidptr = client->clientid;
269 timeq_add_name(nameBuf, 300, neonhelp_remind_open_requests, cidptr);
272 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));
273 helpnode->suppid = (int) mysql_insert_id(get_mysql_conn());
274 helpnode->log = NULL;
275 helpnode->next = ((client->flags & SOCKET_HAVE_HELPNODE) ? client->botclass_helpnode : NULL);
276 client->botclass_helpnode = helpnode;
277 client->flags |= SOCKET_HAVE_HELPNODE;
278 //build the user reply...
279 char user_reply[MAXLEN];
280 int user_reply_pos = 0;
281 char reply_buff[MAXLEN];
282 //1st part: NH_REQUEST_RECORDED
283 strcpy(user_reply + user_reply_pos, build_language_string(user, reply_buff, "NH_REQUEST_RECORDED", helpnode->suppid));
284 user_reply_pos += strlen(reply_buff);
285 //2nd part: NH_REQUEST_OTHERS_0 / NH_REQUEST_OTHERS_1 / NH_REQUEST_OTHERS_2
286 user_reply[user_reply_pos++] = ' ';
288 strcpy(user_reply + user_reply_pos, build_language_string(user, reply_buff, (others ? "NH_REQUEST_OTHERS_1" : "NH_REQUEST_OTHERS_0")));
290 strcpy(user_reply + user_reply_pos, build_language_string(user, reply_buff, "NH_REQUEST_OTHERS_2", others));
291 user_reply_pos += strlen(reply_buff);
292 //3th part: NH_REQUEST_FOOTER_1 / NH_REQUEST_FOOTER_2
293 user_reply[user_reply_pos++] = ' ';
295 strcpy(user_reply + user_reply_pos, build_language_string(user, reply_buff, "NH_REQUEST_FOOTER_2", row[0], row[1]));
297 strcpy(user_reply + user_reply_pos, build_language_string(user, reply_buff, "NH_REQUEST_FOOTER_1", row[0]));
298 user_reply_pos += strlen(reply_buff);
299 reply(client, user, "%s", user_reply);
300 //sent a message to the internal channel / onotice to supp channel
301 build_language_string(user, reply_buff, "NH_NEW_REQUEST", helpnode->suppid, user->nick, message);
303 putsock(client, "PRIVMSG %s :%s", row[2], reply_buff);
305 putsock(client, "NOTICE @%s :%s", row[0], reply_buff);
309 static TIMEQ_CALLBACK(neonhelp_remind_open_requests) {
310 int clientid = *((int*)data);
313 printf_mysql_query("SELECT `helpserv_support`, `helpserv_public`, `helpserv_intern`, `helpserv_intern_announce` FROM `helpserv_settings` WHERE `helpserv_botid` = '%d'", clientid);
315 if (!(row = mysql_fetch_row(res)) || !row[2]) {
319 struct ClientSocket *client;
320 for(client = getBots(SOCKET_FLAG_READY, NULL); client; client = getBots(SOCKET_FLAG_READY, client)) {
321 if(client->clientid == clientid)
328 //count open requests
330 struct NeonHelpNode *helpnode;
331 if(client->flags & SOCKET_HAVE_HELPNODE) {
332 for(helpnode = client->botclass_helpnode; helpnode; helpnode = helpnode->next) {
333 if(helpnode->status == 0) {
340 sprintf(nameBuf, "neonhelp_%d", client->clientid);
341 if(!timeq_name_exists(nameBuf)) {
342 timeq_add_name(nameBuf, 300, neonhelp_remind_open_requests, data);
344 char replybuf[MAXLEN];
345 build_language_string(NULL, replybuf, (requests == 1 ? "NH_REMIND_OPEN_REQUESTS_1" : "NH_REMIND_OPEN_REQUESTS_2"), requests);
346 putsock(client, "PRIVMSG %s :%s", row[2], replybuf);
351 static void neonhelp_event_chanmsg(struct UserNode *user, struct ChanNode *chan, char *message) {
352 char logline[MAXLEN];
353 sprintf(logline, "<%s> %s", user->nick, message);
354 struct ClientSocket *client;
355 for(client = getBots(SOCKET_FLAG_READY, NULL); client; client = getBots(SOCKET_FLAG_READY, client)) {
356 if(client->botid == BOTID) {
357 struct NeonHelpNode *helpnode;
358 if(client->flags & SOCKET_HAVE_HELPNODE) {
359 for(helpnode = client->botclass_helpnode; helpnode; helpnode = helpnode->next) {
360 if(helpnode->logchan == chan && helpnode->status == 1) {
362 helpnode->log = calloc(LOGBUFFERLINES, sizeof(char*));
363 if(!helpnode->log) return;
366 for(i = 0; i < LOGBUFFERLINES; i++) {
367 if(!helpnode->log[i]) {
368 helpnode->log[i] = strdup(logline);
372 if(i == LOGBUFFERLINES) {
373 //write buffer to database
374 char logbuff[MAXLEN * LOGBUFFERLINES];
376 for(i = 0; i < LOGBUFFERLINES; i++) {
377 len += sprintf(logbuff + len, "%s\n", helpnode->log[i]);
378 free(helpnode->log[i]);
379 helpnode->log[i] = NULL;
381 printf_long_mysql_query(1024 + len, "UPDATE `helpserv_requests` SET `log` = CONCAT(`log`, '%s') WHERE `id` = %d", escape_string(logbuff), helpnode->suppid);
391 static void destroy_support_request(struct ClientSocket *client, struct NeonHelpNode *helpnode, int do_reply) {
392 //write buffer to database
393 char logbuff[MAXLEN * LOGBUFFERLINES];
397 for(i = 0; i < LOGBUFFERLINES; i++) {
398 if(!helpnode->log[i]) break;
399 len += sprintf(logbuff + len, "%s\n", helpnode->log[i]);
400 free(helpnode->log[i]);
401 helpnode->log[i] = NULL;
406 printf_long_mysql_query(1024 + len, "UPDATE `helpserv_requests` SET `status`='2', `log` = CONCAT(`log`, '%s') WHERE `id` = %d", escape_string(logbuff), helpnode->suppid);
408 reply(client, helpnode->user, "NH_DELETED", helpnode->suppid);
413 static void neonhelp_event_kick(struct UserNode *user, struct ChanUser *target, char *reason) {
414 struct ClientSocket *client;
417 struct ChanNode *support, *public;
419 for(client = getBots(SOCKET_FLAG_READY, NULL); client; client = getBots(SOCKET_FLAG_READY, client)) {
420 if(client->botid == BOTID && isUserOnChan(client->user, target->chan)) {
422 struct NeonHelpNode *helpnode, *prev_helpnode = NULL;
423 if(client->flags & SOCKET_HAVE_HELPNODE) {
424 for(helpnode = client->botclass_helpnode; helpnode; helpnode = helpnode->next) {
425 if(helpnode->user == target->user) {
429 prev_helpnode = helpnode;
432 if(!userHasRequest) continue;
433 printf_mysql_query("SELECT `helpserv_support`, `helpserv_public`, `helpserv_intern` FROM `helpserv_settings` WHERE `helpserv_botid` = '%d'", client->clientid);
435 if (!(row = mysql_fetch_row(res))) continue;
436 support = getChanByName(row[0]);
437 public = (row[1] ? getChanByName(row[1]) : NULL);
438 if(target->chan == support || !((support && isUserOnChan(target->user, support)) || (public && isUserOnChan(target->user, public)))) {
439 //free the user's support request
441 prev_helpnode->next = helpnode->next;
443 client->botclass_helpnode = helpnode->next;
444 destroy_support_request(client, helpnode, 1);
450 static void neonhelp_event_part(struct ChanUser *target, char *reason) {
451 struct ClientSocket *client;
454 struct ChanNode *support, *public;
456 for(client = getBots(SOCKET_FLAG_READY, NULL); client; client = getBots(SOCKET_FLAG_READY, client)) {
457 if(client->botid == BOTID && isUserOnChan(client->user, target->chan)) {
459 struct NeonHelpNode *helpnode, *prev_helpnode = NULL;
460 if(client->flags & SOCKET_HAVE_HELPNODE) {
461 for(helpnode = client->botclass_helpnode; helpnode; helpnode = helpnode->next) {
462 if(helpnode->user == target->user) {
466 prev_helpnode = helpnode;
469 if(!userHasRequest) continue;
470 printf_mysql_query("SELECT `helpserv_support`, `helpserv_public`, `helpserv_intern` FROM `helpserv_settings` WHERE `helpserv_botid` = '%d'", client->clientid);
472 if (!(row = mysql_fetch_row(res))) continue;
473 support = getChanByName(row[0]);
474 public = (row[1] ? getChanByName(row[1]) : NULL);
475 if(target->chan == support || !((support && isUserOnChan(target->user, support)) || (public && isUserOnChan(target->user, public)))) {
476 //free the user's support request
478 prev_helpnode->next = helpnode->next;
480 client->botclass_helpnode = helpnode->next;
481 destroy_support_request(client, helpnode, 1);
487 static void neonhelp_event_quit(struct UserNode *target, char *reason) {
488 struct ClientSocket *client;
490 for(client = getBots(SOCKET_FLAG_READY, NULL); client; client = getBots(SOCKET_FLAG_READY, client)) {
491 if(client->botid == BOTID) {
493 struct NeonHelpNode *helpnode, *prev_helpnode = NULL;
494 if(client->flags & SOCKET_HAVE_HELPNODE) {
495 for(helpnode = client->botclass_helpnode; helpnode; helpnode = helpnode->next) {
496 if(helpnode->user == target) {
500 prev_helpnode = helpnode;
503 if(!userHasRequest) continue;
504 //free the user's support request
506 prev_helpnode->next = helpnode->next;
508 client->botclass_helpnode = helpnode->next;
509 destroy_support_request(client, helpnode, 0);
514 void init_NeonHelp(int type) {
515 set_bot_alias(BOTID, BOTALIAS);
518 if(type == MODSTATE_REBIND) return;
521 bind_bot_ready(neonhelp_bot_ready);
522 bind_privmsg(neonhelp_event_privmsg);
523 bind_chanmsg(neonhelp_event_chanmsg);
524 bind_part(neonhelp_event_part);
525 bind_kick(neonhelp_event_kick);
526 bind_quit(neonhelp_event_quit);
528 set_trigger_callback(BOTID, neonhelp_trigger_callback);
530 register_default_language_table(msgtab);
533 void loop_NeonHelp() {
537 void free_NeonHelp(int type) {
538 unbind_allcmd(BOTID);
539 if(type == MODSTATE_STARTSTOP) {
540 //disconnect all our bots
541 struct ClientSocket *client;
542 for(client = getBots(0, NULL); client; client = getBots(0, client)) {
543 if(client->botid == BOTID) {
544 unbind_botwise_allcmd(0, client->clientid);
545 close_socket(client);