1 /* global.c - Global notice service
2 * Copyright 2000-2004 srvx Development Team
4 * This file is part of x3.
6 * srvx 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.
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.
16 * You should have received a copy of the GNU General Public License
17 * along with srvx; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
28 #define GLOBAL_CONF_NAME "services/global"
30 #define GLOBAL_DB "global.db"
31 #define GLOBAL_TEMP_DB "global.db.new"
34 #define KEY_DB_BACKUP_FREQ "db_backup_freq"
35 #define KEY_ANNOUNCEMENTS_DEFAULT "announcements_default"
36 #define KEY_NICK "nick"
39 #define KEY_FLAGS "flags"
40 #define KEY_POSTED "posted"
41 #define KEY_DURATION "duration"
42 #define KEY_FROM "from"
43 #define KEY_MESSAGE "message"
45 /* Clarification: Notices are immediate, they are sent to matching users
46 _once_, then forgotten. Messages are stored in Global's database and
47 continually sent to users as they match the target specification until
49 static const struct message_entry msgtab
[] = {
50 { "GMSG_INVALID_TARGET", "$b%s$b is an invalid message target." },
51 { "GMSG_MESSAGE_REQUIRED", "You $bmust$b provide a message to send." },
52 { "GMSG_MESSAGE_SENT", "Message to $b%s$b sent." },
53 { "GMSG_MESSAGE_ADDED", "Message to $b%s$b with ID %ld added." },
54 { "GMSG_MESSAGE_DELETED", "Message $b%s$b deleted." },
55 { "GMSG_ID_INVALID", "$b%s$b is an invalid message ID." },
56 { "GMSG_MESSAGE_COUNT", "$b%d$b messages found." },
57 { "GMSG_NO_MESSAGES", "There are no messages for you." },
58 { "GMSG_NOTICE_SOURCE", "[$b%s$b] Notice from %s:" },
59 { "GMSG_MESSAGE_SOURCE", "[$b%s$b] Notice from %s, posted %s:" },
60 { "GMSG_MOTD_HEADER", "$b------------- MESSAGE(S) OF THE DAY --------------$b" },
61 { "GMSG_MOTD_FOOTER", "$b---------- END OF MESSAGE(S) OF THE DAY ----------$b" },
65 #define GLOBAL_SYNTAX() svccmd_send_help(user, global, cmd)
66 #define GLOBAL_FUNC(NAME) MODCMD_FUNC(NAME)
68 struct userNode
*global
;
70 static struct module *global_module
;
71 static struct service
*global_service
;
72 static struct globalMessage
*messageList
;
73 static long messageCount
;
74 static time_t last_max_alert
;
75 static struct log_type
*G_LOG
;
79 unsigned long db_backup_frequency
;
80 unsigned int announcements_default
: 1;
83 #define global_notice(target, format...) send_message(target , global , ## format)
85 void message_expire(void *data
);
87 static struct globalMessage
*
88 message_add(long flags
, time_t posted
, unsigned long duration
, char *from
, const char *msg
)
90 struct globalMessage
*message
;
92 message
= malloc(sizeof(struct globalMessage
));
99 message
->id
= messageCount
++;
100 message
->flags
= flags
;
101 message
->posted
= posted
;
102 message
->duration
= duration
;
103 message
->from
= strdup(from
);
104 message
->message
= strdup(msg
);
108 messageList
->prev
= message
;
111 message
->prev
= NULL
;
112 message
->next
= messageList
;
114 messageList
= message
;
118 timeq_add(now
+ duration
, message_expire
, message
);
125 message_del(struct globalMessage
*message
)
127 if(message
->duration
)
129 timeq_del(0, NULL
, message
, TIMEQ_IGNORE_FUNC
| TIMEQ_IGNORE_WHEN
);
132 if(message
->prev
) message
->prev
->next
= message
->next
;
133 else messageList
= message
->next
;
135 if(message
->next
) message
->next
->prev
= message
->prev
;
138 free(message
->message
);
142 void message_expire(void *data
)
144 struct globalMessage
*message
= data
;
146 message
->duration
= 0;
147 message_del(message
);
150 static struct globalMessage
*
151 message_create(struct userNode
*user
, unsigned int argc
, char *argv
[])
153 unsigned long duration
= 0;
158 for(i
= 0; i
< argc
; i
++)
162 global_notice(user
, "MSG_MISSING_PARAMS", argv
[argc
]);
166 if(!irccasecmp(argv
[i
], "text"))
169 text
= unsplit_string(argv
+ i
, argc
- i
, NULL
);
171 } else if (!irccasecmp(argv
[i
], "sourceless")) {
173 flags
|= MESSAGE_OPTION_SOURCELESS
;
174 } else if (!irccasecmp(argv
[i
], "target")) {
177 if(!irccasecmp(argv
[i
], "all")) {
178 flags
|= MESSAGE_RECIPIENT_ALL
;
179 } else if(!irccasecmp(argv
[i
], "users")) {
180 flags
|= MESSAGE_RECIPIENT_LUSERS
;
181 } else if(!irccasecmp(argv
[i
], "helpers")) {
182 flags
|= MESSAGE_RECIPIENT_HELPERS
;
183 } else if(!irccasecmp(argv
[i
], "opers")) {
184 flags
|= MESSAGE_RECIPIENT_OPERS
;
185 } else if(!irccasecmp(argv
[i
], "staff") || !irccasecmp(argv
[i
], "privileged")) {
186 flags
|= MESSAGE_RECIPIENT_STAFF
;
187 } else if(!irccasecmp(argv
[i
], "channels")) {
188 flags
|= MESSAGE_RECIPIENT_CHANNELS
;
189 } else if(!irccasecmp(argv
[i
], "announcement") || !irccasecmp(argv
[i
], "announce")) {
190 flags
|= MESSAGE_RECIPIENT_ANNOUNCE
;
192 global_notice(user
, "GMSG_INVALID_TARGET", argv
[i
]);
195 } else if (irccasecmp(argv
[i
], "duration") == 0) {
196 duration
= ParseInterval(argv
[++i
]);
198 global_notice(user
, "MSG_INVALID_CRITERIA", argv
[i
]);
205 flags
= MESSAGE_RECIPIENT_LUSERS
;
209 global_notice(user
, "GMSG_MESSAGE_REQUIRED");
213 return message_add(flags
, now
, duration
, user
->handle_info
->handle
, text
);
217 messageType(const struct globalMessage
*message
)
219 if((message
->flags
& MESSAGE_RECIPIENT_ALL
) == MESSAGE_RECIPIENT_ALL
)
223 if((message
->flags
& MESSAGE_RECIPIENT_STAFF
) == MESSAGE_RECIPIENT_STAFF
)
227 else if(message
->flags
& MESSAGE_RECIPIENT_ANNOUNCE
)
229 return "announcement";
231 else if(message
->flags
& MESSAGE_RECIPIENT_OPERS
)
235 else if(message
->flags
& MESSAGE_RECIPIENT_HELPERS
)
239 else if(message
->flags
& MESSAGE_RECIPIENT_LUSERS
)
250 notice_target(const char *target
, struct globalMessage
*message
)
252 if(!(message
->flags
& MESSAGE_OPTION_SOURCELESS
))
254 if(message
->flags
& MESSAGE_OPTION_IMMEDIATE
)
256 send_target_message(0, target
, global
, "GMSG_NOTICE_SOURCE", messageType(message
), message
->from
);
263 localtime_r(&message
->posted
, &tm
);
264 strftime(posted
, sizeof(posted
), "%I:%M %p, %m/%d/%Y", &tm
);
265 send_target_message(0, target
, global
, "GMSG_MESSAGE_SOURCE", messageType(message
), message
->from
, posted
);
269 send_target_message(4, target
, global
, "%s", message
->message
);
273 notice_channel(const char *key
, void *data
, void *extra
)
275 struct chanNode
*channel
= data
;
276 /* It should be safe to assume channel is not NULL. */
277 if(channel
->channel_info
)
278 notice_target(key
, extra
);
283 message_send(struct globalMessage
*message
)
285 struct userNode
*user
;
289 if(message
->flags
& MESSAGE_RECIPIENT_CHANNELS
)
291 dict_foreach(channels
, notice_channel
, message
);
294 if(message
->flags
& MESSAGE_RECIPIENT_LUSERS
)
296 notice_target("$*", message
);
300 if(message
->flags
& MESSAGE_RECIPIENT_ANNOUNCE
)
304 for (it
= dict_first(clients
); it
; it
= iter_next(it
)) {
305 user
= iter_data(it
);
306 if (user
->uplink
== self
) continue;
307 announce
= user
->handle_info
? user
->handle_info
->announcements
: '?';
308 if (announce
== 'n') continue;
309 if ((announce
== '?') && !global_conf
.announcements_default
) continue;
310 notice_target(user
->nick
, message
);
314 if(message
->flags
& MESSAGE_RECIPIENT_OPERS
)
316 for(n
= 0; n
< curr_opers
.used
; n
++)
318 user
= curr_opers
.list
[n
];
320 if(user
->uplink
!= self
)
322 notice_target(user
->nick
, message
);
327 if(message
->flags
& MESSAGE_RECIPIENT_HELPERS
)
329 for(n
= 0; n
< curr_helpers
.used
; n
++)
331 user
= curr_helpers
.list
[n
];
334 notice_target(user
->nick
, message
);
340 global_message(long targets
, char *text
)
342 struct globalMessage
*message
;
344 if(!targets
|| !global
)
347 message
= message_add(targets
| MESSAGE_OPTION_SOURCELESS
, now
, 0, "", text
);
351 message_send(message
);
352 message_del(message
);
355 static GLOBAL_FUNC(cmd_notice
)
357 struct globalMessage
*message
= NULL
;
358 const char *recipient
= NULL
, *text
;
362 if(!irccasecmp(argv
[1], "all")) {
363 target
= MESSAGE_RECIPIENT_ALL
;
364 } else if(!irccasecmp(argv
[1], "users")) {
365 target
= MESSAGE_RECIPIENT_LUSERS
;
366 } else if(!irccasecmp(argv
[1], "helpers")) {
367 target
= MESSAGE_RECIPIENT_HELPERS
;
368 } else if(!irccasecmp(argv
[1], "opers")) {
369 target
= MESSAGE_RECIPIENT_OPERS
;
370 } else if(!irccasecmp(argv
[1], "staff") || !irccasecmp(argv
[1], "privileged")) {
371 target
|= MESSAGE_RECIPIENT_HELPERS
| MESSAGE_RECIPIENT_OPERS
;
372 } else if(!irccasecmp(argv
[1], "announcement") || !irccasecmp(argv
[1], "announce")) {
373 target
|= MESSAGE_RECIPIENT_ANNOUNCE
;
374 } else if(!irccasecmp(argv
[1], "channels")) {
375 target
= MESSAGE_RECIPIENT_CHANNELS
;
377 global_notice(user
, "GMSG_INVALID_TARGET", argv
[1]);
381 text
= unsplit_string(argv
+ 2, argc
- 2, NULL
);
382 message
= message_add(target
| MESSAGE_OPTION_IMMEDIATE
, now
, 0, user
->handle_info
->handle
, text
);
389 recipient
= messageType(message
);
391 message_send(message
);
392 message_del(message
);
394 global_notice(user
, "GMSG_MESSAGE_SENT", recipient
);
398 static GLOBAL_FUNC(cmd_message
)
400 struct globalMessage
*message
= NULL
;
401 const char *recipient
= NULL
;
404 message
= message_create(user
, argc
- 1, argv
+ 1);
407 recipient
= messageType(message
);
408 global_notice(user
, "GMSG_MESSAGE_ADDED", recipient
, message
->id
);
412 static GLOBAL_FUNC(cmd_list
)
414 struct globalMessage
*message
;
415 struct helpfile_table table
;
416 unsigned int length
, nn
;
420 global_notice(user
, "GMSG_NO_MESSAGES");
424 for(nn
=0, message
= messageList
; message
; nn
++, message
=message
->next
) ;
427 table
.flags
= TABLE_NO_FREE
;
428 table
.contents
= calloc(table
.length
, sizeof(char**));
429 table
.contents
[0] = calloc(table
.width
, sizeof(char*));
430 table
.contents
[0][0] = "ID";
431 table
.contents
[0][1] = "Target";
432 table
.contents
[0][2] = "Expires";
433 table
.contents
[0][3] = "From";
434 table
.contents
[0][4] = "Message";
436 for(nn
=1, message
= messageList
; message
; nn
++, message
= message
->next
)
440 table
.contents
[nn
] = calloc(table
.width
, sizeof(char*));
441 snprintf(buffer
, sizeof(buffer
), "%lu", message
->id
);
442 table
.contents
[nn
][0] = strdup(buffer
);
443 table
.contents
[nn
][1] = messageType(message
);
444 if(message
->duration
)
445 intervalString(buffer
, message
->posted
+ message
->duration
- now
, user
->handle_info
);
447 strcpy(buffer
, "Never.");
448 table
.contents
[nn
][2] = strdup(buffer
);
449 table
.contents
[nn
][3] = message
->from
;
450 length
= strlen(message
->message
);
451 safestrncpy(buffer
, message
->message
, sizeof(buffer
));
452 if(length
> (sizeof(buffer
) - 4))
454 buffer
[sizeof(buffer
) - 1] = 0;
455 buffer
[sizeof(buffer
) - 2] = buffer
[sizeof(buffer
) - 3] = buffer
[sizeof(buffer
) - 4] = '.';
457 table
.contents
[nn
][4] = strdup(buffer
);
459 table_send(global
, user
->nick
, 0, NULL
, table
);
460 for (nn
=1; nn
<table
.length
; nn
++)
462 free((char*)table
.contents
[nn
][0]);
463 free((char*)table
.contents
[nn
][2]);
464 free((char*)table
.contents
[nn
][4]);
465 free(table
.contents
[nn
]);
467 free(table
.contents
[0]);
468 free(table
.contents
);
473 static GLOBAL_FUNC(cmd_remove
)
475 struct globalMessage
*message
= NULL
;
479 id
= strtoul(argv
[1], NULL
, 0);
481 for(message
= messageList
; message
; message
= message
->next
)
483 if(message
->id
== id
)
485 message_del(message
);
486 global_notice(user
, "GMSG_MESSAGE_DELETED", argv
[1]);
491 global_notice(user
, "GMSG_ID_INVALID", argv
[1]);
496 send_messages(struct userNode
*user
, long mask
, int obstreperize
)
498 struct globalMessage
*message
= messageList
;
499 unsigned int count
= 0;
503 if(message
->flags
& mask
)
505 if (obstreperize
&& !count
)
506 send_target_message(0, user
->nick
, global
, "GMSG_MOTD_HEADER");
507 notice_target(user
->nick
, message
);
511 message
= message
->next
;
513 if (obstreperize
&& count
)
514 send_target_message(0, user
->nick
, global
, "GMSG_MOTD_FOOTER");
518 static GLOBAL_FUNC(cmd_messages
)
520 long mask
= MESSAGE_RECIPIENT_LUSERS
| MESSAGE_RECIPIENT_CHANNELS
;
524 mask
|= MESSAGE_RECIPIENT_OPERS
;
527 mask
|= MESSAGE_RECIPIENT_HELPERS
;
529 count
= send_messages(user
, mask
, 0);
531 global_notice(user
, "GMSG_MESSAGE_COUNT", count
);
533 global_notice(user
, "GMSG_NO_MESSAGES");
539 global_process_user(struct userNode
*user
)
541 if(IsLocal(user
) || self
->uplink
->burst
|| user
->uplink
->burst
)
543 send_messages(user
, MESSAGE_RECIPIENT_LUSERS
, 1);
545 /* only alert on new usercount if the record was broken in the last
546 * 30 seconds, and no alert had been sent in that time.
548 if((now
- max_clients_time
) <= 30 && (now
- last_max_alert
) > 30)
551 message
= alloca(36);
552 sprintf(message
, "New user count record: %d", max_clients
);
553 global_message(MESSAGE_RECIPIENT_OPERS
, message
);
554 last_max_alert
= now
;
561 global_process_auth(struct userNode
*user
, UNUSED_ARG(struct handle_info
*old_handle
))
564 send_messages(user
, MESSAGE_RECIPIENT_HELPERS
, 0);
568 global_process_oper(struct userNode
*user
)
570 if(user
->uplink
->burst
)
572 send_messages(user
, MESSAGE_RECIPIENT_OPERS
, 0);
576 global_conf_read(void)
581 if (!(conf_node
= conf_get_data(GLOBAL_CONF_NAME
, RECDB_OBJECT
))) {
582 log_module(G_LOG
, LOG_ERROR
, "config node `%s' is missing or has wrong type.", GLOBAL_CONF_NAME
);
586 str
= database_get_data(conf_node
, KEY_DB_BACKUP_FREQ
, RECDB_QSTRING
);
587 global_conf
.db_backup_frequency
= str
? ParseInterval(str
) : 7200;
588 str
= database_get_data(conf_node
, KEY_ANNOUNCEMENTS_DEFAULT
, RECDB_QSTRING
);
589 global_conf
.announcements_default
= str
? enabled_string(str
) : 1;
591 str
= database_get_data(conf_node
, KEY_NICK
, RECDB_QSTRING
);
593 NickChange(global
, str
, 0);
597 global_saxdb_read(struct dict
*db
)
599 struct record_data
*hir
;
602 unsigned long duration
;
603 char *str
, *from
, *message
;
606 for(it
=dict_first(db
); it
; it
=iter_next(it
))
609 if(hir
->type
!= RECDB_OBJECT
)
611 log_module(G_LOG
, LOG_WARNING
, "Unexpected rectype %d for %s.", hir
->type
, iter_key(it
));
615 str
= database_get_data(hir
->d
.object
, KEY_FLAGS
, RECDB_QSTRING
);
616 flags
= str
? strtoul(str
, NULL
, 0) : 0;
618 str
= database_get_data(hir
->d
.object
, KEY_POSTED
, RECDB_QSTRING
);
619 posted
= str
? strtoul(str
, NULL
, 0) : 0;
621 str
= database_get_data(hir
->d
.object
, KEY_DURATION
, RECDB_QSTRING
);
622 duration
= str
? strtoul(str
, NULL
, 0) : 0;
624 from
= database_get_data(hir
->d
.object
, KEY_FROM
, RECDB_QSTRING
);
625 message
= database_get_data(hir
->d
.object
, KEY_MESSAGE
, RECDB_QSTRING
);
627 message_add(flags
, posted
, duration
, from
, message
);
633 global_saxdb_write(struct saxdb_context
*ctx
)
635 struct globalMessage
*message
;
638 for(message
= messageList
; message
; message
= message
->next
) {
639 snprintf(str
, sizeof(str
), "%li", message
->id
);
640 saxdb_start_record(ctx
, str
, 0);
641 saxdb_write_int(ctx
, KEY_FLAGS
, message
->flags
);
642 saxdb_write_int(ctx
, KEY_POSTED
, message
->posted
);
643 saxdb_write_int(ctx
, KEY_DURATION
, message
->duration
);
644 saxdb_write_string(ctx
, KEY_FROM
, message
->from
);
645 saxdb_write_string(ctx
, KEY_MESSAGE
, message
->message
);
646 saxdb_end_record(ctx
);
652 global_db_cleanup(void)
655 message_del(messageList
);
659 init_global(const char *nick
)
661 G_LOG
= log_register_type("Global", "file:global.log");
662 reg_new_user_func(global_process_user
);
663 reg_auth_func(global_process_auth
);
664 reg_oper_func(global_process_oper
);
666 conf_register_reload(global_conf_read
);
668 global_module
= module_register("Global", G_LOG
, "global.help", NULL
);
669 modcmd_register(global_module
, "LIST", cmd_list
, 1, 0, "flags", "+oper", NULL
);
670 modcmd_register(global_module
, "MESSAGE", cmd_message
, 3, MODCMD_REQUIRE_AUTHED
, "flags", "+oper", NULL
);
671 modcmd_register(global_module
, "MESSAGES", cmd_messages
, 1, 0, NULL
);
672 modcmd_register(global_module
, "NOTICE", cmd_notice
, 3, MODCMD_REQUIRE_AUTHED
, "flags", "+oper", NULL
);
673 modcmd_register(global_module
, "REMOVE", cmd_remove
, 2, MODCMD_REQUIRE_AUTHED
, "flags", "+oper", NULL
);
677 const char *modes
= conf_get_data("services/global/modes", RECDB_QSTRING
);
678 global
= AddService(nick
, modes
? modes
: NULL
, "Global Services", NULL
);
679 global_service
= service_register(global
);
681 saxdb_register("Global", global_saxdb_read
, global_saxdb_write
);
682 reg_exit_func(global_db_cleanup
);
683 message_register_table(msgtab
);