1 /* global.c - Global notice service
2 * Copyright 2000-2004 srvx Development Team
4 * This file is part of x3.
6 * x3 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.
29 #define GLOBAL_CONF_NAME "services/global"
31 #define GLOBAL_DB "global.db"
32 #define GLOBAL_TEMP_DB "global.db.new"
35 #define KEY_DB_BACKUP_FREQ "db_backup_freq"
36 #define KEY_ANNOUNCEMENTS_DEFAULT "announcements_default"
37 #define KEY_NICK "nick"
40 #define KEY_FLAGS "flags"
41 #define KEY_POSTED "posted"
42 #define KEY_DURATION "duration"
43 #define KEY_FROM "from"
44 #define KEY_MESSAGE "message"
46 /* Clarification: Notices are immediate, they are sent to matching users
47 _once_, then forgotten. Messages are stored in Global's database and
48 continually sent to users as they match the target specification until
50 static const struct message_entry msgtab
[] = {
51 { "GMSG_INVALID_TARGET", "$b%s$b is an invalid message target." },
52 { "GMSG_MESSAGE_REQUIRED", "You $bmust$b provide a message to send." },
53 { "GMSG_MESSAGE_SENT", "Message to $b%s$b sent." },
54 { "GMSG_MESSAGE_ADDED", "Message to $b%s$b with ID %ld added." },
55 { "GMSG_MESSAGE_DELETED", "Message $b%s$b deleted." },
56 { "GMSG_ID_INVALID", "$b%s$b is an invalid message ID." },
57 { "GMSG_MESSAGE_COUNT", "$b%d$b messages found." },
58 { "GMSG_NO_MESSAGES", "There are no messages for you." },
59 { "GMSG_NOTICE_SOURCE", "Notice to [$b%s$b] from %s:" },
60 { "GMSG_MESSAGE_SOURCE", "Notice to [$b%s$b] from %s, posted %s:" },
61 //{ "GMSG_MOTD_HEADER", "$b------------- MESSAGE(S) OF THE DAY --------------$b" },
62 { "GMSG_MOTD_HEADER", "$bNetwork Announcements$b" },
63 { "GMSG_MOTD_BAR", "---------------------------------------" },
64 { "GMSG_MOTD_FOOTER", "--------------- Thank You--------------" },
66 /* These definitions are for other files that make use of global
67 * notices. Make sure you grep for them if you ever add args
71 { "CSMSG_REGISTERED_TO", "%s registered to %s by %s." },
72 { "CSMSG_CHANNEL_MOVED", "%s moved to %s by %s." },
73 { "CSMSG_SUSPENSION_MODIFIED", "%s suspension modified by %s." },
74 { "CSMSG_SUSPENDED_BY", "%s suspended by %s." },
75 { "CSMSG_UNSUSPENDED_BY", "%s unsuspended by %s." },
76 { "CSMSG_OWNERSHIP_TRANSFERRED", "%s ownership transferred to %s by %s." },
79 { "DEFCON_NETWORK_CHANGED", "Network DefCon level has changed to level %d" },
80 { "DEFCON_OPER_LEVEL_CHANGE", "%s is changing the DefCon level to %d" },
81 { "DEFCON_TIMEOUT_LEVEL_CHANGE", "The DefCon has changed back to level %d (timeout)" },
86 #define GLOBAL_SYNTAX() svccmd_send_help_brief(user, global, cmd)
87 #define GLOBAL_FUNC(NAME) MODCMD_FUNC(NAME)
96 unsigned long duration
;
101 struct globalMessage
*prev
;
102 struct globalMessage
*next
;
105 struct userNode
*global
;
107 static struct module *global_module
;
108 static struct service
*global_service
;
109 static struct globalMessage
*messageList
;
110 extern struct string_list
*autojoin_channels
;
111 static long messageCount
;
112 static time_t last_max_alert
;
113 static struct log_type
*G_LOG
;
117 unsigned long db_backup_frequency
;
118 unsigned int announcements_default
: 1;
121 #define global_notice(target, format...) send_message(target , global , ## format)
123 void message_expire(void *data
);
125 static struct globalMessage
*
126 message_add(long flags
, time_t posted
, unsigned long duration
, char *from
, const char *msg
)
128 struct globalMessage
*message
;
131 message
= malloc(sizeof(struct globalMessage
));
137 message
->id
= messageCount
++;
138 message
->flags
= flags
;
139 message
->posted
= posted
;
140 message
->duration
= duration
;
141 message
->from
= strdup(from
);
142 message
->message
= strdup(msg
);
144 if ((flags
& MESSAGE_OPTION_IMMEDIATE
) == 0) {
145 localtime_r(&message
->posted
, &tm
);
146 strftime(message
->posted_s
, sizeof(message
->posted_s
),
147 "%I:%M %p, %m/%d/%Y", &tm
);
152 messageList
->prev
= message
;
154 message
->prev
= NULL
;
155 message
->next
= messageList
;
157 messageList
= message
;
161 timeq_add(now
+ duration
, message_expire
, message
);
168 message_del(struct globalMessage
*message
)
170 if(message
->duration
)
172 timeq_del(0, NULL
, message
, TIMEQ_IGNORE_FUNC
| TIMEQ_IGNORE_WHEN
);
175 if(message
->prev
) message
->prev
->next
= message
->next
;
176 else messageList
= message
->next
;
178 if(message
->next
) message
->next
->prev
= message
->prev
;
181 free(message
->message
);
185 void message_expire(void *data
)
187 struct globalMessage
*message
= data
;
189 message
->duration
= 0;
190 message_del(message
);
193 static struct globalMessage
*
194 message_create(struct userNode
*user
, unsigned int argc
, char *argv
[])
196 unsigned long duration
= 0;
202 sender
= user
->handle_info
->handle
;
204 for(i
= 0; i
< argc
; i
++)
208 global_notice(user
, "MSG_MISSING_PARAMS", argv
[argc
]);
212 if(!irccasecmp(argv
[i
], "text"))
215 text
= unsplit_string(argv
+ i
, argc
- i
, NULL
);
217 } else if (!irccasecmp(argv
[i
], "sourceless")) {
219 flags
|= MESSAGE_OPTION_SOURCELESS
;
220 } else if (!irccasecmp(argv
[i
], "target")) {
223 if(!irccasecmp(argv
[i
], "all")) {
224 flags
|= MESSAGE_RECIPIENT_ALL
;
225 } else if(!irccasecmp(argv
[i
], "users")) {
226 flags
|= MESSAGE_RECIPIENT_LUSERS
;
227 } else if(!irccasecmp(argv
[i
], "helpers")) {
228 flags
|= MESSAGE_RECIPIENT_HELPERS
;
229 } else if(!irccasecmp(argv
[i
], "opers")) {
230 flags
|= MESSAGE_RECIPIENT_OPERS
;
231 } else if(!irccasecmp(argv
[i
], "staff") || !irccasecmp(argv
[i
], "privileged")) {
232 flags
|= MESSAGE_RECIPIENT_STAFF
;
233 } else if(!irccasecmp(argv
[i
], "channels")) {
234 flags
|= MESSAGE_RECIPIENT_CHANNELS
;
235 } else if(!irccasecmp(argv
[i
], "announcement") || !irccasecmp(argv
[i
], "announce")) {
236 flags
|= MESSAGE_RECIPIENT_ANNOUNCE
;
238 global_notice(user
, "GMSG_INVALID_TARGET", argv
[i
]);
241 } else if (irccasecmp(argv
[i
], "duration") == 0) {
242 duration
= ParseInterval(argv
[++i
]);
243 } else if (irccasecmp(argv
[i
], "from") == 0) {
246 global_notice(user
, "MSG_INVALID_CRITERIA", argv
[i
]);
253 flags
= MESSAGE_RECIPIENT_LUSERS
;
257 global_notice(user
, "GMSG_MESSAGE_REQUIRED");
261 return message_add(flags
, now
, duration
, sender
, text
);
265 messageType(const struct globalMessage
*message
)
267 if((message
->flags
& MESSAGE_RECIPIENT_ALL
) == MESSAGE_RECIPIENT_ALL
)
271 if((message
->flags
& MESSAGE_RECIPIENT_STAFF
) == MESSAGE_RECIPIENT_STAFF
)
275 else if(message
->flags
& MESSAGE_RECIPIENT_ANNOUNCE
)
277 return "announcement";
279 else if(message
->flags
& MESSAGE_RECIPIENT_OPERS
)
283 else if(message
->flags
& MESSAGE_RECIPIENT_HELPERS
)
287 else if(message
->flags
& MESSAGE_RECIPIENT_LUSERS
)
298 notice_target(const char *target
, struct globalMessage
*message
)
300 if(!(message
->flags
& MESSAGE_OPTION_SOURCELESS
))
302 if(message
->flags
& MESSAGE_OPTION_IMMEDIATE
)
304 send_target_message(0, target
, global
, "GMSG_NOTICE_SOURCE", messageType(message
), message
->from
);
308 send_target_message(0, target
, global
, "GMSG_MESSAGE_SOURCE", messageType(message
), message
->from
, message
->posted_s
);
312 send_target_message(4, target
, global
, "%s", message
->message
);
316 notice_channel(const char *key
, void *data
, void *extra
)
318 struct chanNode
*channel
= data
;
319 /* It should be safe to assume channel is not NULL. */
320 if(channel
->channel_info
)
321 notice_target(key
, extra
);
326 message_send(struct globalMessage
*message
)
328 struct userNode
*user
;
332 if(message
->flags
& MESSAGE_RECIPIENT_CHANNELS
)
334 dict_foreach(channels
, notice_channel
, message
);
337 if(message
->flags
& MESSAGE_RECIPIENT_LUSERS
)
339 notice_target("$*", message
);
343 if(message
->flags
& MESSAGE_RECIPIENT_ANNOUNCE
)
347 for (it
= dict_first(clients
); it
; it
= iter_next(it
)) {
348 user
= iter_data(it
);
349 if (user
->uplink
== self
) continue;
350 announce
= user
->handle_info
? user
->handle_info
->announcements
: '?';
351 if (announce
== 'n') continue;
352 if ((announce
== '?') && !global_conf
.announcements_default
) continue;
353 notice_target(user
->nick
, message
);
357 if(message
->flags
& MESSAGE_RECIPIENT_OPERS
)
359 for(n
= 0; n
< curr_opers
.used
; n
++)
361 user
= curr_opers
.list
[n
];
363 if(user
->uplink
!= self
)
365 notice_target(user
->nick
, message
);
370 if(message
->flags
& MESSAGE_RECIPIENT_HELPERS
)
372 for(n
= 0; n
< curr_helpers
.used
; n
++)
374 user
= curr_helpers
.list
[n
];
377 notice_target(user
->nick
, message
);
383 global_message_args(long targets
, const char *language_entry
, ...)
385 struct globalMessage
*message
;
388 char response
[MAXLEN
];
391 if(!targets
|| !global
)
394 fmt
= strdup(language_entry
);
396 /* Notice users/opers/helpers */
397 for (it
= dict_first(clients
); it
; it
= iter_next(it
)) {
398 struct userNode
*luser
= iter_data(it
);
400 language_entry
= user_find_message(luser
, fmt
);
402 va_start(arg_list
, language_entry
);
403 vsnprintf(response
, MAXLEN
-2, language_entry
, arg_list
);
404 response
[MAXLEN
-1] = 0;
406 message
= message_add(targets
| MESSAGE_OPTION_SOURCELESS
, now
, 0, "", response
);
411 if(message
->flags
& MESSAGE_RECIPIENT_OPERS
&& IsOper(luser
)) {
412 if(luser
->uplink
!= self
)
413 notice_target(luser
->nick
, message
);
415 if ((message
->flags
& MESSAGE_RECIPIENT_LUSERS
) || (message
->flags
& MESSAGE_RECIPIENT_HELPERS
))
420 if (message
->flags
& MESSAGE_RECIPIENT_HELPERS
&& IsHelper(luser
)) {
421 notice_target(luser
->nick
, message
);
423 if (message
->flags
& MESSAGE_RECIPIENT_LUSERS
)
428 if (message
->flags
& MESSAGE_RECIPIENT_LUSERS
)
429 notice_target(luser
->nick
, message
);
432 message_del(message
);
436 global_message(long targets
, char *text
)
438 struct globalMessage
*message
;
440 if(!targets
|| !global
)
443 message
= message_add(targets
| MESSAGE_OPTION_SOURCELESS
, now
, 0, "", text
);
447 message_send(message
);
448 message_del(message
);
451 static GLOBAL_FUNC(cmd_notice
)
453 struct globalMessage
*message
= NULL
;
454 const char *recipient
= NULL
, *text
;
459 sender
= user
->handle_info
->handle
;
460 if(!irccasecmp(argv
[1], "all")) {
461 target
= MESSAGE_RECIPIENT_ALL
;
462 } else if(!irccasecmp(argv
[1], "users")) {
463 target
= MESSAGE_RECIPIENT_LUSERS
;
464 } else if(!irccasecmp(argv
[1], "helpers")) {
465 target
= MESSAGE_RECIPIENT_HELPERS
;
466 } else if(!irccasecmp(argv
[1], "opers")) {
467 target
= MESSAGE_RECIPIENT_OPERS
;
468 } else if(!irccasecmp(argv
[1], "staff") || !irccasecmp(argv
[1], "privileged")) {
469 target
|= MESSAGE_RECIPIENT_HELPERS
| MESSAGE_RECIPIENT_OPERS
;
470 } else if(!irccasecmp(argv
[1], "announcement") || !irccasecmp(argv
[1], "announce")) {
471 target
|= MESSAGE_RECIPIENT_ANNOUNCE
;
472 } else if(!irccasecmp(argv
[1], "channels")) {
473 target
= MESSAGE_RECIPIENT_CHANNELS
;
475 global_notice(user
, "GMSG_INVALID_TARGET", argv
[1]);
478 if(!irccasecmp(argv
[2], "from")) {
480 reply("MSG_MISSING_PARAMS", argv
[0]);
485 text
= unsplit_string(argv
+ 4, argc
- 4, NULL
);
487 text
= unsplit_string(argv
+ 2, argc
- 2, NULL
);
490 message
= message_add(target
| MESSAGE_OPTION_IMMEDIATE
, now
, 0, sender
, text
);
494 recipient
= messageType(message
);
495 message_send(message
);
496 message_del(message
);
498 global_notice(user
, "GMSG_MESSAGE_SENT", recipient
);
502 static GLOBAL_FUNC(cmd_message
)
504 struct globalMessage
*message
= NULL
;
505 const char *recipient
= NULL
;
508 message
= message_create(user
, argc
- 1, argv
+ 1);
511 recipient
= messageType(message
);
512 global_notice(user
, "GMSG_MESSAGE_ADDED", recipient
, message
->id
);
516 static GLOBAL_FUNC(cmd_list
)
518 struct globalMessage
*message
;
519 struct helpfile_table table
;
520 unsigned int length
, nn
;
524 global_notice(user
, "GMSG_NO_MESSAGES");
528 for(nn
=0, message
= messageList
; message
; nn
++, message
=message
->next
) ;
531 table
.flags
= TABLE_NO_FREE
;
532 table
.contents
= calloc(table
.length
, sizeof(char**));
533 table
.contents
[0] = calloc(table
.width
, sizeof(char*));
534 table
.contents
[0][0] = "ID";
535 table
.contents
[0][1] = "Target";
536 table
.contents
[0][2] = "Expires";
537 table
.contents
[0][3] = "From";
538 table
.contents
[0][4] = "Message";
540 for(nn
=1, message
= messageList
; message
; nn
++, message
= message
->next
)
544 table
.contents
[nn
] = calloc(table
.width
, sizeof(char*));
545 snprintf(buffer
, sizeof(buffer
), "%lu", message
->id
);
546 table
.contents
[nn
][0] = strdup(buffer
);
547 table
.contents
[nn
][1] = messageType(message
);
548 if(message
->duration
)
549 intervalString(buffer
, message
->posted
+ message
->duration
- now
, user
->handle_info
);
551 strcpy(buffer
, "Never.");
552 table
.contents
[nn
][2] = strdup(buffer
);
553 table
.contents
[nn
][3] = message
->from
;
554 length
= strlen(message
->message
);
555 safestrncpy(buffer
, message
->message
, sizeof(buffer
));
556 if(length
> (sizeof(buffer
) - 4))
558 buffer
[sizeof(buffer
) - 1] = 0;
559 buffer
[sizeof(buffer
) - 2] = buffer
[sizeof(buffer
) - 3] = buffer
[sizeof(buffer
) - 4] = '.';
561 table
.contents
[nn
][4] = strdup(buffer
);
563 table_send(global
, user
->nick
, 0, NULL
, table
);
564 for (nn
=1; nn
<table
.length
; nn
++)
566 free((char*)table
.contents
[nn
][0]);
567 free((char*)table
.contents
[nn
][2]);
568 free((char*)table
.contents
[nn
][4]);
569 free(table
.contents
[nn
]);
571 free(table
.contents
[0]);
572 free(table
.contents
);
577 static GLOBAL_FUNC(cmd_remove
)
579 struct globalMessage
*message
= NULL
;
583 id
= strtoul(argv
[1], NULL
, 0);
585 for(message
= messageList
; message
; message
= message
->next
)
587 if(message
->id
== id
)
589 message_del(message
);
590 global_notice(user
, "GMSG_MESSAGE_DELETED", argv
[1]);
595 global_notice(user
, "GMSG_ID_INVALID", argv
[1]);
600 send_messages(struct userNode
*user
, long mask
, int obstreperize
)
602 struct globalMessage
*message
= messageList
;
603 unsigned int count
= 0;
607 if(message
->flags
& mask
)
609 if (obstreperize
&& !count
)
611 send_target_message(0, user
->nick
, global
, "GMSG_MOTD_HEADER");
612 send_target_message(0, user
->nick
, global
, "GMSG_MOTD_BAR");
614 notice_target(user
->nick
, message
);
618 message
= message
->next
;
620 if (obstreperize
&& count
)
621 send_target_message(0, user
->nick
, global
, "GMSG_MOTD_FOOTER");
625 static GLOBAL_FUNC(cmd_messages
)
627 long mask
= MESSAGE_RECIPIENT_LUSERS
| MESSAGE_RECIPIENT_CHANNELS
;
631 mask
|= MESSAGE_RECIPIENT_OPERS
;
634 mask
|= MESSAGE_RECIPIENT_HELPERS
;
636 count
= send_messages(user
, mask
, 0);
638 global_notice(user
, "GMSG_MESSAGE_COUNT", count
);
640 global_notice(user
, "GMSG_NO_MESSAGES");
646 global_process_user(struct userNode
*user
)
648 if(IsLocal(user
) || self
->uplink
->burst
|| user
->uplink
->burst
)
650 send_messages(user
, MESSAGE_RECIPIENT_LUSERS
, 1);
652 /* only alert on new usercount if the record was broken in the last
653 * 30 seconds, and no alert had been sent in that time.
655 if((now
- max_clients_time
) <= 30 && (now
- last_max_alert
) > 30)
658 message
= alloca(36);
659 sprintf(message
, "New user count record: %d", max_clients
);
660 global_message(MESSAGE_RECIPIENT_OPERS
, message
);
661 last_max_alert
= now
;
668 global_process_auth(struct userNode
*user
, UNUSED_ARG(struct handle_info
*old_handle
))
671 send_messages(user
, MESSAGE_RECIPIENT_HELPERS
, 0);
675 global_process_oper(struct userNode
*user
)
677 if(user
->uplink
->burst
)
679 send_messages(user
, MESSAGE_RECIPIENT_OPERS
, 0);
683 global_conf_read(void)
688 if (!(conf_node
= conf_get_data(GLOBAL_CONF_NAME
, RECDB_OBJECT
))) {
689 log_module(G_LOG
, LOG_ERROR
, "config node `%s' is missing or has wrong type.", GLOBAL_CONF_NAME
);
693 str
= database_get_data(conf_node
, KEY_DB_BACKUP_FREQ
, RECDB_QSTRING
);
694 global_conf
.db_backup_frequency
= str
? ParseInterval(str
) : 7200;
695 str
= database_get_data(conf_node
, KEY_ANNOUNCEMENTS_DEFAULT
, RECDB_QSTRING
);
696 global_conf
.announcements_default
= str
? enabled_string(str
) : 1;
698 str
= database_get_data(conf_node
, KEY_NICK
, RECDB_QSTRING
);
700 NickChange(global
, str
, 0);
704 global_saxdb_read(struct dict
*db
)
706 struct record_data
*hir
;
709 unsigned long duration
;
710 char *str
, *from
, *message
;
713 for(it
=dict_first(db
); it
; it
=iter_next(it
))
716 if(hir
->type
!= RECDB_OBJECT
)
718 log_module(G_LOG
, LOG_WARNING
, "Unexpected rectype %d for %s.", hir
->type
, iter_key(it
));
722 str
= database_get_data(hir
->d
.object
, KEY_FLAGS
, RECDB_QSTRING
);
723 flags
= str
? strtoul(str
, NULL
, 0) : 0;
725 str
= database_get_data(hir
->d
.object
, KEY_POSTED
, RECDB_QSTRING
);
726 posted
= str
? strtoul(str
, NULL
, 0) : 0;
728 str
= database_get_data(hir
->d
.object
, KEY_DURATION
, RECDB_QSTRING
);
729 duration
= str
? strtoul(str
, NULL
, 0) : 0;
731 from
= database_get_data(hir
->d
.object
, KEY_FROM
, RECDB_QSTRING
);
732 message
= database_get_data(hir
->d
.object
, KEY_MESSAGE
, RECDB_QSTRING
);
734 message_add(flags
, posted
, duration
, from
, message
);
740 global_saxdb_write(struct saxdb_context
*ctx
)
742 struct globalMessage
*message
;
745 for(message
= messageList
; message
; message
= message
->next
) {
746 snprintf(str
, sizeof(str
), "%li", message
->id
);
747 saxdb_start_record(ctx
, str
, 0);
748 saxdb_write_int(ctx
, KEY_FLAGS
, message
->flags
);
749 saxdb_write_int(ctx
, KEY_POSTED
, message
->posted
);
750 saxdb_write_int(ctx
, KEY_DURATION
, message
->duration
);
751 saxdb_write_string(ctx
, KEY_FROM
, message
->from
);
752 saxdb_write_string(ctx
, KEY_MESSAGE
, message
->message
);
753 saxdb_end_record(ctx
);
759 global_db_cleanup(void)
762 message_del(messageList
);
766 init_global(const char *nick
)
768 struct chanNode
*chan
;
770 G_LOG
= log_register_type("Global", "file:global.log");
771 reg_new_user_func(global_process_user
);
772 reg_auth_func(global_process_auth
);
773 reg_oper_func(global_process_oper
);
775 conf_register_reload(global_conf_read
);
777 global_module
= module_register("Global", G_LOG
, "global.help", NULL
);
778 modcmd_register(global_module
, "LIST", cmd_list
, 1, 0, "flags", "+oper", NULL
);
779 modcmd_register(global_module
, "MESSAGE", cmd_message
, 3, MODCMD_REQUIRE_AUTHED
, "flags", "+oper", NULL
);
780 modcmd_register(global_module
, "MESSAGES", cmd_messages
, 1, 0, NULL
);
781 modcmd_register(global_module
, "NOTICE", cmd_notice
, 3, MODCMD_REQUIRE_AUTHED
, "flags", "+oper", NULL
);
782 modcmd_register(global_module
, "REMOVE", cmd_remove
, 2, MODCMD_REQUIRE_AUTHED
, "flags", "+oper", NULL
);
786 const char *modes
= conf_get_data("services/global/modes", RECDB_QSTRING
);
787 global
= AddService(nick
, modes
? modes
: NULL
, "Global Services", NULL
);
788 global_service
= service_register(global
);
791 if(autojoin_channels
&& global
) {
792 for (i
= 0; i
< autojoin_channels
->used
; i
++) {
793 chan
= AddChannel(autojoin_channels
->list
[i
], now
, "+nt", NULL
, NULL
);
794 AddChannelUser(global
, chan
)->modes
|= MODE_CHANOP
;
798 saxdb_register("Global", global_saxdb_read
, global_saxdb_write
);
799 reg_exit_func(global_db_cleanup
);
800 message_register_table(msgtab
);