1 /* mod-memoserv.c - MemoServ module for srvx
2 * Copyright 2003-2004 Martijn Smit and srvx Development Team
4 * This file is part of srvx.
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 #undef KEY_READ /* thanks microsoft! */
60 #define KEY_READ "read"
62 static const struct message_entry msgtab[] = {
63 { "MSMSG_CANNOT_SEND", "You cannot send to account $b%s$b." },
64 { "MSMSG_MEMO_SENT", "Message sent to $b%s$b." },
65 { "MSMSG_NO_MESSAGES", "You have no messages." },
66 { "MSMSG_MEMOS_FOUND", "Found $b%d$b matches.\nUse /msg $S READ <ID> to read a message." },
67 { "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." },
68 { "MSMSG_LIST_HEAD", "$bID$b $bFrom$b $bTime Sent$b" },
69 { "MSMSG_LIST_FORMAT", "%-2u %s %s" },
70 { "MSMSG_MEMO_HEAD", "Memo %u From $b%s$b, received on %s:" },
71 { "MSMSG_BAD_MESSAGE_ID", "$b%s$b is not a valid message ID (it should be a number between 0 and %u)." },
72 { "MSMSG_NO_SUCH_MEMO", "You have no memo with that ID." },
73 { "MSMSG_MEMO_DELETED", "Memo $b%d$b deleted." },
74 { "MSMSG_EXPIRY_OFF", "I am currently not expiring messages. (turned off)" },
75 { "MSMSG_EXPIRY", "Messages will be expired when they are %s old (%d seconds)." },
76 { "MSMSG_MESSAGES_EXPIRED", "$b%lu$b message(s) expired." },
77 { "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." },
78 { "MSMSG_NEW_MESSAGE", "You have a new message from $b%s$b." },
79 { "MSMSG_DELETED_ALL", "Deleted all of your messages." },
80 { "MSMSG_USE_CONFIRM", "Please use /msg $S DELETE * $bCONFIRM$b to delete $uall$u of your messages." },
81 { "MSMSG_STATUS_TOTAL", "I have $b%u$b memos in my database." },
82 { "MSMSG_STATUS_EXPIRED", "$b%ld$b memos expired during the time I am awake." },
83 { "MSMSG_STATUS_SENT", "$b%ld$b memos have been sent." },
84 { "MSMSG_SET_NOTIFY", "$bNotify: $b %s" },
85 { "MSMSG_SET_AUTHNOTIFY", "$bAuthNotify: $b %s" },
86 { "MSMSG_SET_PRIVATE", "$bPrivate: $b %s" },
91 struct memo_account *recipient;
92 struct memo_account *sender;
95 unsigned int is_read : 1;
98 DECLARE_LIST(memoList, struct memo*);
99 DEFINE_LIST(memoList, struct memo*);
101 /* memo_account.flags fields */
102 #define MEMO_NOTIFY_NEW 1
103 #define MEMO_NOTIFY_LOGIN 2
104 #define MEMO_DENY_NONCHANNEL 4
106 struct memo_account {
107 struct handle_info *handle;
109 struct memoList sent;
110 struct memoList recvd;
114 struct userNode *bot;
118 const char *memoserv_module_deps[] = { NULL };
119 static struct module *memoserv_module;
120 static struct log_type *MS_LOG;
121 static unsigned long memosSent, memosExpired;
122 static struct dict *memos; /* memo_account->handle->handle -> memo_account */
124 static struct memo_account *
125 memoserv_get_account(struct handle_info *hi)
127 struct memo_account *ma;
130 ma = dict_find(memos, hi->handle, NULL);
133 ma = calloc(1, sizeof(*ma));
137 ma->flags = MEMO_NOTIFY_NEW | MEMO_NOTIFY_LOGIN;
138 dict_insert(memos, ma->handle->handle, ma);
143 delete_memo(struct memo *memo)
145 memoList_remove(&memo->recipient->recvd, memo);
146 memoList_remove(&memo->sender->sent, memo);
152 delete_memo_account(void *data)
154 struct memo_account *ma = data;
156 while (ma->recvd.used)
157 delete_memo(ma->recvd.list[0]);
158 while (ma->sent.used)
159 delete_memo(ma->sent.list[0]);
160 memoList_clean(&ma->recvd);
161 memoList_clean(&ma->sent);
169 for (it = dict_first(memos); it; it = iter_next(it)) {
170 struct memo_account *acct = iter_data(it);
172 for (ii = 0; ii < acct->sent.used; ++ii) {
173 struct memo *memo = acct->sent.list[ii];
174 if ((now - memo->sent) > memoserv_conf.message_expiry) {
184 expire_memos(UNUSED_ARG(void *data))
186 if (memoserv_conf.message_expiry) {
188 timeq_add(now + memoserv_conf.message_expiry, expire_memos, NULL);
193 add_memo(time_t sent, struct memo_account *recipient, struct memo_account *sender, char *message)
197 memo = calloc(1, sizeof(*memo));
201 memo->recipient = recipient;
202 memoList_append(&recipient->recvd, memo);
203 memo->sender = sender;
204 memoList_append(&sender->sent, memo);
206 memo->message = strdup(message);
212 memoserv_can_send(struct userNode *bot, struct userNode *user, struct memo_account *acct)
214 extern struct userData *_GetChannelUser(struct chanData *channel, struct handle_info *handle, int override, int allow_suspended);
215 struct userData *dest;
217 if (!user->handle_info)
219 if (!(acct->flags & MEMO_DENY_NONCHANNEL))
221 for (dest = acct->handle->channels; dest; dest = dest->u_next)
222 if (_GetChannelUser(dest->channel, user->handle_info, 1, 0))
224 send_message(user, bot, "MSMSG_CANNOT_SEND", acct->handle->handle);
228 static struct memo *find_memo(struct userNode *user, struct svccmd *cmd, struct memo_account *ma, const char *msgid, unsigned int *id)
231 if (!isdigit(msgid[0])) {
233 reply("MSMSG_BAD_MESSAGE_ID", msgid, ma->recvd.used - 1);
235 reply("MSMSG_NO_MESSAGES");
238 memoid = atoi(msgid);
239 if (memoid >= ma->recvd.used) {
240 reply("MSMSG_NO_SUCH_MEMO");
243 return ma->recvd.list[*id = memoid];
246 static MODCMD_FUNC(cmd_send)
249 struct handle_info *hi;
250 struct memo_account *ma, *sender;
252 if (!(hi = modcmd_get_handle_info(user, argv[1])))
254 if (!(sender = memoserv_get_account(user->handle_info))
255 || !(ma = memoserv_get_account(hi))) {
256 reply("MSG_INTERNAL_FAILURE");
259 if (!(memoserv_can_send(cmd->parent->bot, user, ma)))
261 message = unsplit_string(argv + 2, argc - 2, NULL);
262 add_memo(now, ma, sender, message);
263 if (ma->flags & MEMO_NOTIFY_NEW) {
264 struct userNode *other;
265 for (other = ma->handle->users; other; other = other->next_authed)
266 send_message(other, cmd->parent->bot, "MSMSG_NEW_MESSAGE", user->nick);
268 reply("MSMSG_MEMO_SENT", ma->handle->handle);
272 static MODCMD_FUNC(cmd_list)
274 struct memo_account *ma;
280 if (!(ma = memoserv_get_account(user->handle_info)))
282 reply("MSMSG_LIST_HEAD");
283 for (ii = 0; (ii < ma->recvd.used) && (ii < 15); ++ii) {
284 memo = ma->recvd.list[ii];
285 localtime_r(&memo->sent, &tm);
286 strftime(posted, sizeof(posted), "%I:%M %p, %m/%d/%Y", &tm);
287 reply("MSMSG_LIST_FORMAT", ii, memo->sender->handle->handle, posted);
292 reply("MSMSG_CLEAN_INBOX", ii);
294 reply("MSMSG_MEMOS_FOUND", ii);
298 static MODCMD_FUNC(cmd_read)
300 struct memo_account *ma;
306 if (!(ma = memoserv_get_account(user->handle_info)))
308 if (!(memo = find_memo(user, cmd, ma, argv[1], &memoid)))
310 localtime_r(&memo->sent, &tm);
311 strftime(posted, sizeof(posted), "%I:%M %p, %m/%d/%Y", &tm);
312 reply("MSMSG_MEMO_HEAD", memoid, memo->sender->handle->handle, posted);
313 send_message_type(4, user, cmd->parent->bot, "%s", memo->message);
318 static MODCMD_FUNC(cmd_delete)
320 struct memo_account *ma;
324 if (!(ma = memoserv_get_account(user->handle_info)))
326 if (!irccasecmp(argv[1], "*") || !irccasecmp(argv[1], "all")) {
327 if ((argc < 3) || irccasecmp(argv[2], "confirm")) {
328 reply("MSMSG_USE_CONFIRM");
331 while (ma->recvd.used)
332 delete_memo(ma->recvd.list[0]);
333 reply("MSMSG_DELETED_ALL");
337 if (!(memo = find_memo(user, cmd, ma, argv[1], &memoid)))
340 reply("MSMSG_MEMO_DELETED", memoid);
344 static MODCMD_FUNC(cmd_expire)
346 unsigned long old_expired = memosExpired;
348 reply("MSMSG_MESSAGES_EXPIRED", memosExpired - old_expired);
352 static MODCMD_FUNC(cmd_expiry)
354 char interval[INTERVALLEN];
356 if (!memoserv_conf.message_expiry) {
357 reply("MSMSG_EXPIRY_OFF");
361 intervalString(interval, memoserv_conf.message_expiry, user->handle_info);
362 reply("MSMSG_EXPIRY", interval, memoserv_conf.message_expiry);
366 static MODCMD_FUNC(cmd_set_notify)
368 struct memo_account *ma;
371 if (!(ma = memoserv_get_account(user->handle_info)))
375 if (enabled_string(choice)) {
376 ma->flags |= MEMO_NOTIFY_NEW;
377 } else if (disabled_string(choice)) {
378 ma->flags &= ~MEMO_NOTIFY_NEW;
380 reply("MSG_INVALID_BINARY", choice);
385 choice = (ma->flags & MEMO_NOTIFY_NEW) ? "on" : "off";
386 reply("MSMSG_SET_NOTIFY", choice);
390 static MODCMD_FUNC(cmd_set_authnotify)
392 struct memo_account *ma;
395 if (!(ma = memoserv_get_account(user->handle_info)))
399 if (enabled_string(choice)) {
400 ma->flags |= MEMO_NOTIFY_LOGIN;
401 } else if (disabled_string(choice)) {
402 ma->flags &= ~MEMO_NOTIFY_LOGIN;
404 reply("MSG_INVALID_BINARY", choice);
409 choice = (ma->flags & MEMO_NOTIFY_LOGIN) ? "on" : "off";
410 reply("MSMSG_SET_AUTHNOTIFY", choice);
414 static MODCMD_FUNC(cmd_set_private)
416 struct memo_account *ma;
419 if (!(ma = memoserv_get_account(user->handle_info)))
423 if (enabled_string(choice)) {
424 ma->flags |= MEMO_DENY_NONCHANNEL;
425 } else if (disabled_string(choice)) {
426 ma->flags &= ~MEMO_DENY_NONCHANNEL;
428 reply("MSG_INVALID_BINARY", choice);
433 choice = (ma->flags & MEMO_DENY_NONCHANNEL) ? "on" : "off";
434 reply("MSMSG_SET_PRIVATE", choice);
438 static MODCMD_FUNC(cmd_status)
440 reply("MSMSG_STATUS_TOTAL", dict_size(memos));
441 reply("MSMSG_STATUS_EXPIRED", memosExpired);
442 reply("MSMSG_STATUS_SENT", memosSent);
447 memoserv_conf_read(void)
452 str = "modules/memoserv";
453 if (!(conf_node = conf_get_data(str, RECDB_OBJECT))) {
454 log_module(MS_LOG, LOG_ERROR, "config node `%s' is missing or has wrong type.", str);
458 str = database_get_data(conf_node, "message_expiry", RECDB_QSTRING);
459 memoserv_conf.message_expiry = str ? ParseInterval(str) : 60*24*30;
463 memoserv_saxdb_read(struct dict *db)
466 struct handle_info *sender, *recipient;
467 struct record_data *hir;
472 for (it = dict_first(db); it; it = iter_next(it)) {
474 if (hir->type != RECDB_OBJECT) {
475 log_module(MS_LOG, LOG_WARNING, "Unexpected rectype %d for %s.", hir->type, iter_key(it));
479 if (!(str = database_get_data(hir->d.object, KEY_SENT, RECDB_QSTRING))) {
480 log_module(MS_LOG, LOG_ERROR, "Date sent not present in memo %s; skipping", iter_key(it));
485 if (!(str = database_get_data(hir->d.object, KEY_RECIPIENT, RECDB_QSTRING))) {
486 log_module(MS_LOG, LOG_ERROR, "Recipient not present in memo %s; skipping", iter_key(it));
488 } else if (!(recipient = get_handle_info(str))) {
489 log_module(MS_LOG, LOG_ERROR, "Invalid recipient %s in memo %s; skipping", str, iter_key(it));
493 if (!(str = database_get_data(hir->d.object, KEY_FROM, RECDB_QSTRING))) {
494 log_module(MS_LOG, LOG_ERROR, "Sender not present in memo %s; skipping", iter_key(it));
496 } else if (!(sender = get_handle_info(str))) {
497 log_module(MS_LOG, LOG_ERROR, "Invalid sender %s in memo %s; skipping", str, iter_key(it));
501 if (!(str = database_get_data(hir->d.object, KEY_MESSAGE, RECDB_QSTRING))) {
502 log_module(MS_LOG, LOG_ERROR, "Message not present in memo %s; skipping", iter_key(it));
506 memo = add_memo(sent, memoserv_get_account(recipient), memoserv_get_account(sender), str);
507 if ((str = database_get_data(hir->d.object, KEY_READ, RECDB_QSTRING)))
514 memoserv_saxdb_write(struct saxdb_context *ctx)
517 struct memo_account *ma;
520 unsigned int id = 0, ii;
522 for (it = dict_first(memos); it; it = iter_next(it)) {
524 for (ii = 0; ii < ma->recvd.used; ++ii) {
525 memo = ma->recvd.list[ii];
526 saxdb_start_record(ctx, inttobase64(str, id++, sizeof(str)), 0);
527 saxdb_write_int(ctx, KEY_SENT, memo->sent);
528 saxdb_write_string(ctx, KEY_RECIPIENT, memo->recipient->handle->handle);
529 saxdb_write_string(ctx, KEY_FROM, memo->sender->handle->handle);
530 saxdb_write_string(ctx, KEY_MESSAGE, memo->message);
532 saxdb_write_int(ctx, KEY_READ, 1);
533 saxdb_end_record(ctx);
540 memoserv_cleanup(void)
546 memoserv_check_messages(struct userNode *user, UNUSED_ARG(struct handle_info *old_handle))
548 unsigned int ii, unseen;
549 struct memo_account *ma;
552 if (!(ma = memoserv_get_account(user->handle_info))
553 || !(ma->flags & MEMO_NOTIFY_LOGIN))
555 for (ii = unseen = 0; ii < ma->recvd.used; ++ii) {
556 memo = ma->recvd.list[ii];
560 if (ma->recvd.used && memoserv_conf.bot)
561 send_message(user, memoserv_conf.bot, "MSMSG_MEMOS_INBOX", unseen, ma->recvd.used - unseen);
565 memoserv_rename_account(struct handle_info *hi, const char *old_handle)
567 struct memo_account *ma;
568 if (!(ma = dict_find(memos, old_handle, NULL)))
570 dict_remove2(memos, old_handle, 1);
571 dict_insert(memos, hi->handle, ma);
575 memoserv_unreg_account(UNUSED_ARG(struct userNode *user), struct handle_info *handle)
577 dict_remove(memos, handle->handle);
583 MS_LOG = log_register_type("MemoServ", "file:memoserv.log");
585 dict_set_free_data(memos, delete_memo_account);
586 reg_auth_func(memoserv_check_messages);
587 reg_handle_rename_func(memoserv_rename_account);
588 reg_unreg_func(memoserv_unreg_account);
589 conf_register_reload(memoserv_conf_read);
590 reg_exit_func(memoserv_cleanup);
591 saxdb_register("MemoServ", memoserv_saxdb_read, memoserv_saxdb_write);
593 memoserv_module = module_register("MemoServ", MS_LOG, "mod-memoserv.help", NULL);
594 modcmd_register(memoserv_module, "send", cmd_send, 3, MODCMD_REQUIRE_AUTHED, NULL);
595 modcmd_register(memoserv_module, "list", cmd_list, 1, MODCMD_REQUIRE_AUTHED, NULL);
596 modcmd_register(memoserv_module, "read", cmd_read, 2, MODCMD_REQUIRE_AUTHED, NULL);
597 modcmd_register(memoserv_module, "delete", cmd_delete, 2, MODCMD_REQUIRE_AUTHED, NULL);
598 modcmd_register(memoserv_module, "expire", cmd_expire, 1, MODCMD_REQUIRE_AUTHED, "flags", "+oper", NULL);
599 modcmd_register(memoserv_module, "expiry", cmd_expiry, 1, 0, NULL);
600 modcmd_register(memoserv_module, "status", cmd_status, 1, 0, NULL);
601 modcmd_register(memoserv_module, "set notify", cmd_set_notify, 1, 0, NULL);
602 modcmd_register(memoserv_module, "set authnotify", cmd_set_authnotify, 1, 0, NULL);
603 modcmd_register(memoserv_module, "set private", cmd_set_private, 1, 0, NULL);
604 message_register_table(msgtab);
606 if (memoserv_conf.message_expiry)
607 timeq_add(now + memoserv_conf.message_expiry, expire_memos, NULL);
612 memoserv_finalize(void) {
616 str = "modules/memoserv";
617 if (!(conf_node = conf_get_data(str, RECDB_OBJECT))) {
618 log_module(MS_LOG, LOG_ERROR, "config node `%s' is missing or has wrong type.", str);
622 str = database_get_data(conf_node, "bot", RECDB_QSTRING);
624 memoserv_conf.bot = GetUserH(str);