]>
jfr.im git - irc/evilnet/x3.git/blob - src/mod-memoserv.c
1 /* mod-memoserv.c - MemoServ module for srvx
2 * Copyright 2003-2004 Martijn Smit and 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.
21 /* Adds new section to srvx.conf:
25 * "message_expiry" "30d"; // age when messages are deleted; set
26 * // to 0 to disable message expiration
30 * After that, to make the module active on an existing bot:
31 * /msg opserv bind nickserv * *memoserv.*
33 * If you want a dedicated MemoServ bot, make sure the service control
34 * commands are bound to OpServ:
35 * /msg opserv bind opserv service *modcmd.joiner
36 * /msg opserv bind opserv service\ add *modcmd.service\ add
37 * /msg opserv bind opserv service\ rename *modcmd.service\ rename
38 * /msg opserv bind opserv service\ trigger *modcmd.service\ trigger
39 * /msg opserv bind opserv service\ remove *modcmd.service\ remove
41 * /msg opserv service add MemoServ User-to-user Memorandum Service
42 * /msg opserv bind memoserv help *modcmd.help
43 * Restart srvx with the updated conf file (as above, butwith "bot"
44 * "MemoServ"), and bind the commands to it:
45 * /msg opserv bind memoserv * *memoserv.*
46 * /msg opserv bind memoserv set *modcmd.joiner
55 #define KEY_SENT "sent"
56 #define KEY_RECIPIENT "to"
57 #define KEY_FROM "from"
58 #define KEY_MESSAGE "msg"
59 #define KEY_READ "read"
61 static const struct message_entry msgtab
[] = {
62 { "MSMSG_CANNOT_SEND", "You cannot send to account $b%s$b." },
63 { "MSMSG_MEMO_SENT", "Message sent to $b%s$b." },
64 { "MSMSG_NO_MESSAGES", "You have no messages." },
65 { "MSMSG_MEMOS_FOUND", "Found $b%d$b matches.\nUse /msg $S READ <ID> to read a message." },
66 { "MSMSG_CLEAN_INBOX", "You have $b%d$b or more messages, please clean out your inbox.\nUse /msg $S READ <ID> to read a message." },
67 { "MSMSG_LIST_HEAD", "$bID$b $bFrom$b $bTime Sent$b" },
68 { "MSMSG_LIST_FORMAT", "%-2u %s %s" },
69 { "MSMSG_MEMO_HEAD", "Memo %u From $b%s$b, received on %s:" },
70 { "MSMSG_BAD_MESSAGE_ID", "$b%s$b is not a valid message ID (it should be a number between 0 and %u)." },
71 { "MSMSG_NO_SUCH_MEMO", "You have no memo with that ID." },
72 { "MSMSG_MEMO_DELETED", "Memo $b%d$b deleted." },
73 { "MSMSG_EXPIRY_OFF", "I am currently not expiring messages. (turned off)" },
74 { "MSMSG_EXPIRY", "Messages will be expired when they are %s old (%d seconds)." },
75 { "MSMSG_MESSAGES_EXPIRED", "$b%lu$b message(s) expired." },
76 { "MSMSG_MEMOS_INBOX", "You have $b%d$b new message(s) in your inbox and %d old messages. Use /msg $S LIST to list them." },
77 { "MSMSG_NEW_MESSAGE", "You have a new message from $b%s$b." },
78 { "MSMSG_DELETED_ALL", "Deleted all of your messages." },
79 { "MSMSG_USE_CONFIRM", "Please use /msg $S DELETE * $bCONFIRM$b to delete $uall$u of your messages." },
80 { "MSMSG_STATUS_TOTAL", "I have $b%u$b memos in my database." },
81 { "MSMSG_STATUS_EXPIRED", "$b%ld$b memos expired during the time I am awake." },
82 { "MSMSG_STATUS_SENT", "$b%ld$b memos have been sent." },
83 { "MSMSG_SET_NOTIFY", "$bNotify: $b %s" },
84 { "MSMSG_SET_AUTHNOTIFY", "$bAuthNotify: $b %s" },
85 { "MSMSG_SET_PRIVATE", "$bPrivate: $b %s" },
90 struct memo_account
*recipient
;
91 struct memo_account
*sender
;
94 unsigned int is_read
: 1;
97 DECLARE_LIST(memoList
, struct memo
*);
98 DEFINE_LIST(memoList
, struct memo
*);
100 /* memo_account.flags fields */
101 #define MEMO_NOTIFY_NEW 1
102 #define MEMO_NOTIFY_LOGIN 2
103 #define MEMO_DENY_NONCHANNEL 4
105 struct memo_account
{
106 struct handle_info
*handle
;
108 struct memoList sent
;
109 struct memoList recvd
;
113 struct userNode
*bot
;
117 const char *memoserv_module_deps
[] = { NULL
};
118 static struct module *memoserv_module
;
119 static struct log_type
*MS_LOG
;
120 static unsigned long memosSent
, memosExpired
;
121 static struct dict
*memos
; /* memo_account->handle->handle -> memo_account */
123 static struct memo_account
*
124 memoserv_get_account(struct handle_info
*hi
)
126 struct memo_account
*ma
;
129 ma
= dict_find(memos
, hi
->handle
, NULL
);
132 ma
= calloc(1, sizeof(*ma
));
136 ma
->flags
= MEMO_NOTIFY_NEW
| MEMO_NOTIFY_LOGIN
;
137 dict_insert(memos
, ma
->handle
->handle
, ma
);
142 delete_memo(struct memo
*memo
)
144 memoList_remove(&memo
->recipient
->recvd
, memo
);
145 memoList_remove(&memo
->sender
->sent
, memo
);
151 delete_memo_account(void *data
)
153 struct memo_account
*ma
= data
;
155 while (ma
->recvd
.used
)
156 delete_memo(ma
->recvd
.list
[0]);
157 while (ma
->sent
.used
)
158 delete_memo(ma
->sent
.list
[0]);
159 memoList_clean(&ma
->recvd
);
160 memoList_clean(&ma
->sent
);
168 for (it
= dict_first(memos
); it
; it
= iter_next(it
)) {
169 struct memo_account
*acct
= iter_data(it
);
171 for (ii
= 0; ii
< acct
->sent
.used
; ++ii
) {
172 struct memo
*memo
= acct
->sent
.list
[ii
];
173 if ((now
- memo
->sent
) > memoserv_conf
.message_expiry
) {
183 expire_memos(UNUSED_ARG(void *data
))
185 if (memoserv_conf
.message_expiry
) {
187 timeq_add(now
+ memoserv_conf
.message_expiry
, expire_memos
, NULL
);
192 add_memo(time_t sent
, struct memo_account
*recipient
, struct memo_account
*sender
, char *message
)
196 memo
= calloc(1, sizeof(*memo
));
200 memo
->recipient
= recipient
;
201 memoList_append(&recipient
->recvd
, memo
);
202 memo
->sender
= sender
;
203 memoList_append(&sender
->sent
, memo
);
205 memo
->message
= strdup(message
);
211 memoserv_can_send(struct userNode
*bot
, struct userNode
*user
, struct memo_account
*acct
)
213 extern struct userData
*_GetChannelUser(struct chanData
*channel
, struct handle_info
*handle
, int override
, int allow_suspended
);
214 struct userData
*dest
;
216 if (!user
->handle_info
)
218 if (!(acct
->flags
& MEMO_DENY_NONCHANNEL
))
220 for (dest
= acct
->handle
->channels
; dest
; dest
= dest
->u_next
)
221 if (_GetChannelUser(dest
->channel
, user
->handle_info
, 1, 0))
223 send_message(user
, bot
, "MSMSG_CANNOT_SEND", acct
->handle
->handle
);
227 static struct memo
*find_memo(struct userNode
*user
, struct svccmd
*cmd
, struct memo_account
*ma
, const char *msgid
, unsigned int *id
)
230 if (!isdigit(msgid
[0])) {
232 reply("MSMSG_BAD_MESSAGE_ID", msgid
, ma
->recvd
.used
- 1);
234 reply("MSMSG_NO_MESSAGES");
237 memoid
= atoi(msgid
);
238 if (memoid
>= ma
->recvd
.used
) {
239 reply("MSMSG_NO_SUCH_MEMO");
242 return ma
->recvd
.list
[*id
= memoid
];
245 static MODCMD_FUNC(cmd_send
)
248 struct handle_info
*hi
;
249 struct memo_account
*ma
, *sender
;
251 if (!(hi
= modcmd_get_handle_info(user
, argv
[1])))
253 if (!(sender
= memoserv_get_account(user
->handle_info
))
254 || !(ma
= memoserv_get_account(hi
))) {
255 reply("MSG_INTERNAL_FAILURE");
258 if (!(memoserv_can_send(cmd
->parent
->bot
, user
, ma
)))
260 message
= unsplit_string(argv
+ 2, argc
- 2, NULL
);
261 add_memo(now
, ma
, sender
, message
);
262 if (ma
->flags
& MEMO_NOTIFY_NEW
) {
263 struct userNode
*other
;
264 for (other
= ma
->handle
->users
; other
; other
= other
->next_authed
)
265 send_message(other
, cmd
->parent
->bot
, "MSMSG_NEW_MESSAGE", user
->nick
);
267 reply("MSMSG_MEMO_SENT", ma
->handle
->handle
);
271 static MODCMD_FUNC(cmd_list
)
273 struct memo_account
*ma
;
279 if (!(ma
= memoserv_get_account(user
->handle_info
)))
281 reply("MSMSG_LIST_HEAD");
282 for (ii
= 0; (ii
< ma
->recvd
.used
) && (ii
< 15); ++ii
) {
283 memo
= ma
->recvd
.list
[ii
];
284 localtime_r(&memo
->sent
, &tm
);
285 strftime(posted
, sizeof(posted
), "%I:%M %p, %m/%d/%Y", &tm
);
286 reply("MSMSG_LIST_FORMAT", ii
, memo
->sender
->handle
->handle
, posted
);
291 reply("MSMSG_CLEAN_INBOX", ii
);
293 reply("MSMSG_MEMOS_FOUND", ii
);
297 static MODCMD_FUNC(cmd_read
)
299 struct memo_account
*ma
;
305 if (!(ma
= memoserv_get_account(user
->handle_info
)))
307 if (!(memo
= find_memo(user
, cmd
, ma
, argv
[1], &memoid
)))
309 localtime_r(&memo
->sent
, &tm
);
310 strftime(posted
, sizeof(posted
), "%I:%M %p, %m/%d/%Y", &tm
);
311 reply("MSMSG_MEMO_HEAD", memoid
, memo
->sender
->handle
->handle
, posted
);
312 send_message_type(4, user
, cmd
->parent
->bot
, "%s", memo
->message
);
317 static MODCMD_FUNC(cmd_delete
)
319 struct memo_account
*ma
;
323 if (!(ma
= memoserv_get_account(user
->handle_info
)))
325 if (!irccasecmp(argv
[1], "*") || !irccasecmp(argv
[1], "all")) {
326 if ((argc
< 3) || irccasecmp(argv
[2], "confirm")) {
327 reply("MSMSG_USE_CONFIRM");
330 while (ma
->recvd
.used
)
331 delete_memo(ma
->recvd
.list
[0]);
332 reply("MSMSG_DELETED_ALL");
336 if (!(memo
= find_memo(user
, cmd
, ma
, argv
[1], &memoid
)))
339 reply("MSMSG_MEMO_DELETED", memoid
);
343 static MODCMD_FUNC(cmd_expire
)
345 unsigned long old_expired
= memosExpired
;
347 reply("MSMSG_MESSAGES_EXPIRED", memosExpired
- old_expired
);
351 static MODCMD_FUNC(cmd_expiry
)
353 char interval
[INTERVALLEN
];
355 if (!memoserv_conf
.message_expiry
) {
356 reply("MSMSG_EXPIRY_OFF");
360 intervalString(interval
, memoserv_conf
.message_expiry
, user
->handle_info
);
361 reply("MSMSG_EXPIRY", interval
, memoserv_conf
.message_expiry
);
365 static MODCMD_FUNC(cmd_set_notify
)
367 struct memo_account
*ma
;
370 if (!(ma
= memoserv_get_account(user
->handle_info
)))
374 if (enabled_string(choice
)) {
375 ma
->flags
|= MEMO_NOTIFY_NEW
;
376 } else if (disabled_string(choice
)) {
377 ma
->flags
&= ~MEMO_NOTIFY_NEW
;
379 reply("MSG_INVALID_BINARY", choice
);
384 choice
= (ma
->flags
& MEMO_NOTIFY_NEW
) ? "on" : "off";
385 reply("MSMSG_SET_NOTIFY", choice
);
389 static MODCMD_FUNC(cmd_set_authnotify
)
391 struct memo_account
*ma
;
394 if (!(ma
= memoserv_get_account(user
->handle_info
)))
398 if (enabled_string(choice
)) {
399 ma
->flags
|= MEMO_NOTIFY_LOGIN
;
400 } else if (disabled_string(choice
)) {
401 ma
->flags
&= ~MEMO_NOTIFY_LOGIN
;
403 reply("MSG_INVALID_BINARY", choice
);
408 choice
= (ma
->flags
& MEMO_NOTIFY_LOGIN
) ? "on" : "off";
409 reply("MSMSG_SET_AUTHNOTIFY", choice
);
413 static MODCMD_FUNC(cmd_set_private
)
415 struct memo_account
*ma
;
418 if (!(ma
= memoserv_get_account(user
->handle_info
)))
422 if (enabled_string(choice
)) {
423 ma
->flags
|= MEMO_DENY_NONCHANNEL
;
424 } else if (disabled_string(choice
)) {
425 ma
->flags
&= ~MEMO_DENY_NONCHANNEL
;
427 reply("MSG_INVALID_BINARY", choice
);
432 choice
= (ma
->flags
& MEMO_DENY_NONCHANNEL
) ? "on" : "off";
433 reply("MSMSG_SET_PRIVATE", choice
);
437 static MODCMD_FUNC(cmd_status
)
439 reply("MSMSG_STATUS_TOTAL", dict_size(memos
));
440 reply("MSMSG_STATUS_EXPIRED", memosExpired
);
441 reply("MSMSG_STATUS_SENT", memosSent
);
446 memoserv_conf_read(void)
451 str
= "modules/memoserv";
452 if (!(conf_node
= conf_get_data(str
, RECDB_OBJECT
))) {
453 log_module(MS_LOG
, LOG_ERROR
, "config node `%s' is missing or has wrong type.", str
);
457 str
= database_get_data(conf_node
, "message_expiry", RECDB_QSTRING
);
458 memoserv_conf
.message_expiry
= str
? ParseInterval(str
) : 60*24*30;
462 memoserv_saxdb_read(struct dict
*db
)
465 struct handle_info
*sender
, *recipient
;
466 struct record_data
*hir
;
471 for (it
= dict_first(db
); it
; it
= iter_next(it
)) {
473 if (hir
->type
!= RECDB_OBJECT
) {
474 log_module(MS_LOG
, LOG_WARNING
, "Unexpected rectype %d for %s.", hir
->type
, iter_key(it
));
478 if (!(str
= database_get_data(hir
->d
.object
, KEY_SENT
, RECDB_QSTRING
))) {
479 log_module(MS_LOG
, LOG_ERROR
, "Date sent not present in memo %s; skipping", iter_key(it
));
484 if (!(str
= database_get_data(hir
->d
.object
, KEY_RECIPIENT
, RECDB_QSTRING
))) {
485 log_module(MS_LOG
, LOG_ERROR
, "Recipient not present in memo %s; skipping", iter_key(it
));
487 } else if (!(recipient
= get_handle_info(str
))) {
488 log_module(MS_LOG
, LOG_ERROR
, "Invalid recipient %s in memo %s; skipping", str
, iter_key(it
));
492 if (!(str
= database_get_data(hir
->d
.object
, KEY_FROM
, RECDB_QSTRING
))) {
493 log_module(MS_LOG
, LOG_ERROR
, "Sender not present in memo %s; skipping", iter_key(it
));
495 } else if (!(sender
= get_handle_info(str
))) {
496 log_module(MS_LOG
, LOG_ERROR
, "Invalid sender %s in memo %s; skipping", str
, iter_key(it
));
500 if (!(str
= database_get_data(hir
->d
.object
, KEY_MESSAGE
, RECDB_QSTRING
))) {
501 log_module(MS_LOG
, LOG_ERROR
, "Message not present in memo %s; skipping", iter_key(it
));
505 memo
= add_memo(sent
, memoserv_get_account(recipient
), memoserv_get_account(sender
), str
);
506 if ((str
= database_get_data(hir
->d
.object
, KEY_READ
, RECDB_QSTRING
)))
513 memoserv_saxdb_write(struct saxdb_context
*ctx
)
516 struct memo_account
*ma
;
519 unsigned int id
= 0, ii
;
521 for (it
= dict_first(memos
); it
; it
= iter_next(it
)) {
523 for (ii
= 0; ii
< ma
->recvd
.used
; ++ii
) {
524 memo
= ma
->recvd
.list
[ii
];
525 saxdb_start_record(ctx
, inttobase64(str
, id
++, sizeof(str
)), 0);
526 saxdb_write_int(ctx
, KEY_SENT
, memo
->sent
);
527 saxdb_write_string(ctx
, KEY_RECIPIENT
, memo
->recipient
->handle
->handle
);
528 saxdb_write_string(ctx
, KEY_FROM
, memo
->sender
->handle
->handle
);
529 saxdb_write_string(ctx
, KEY_MESSAGE
, memo
->message
);
531 saxdb_write_int(ctx
, KEY_READ
, 1);
532 saxdb_end_record(ctx
);
539 memoserv_cleanup(void)
545 memoserv_check_messages(struct userNode
*user
, UNUSED_ARG(struct handle_info
*old_handle
))
547 unsigned int ii
, unseen
;
548 struct memo_account
*ma
;
551 if (!(ma
= memoserv_get_account(user
->handle_info
))
552 || !(ma
->flags
& MEMO_NOTIFY_LOGIN
))
554 for (ii
= unseen
= 0; ii
< ma
->recvd
.used
; ++ii
) {
555 memo
= ma
->recvd
.list
[ii
];
559 if (ma
->recvd
.used
&& memoserv_conf
.bot
)
560 send_message(user
, memoserv_conf
.bot
, "MSMSG_MEMOS_INBOX", unseen
, ma
->recvd
.used
- unseen
);
564 memoserv_rename_account(struct handle_info
*hi
, const char *old_handle
)
566 struct memo_account
*ma
;
567 if (!(ma
= dict_find(memos
, old_handle
, NULL
)))
569 dict_remove2(memos
, old_handle
, 1);
570 dict_insert(memos
, hi
->handle
, ma
);
574 memoserv_unreg_account(UNUSED_ARG(struct userNode
*user
), struct handle_info
*handle
)
576 dict_remove(memos
, handle
->handle
);
582 MS_LOG
= log_register_type("MemoServ", "file:memoserv.log");
584 dict_set_free_data(memos
, delete_memo_account
);
585 reg_auth_func(memoserv_check_messages
);
586 reg_handle_rename_func(memoserv_rename_account
);
587 reg_unreg_func(memoserv_unreg_account
);
588 conf_register_reload(memoserv_conf_read
);
589 reg_exit_func(memoserv_cleanup
);
590 saxdb_register("MemoServ", memoserv_saxdb_read
, memoserv_saxdb_write
);
592 memoserv_module
= module_register("MemoServ", MS_LOG
, "mod-memoserv.help", NULL
);
593 modcmd_register(memoserv_module
, "send", cmd_send
, 3, MODCMD_REQUIRE_AUTHED
, NULL
);
594 modcmd_register(memoserv_module
, "list", cmd_list
, 1, MODCMD_REQUIRE_AUTHED
, NULL
);
595 modcmd_register(memoserv_module
, "read", cmd_read
, 2, MODCMD_REQUIRE_AUTHED
, NULL
);
596 modcmd_register(memoserv_module
, "delete", cmd_delete
, 2, MODCMD_REQUIRE_AUTHED
, NULL
);
597 modcmd_register(memoserv_module
, "expire", cmd_expire
, 1, MODCMD_REQUIRE_AUTHED
, "flags", "+oper", NULL
);
598 modcmd_register(memoserv_module
, "expiry", cmd_expiry
, 1, 0, NULL
);
599 modcmd_register(memoserv_module
, "status", cmd_status
, 1, 0, NULL
);
600 modcmd_register(memoserv_module
, "set notify", cmd_set_notify
, 1, 0, NULL
);
601 modcmd_register(memoserv_module
, "set authnotify", cmd_set_authnotify
, 1, 0, NULL
);
602 modcmd_register(memoserv_module
, "set private", cmd_set_private
, 1, 0, NULL
);
603 message_register_table(msgtab
);
605 if (memoserv_conf
.message_expiry
)
606 timeq_add(now
+ memoserv_conf
.message_expiry
, expire_memos
, NULL
);
611 memoserv_finalize(void) {
615 str
= "modules/memoserv";
616 if (!(conf_node
= conf_get_data(str
, RECDB_OBJECT
))) {
617 log_module(MS_LOG
, LOG_ERROR
, "config node `%s' is missing or has wrong type.", str
);
621 str
= database_get_data(conf_node
, "bot", RECDB_QSTRING
);
623 memoserv_conf
.bot
= GetUserH(str
);