2 * This module dumps and/or loads the Citadel database in XML format.
4 * Copyright (c) 1987-2020 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 3.
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.
16 * Explanation of <progress> tags:
19 * 2% finished exporting configuration
20 * 7% finished exporting users
21 * 12% finished exporting openids
22 * 17% finished exporting rooms
23 * 18% finished exporting floors
24 * 25% finished exporting visits
25 * 100% finished exporting messages
36 #include <sys/types.h>
38 #if TIME_WITH_SYS_TIME
39 # include <sys/time.h>
43 # include <sys/time.h>
54 #include <libcitadel.h>
57 #include "citserver.h"
63 #include "euidindex.h"
64 #include "ctdl_module.h"
66 #define END_OF_MESSAGE "---eom---dbd---"
68 char migr_tempfilename1[PATH_MAX];
69 char migr_tempfilename2[PATH_MAX];
70 FILE *migr_global_message_list;
72 char *ikey = NULL; // If we're importing a config key we store it here.
75 /******************************************************************************
76 * Code which implements the export appears in this section *
77 ******************************************************************************/
80 * Output a string to the client with these characters escaped: & < > " '
82 void xml_strout(char *str) {
92 client_write(HKEY("""));
94 else if (*c == '\'') {
95 client_write(HKEY("'"));
98 client_write(HKEY("<"));
100 else if (*c == '>') {
101 client_write(HKEY(">"));
103 else if (*c == '&') {
104 client_write(HKEY("&"));
115 * Export a user record as XML
117 void migr_export_users_backend(char *username, void *data) {
120 if (CtdlGetUser(&u, username) != 0) {
124 client_write(HKEY("<user>\n"));
125 cprintf("<u_version>%d</u_version>\n", u.version);
126 cprintf("<u_uid>%ld</u_uid>\n", (long)u.uid);
127 client_write(HKEY("<u_password>")); xml_strout(u.password); client_write(HKEY("</u_password>\n"));
128 cprintf("<u_flags>%u</u_flags>\n", u.flags);
129 cprintf("<u_timescalled>%ld</u_timescalled>\n", u.timescalled);
130 cprintf("<u_posted>%ld</u_posted>\n", u.posted);
131 cprintf("<u_axlevel>%d</u_axlevel>\n", u.axlevel);
132 cprintf("<u_usernum>%ld</u_usernum>\n", u.usernum);
133 cprintf("<u_lastcall>%ld</u_lastcall>\n", (long)u.lastcall);
134 cprintf("<u_USuserpurge>%d</u_USuserpurge>\n", u.USuserpurge);
135 client_write(HKEY("<u_fullname>")); xml_strout(u.fullname); client_write(HKEY("</u_fullname>\n"));
136 cprintf("<u_msgnum_bio>%ld</u_msgnum_bio>\n", u.msgnum_bio);
137 cprintf("<u_msgnum_pic>%ld</u_msgnum_pic>\n", u.msgnum_pic);
138 cprintf("<u_emailaddrs>%s</u_emailaddrs>\n", u.emailaddrs);
139 cprintf("<u_msgnum_inboxrules>%ld</u_msgnum_inboxrules>\n", u.msgnum_inboxrules);
140 cprintf("<u_lastproc_inboxrules>%ld</u_lastproc_inboxrules>\n", u.lastproc_inboxrules);
141 client_write(HKEY("</user>\n"));
145 void migr_export_users(void) {
146 ForEachUser(migr_export_users_backend, NULL);
150 void migr_export_room_msg(long msgnum, void *userdata) {
151 cprintf("%ld\n", msgnum);
152 fprintf(migr_global_message_list, "%ld\n", msgnum);
156 void migr_export_rooms_backend(struct ctdlroom *buf, void *data) {
157 client_write(HKEY("<room>\n"));
158 client_write(HKEY("<QRname>")); xml_strout(buf->QRname); client_write(HKEY("</QRname>\n"));
159 client_write(HKEY("<QRpasswd>")); xml_strout(buf->QRpasswd); client_write(HKEY("</QRpasswd>\n"));
160 cprintf("<QRroomaide>%ld</QRroomaide>\n", buf->QRroomaide);
161 cprintf("<QRhighest>%ld</QRhighest>\n", buf->QRhighest);
162 cprintf("<QRgen>%ld</QRgen>\n", (long)buf->QRgen);
163 cprintf("<QRflags>%u</QRflags>\n", buf->QRflags);
164 if (buf->QRflags & QR_DIRECTORY) {
165 client_write(HKEY("<QRdirname>"));
166 xml_strout(buf->QRdirname);
167 client_write(HKEY("</QRdirname>\n"));
169 cprintf("<QRfloor>%d</QRfloor>\n", buf->QRfloor);
170 cprintf("<QRmtime>%ld</QRmtime>\n", (long)buf->QRmtime);
171 cprintf("<QRexpire_mode>%d</QRexpire_mode>\n", buf->QRep.expire_mode);
172 cprintf("<QRexpire_value>%d</QRexpire_value>\n", buf->QRep.expire_value);
173 cprintf("<QRnumber>%ld</QRnumber>\n", buf->QRnumber);
174 cprintf("<QRorder>%d</QRorder>\n", buf->QRorder);
175 cprintf("<QRflags2>%u</QRflags2>\n", buf->QRflags2);
176 cprintf("<QRdefaultview>%d</QRdefaultview>\n", buf->QRdefaultview);
177 cprintf("<msgnum_info>%ld</msgnum_info>\n", buf->msgnum_info);
178 cprintf("<msgnum_pic>%ld</msgnum_pic>\n", buf->msgnum_pic);
179 client_write(HKEY("</room>\n"));
181 /* message list goes inside this tag */
183 CtdlGetRoom(&CC->room, buf->QRname);
184 client_write(HKEY("<room_messages>"));
185 client_write(HKEY("<FRname>")); xml_strout(CC->room.QRname); client_write(HKEY("</FRname>\n"));
186 client_write(HKEY("<FRmsglist>"));
187 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, migr_export_room_msg, NULL);
188 client_write(HKEY("</FRmsglist>\n"));
189 client_write(HKEY("</room_messages>\n"));
195 void migr_export_rooms(void) {
197 migr_global_message_list = fopen(migr_tempfilename1, "w");
198 if (migr_global_message_list != NULL) {
199 CtdlForEachRoom(migr_export_rooms_backend, NULL);
200 fclose(migr_global_message_list);
204 * Process the 'global' message list. (Sort it and remove dups.
205 * Dups are ok because a message may be in more than one room, but
206 * this will be handled by exporting the reference count, not by
207 * exporting the message multiple times.)
209 snprintf(cmd, sizeof cmd, "sort -n <%s >%s", migr_tempfilename1, migr_tempfilename2);
210 if (system(cmd) != 0) syslog(LOG_ALERT, "Error %d", errno);
211 snprintf(cmd, sizeof cmd, "uniq <%s >%s", migr_tempfilename2, migr_tempfilename1);
212 if (system(cmd) != 0) syslog(LOG_ALERT, "Error %d", errno);
215 snprintf(cmd, sizeof cmd, "wc -l %s", migr_tempfilename1);
216 FILE *fp = popen(cmd, "r");
218 fgets(cmd, sizeof cmd, fp);
220 total_msgs = atoi(cmd);
223 total_msgs = 1; // any nonzero just to keep it from barfing
225 syslog(LOG_DEBUG, "Total messages to be exported: %d", total_msgs);
229 void migr_export_floors(void) {
230 struct floor qfbuf, *buf;
233 for (i=0; i < MAXFLOORS; ++i) {
234 client_write(HKEY("<floor>\n"));
235 cprintf("<f_num>%d</f_num>\n", i);
236 CtdlGetFloor(&qfbuf, i);
238 cprintf("<f_flags>%u</f_flags>\n", buf->f_flags);
239 client_write(HKEY("<f_name>")); xml_strout(buf->f_name); client_write(HKEY("</f_name>\n"));
240 cprintf("<f_ref_count>%d</f_ref_count>\n", buf->f_ref_count);
241 cprintf("<f_ep_expire_mode>%d</f_ep_expire_mode>\n", buf->f_ep.expire_mode);
242 cprintf("<f_ep_expire_value>%d</f_ep_expire_value>\n", buf->f_ep.expire_value);
243 client_write(HKEY("</floor>\n"));
249 * Return nonzero if the supplied string contains only characters which are valid in a sequence set.
251 int is_sequence_set(char *s) {
256 while (ch = *c++, ch) {
257 if (!strchr("0123456789*,:", ch)) {
266 * Traverse the visits file...
268 void migr_export_visits(void) {
270 struct cdbdata *cdbv;
272 cdb_rewind(CDB_VISIT);
274 while (cdbv = cdb_next_item(CDB_VISIT), cdbv != NULL) {
275 memset(&vbuf, 0, sizeof(visit));
276 memcpy(&vbuf, cdbv->ptr,
277 ((cdbv->len > sizeof(visit)) ?
278 sizeof(visit) : cdbv->len));
281 client_write(HKEY("<visit>\n"));
282 cprintf("<v_roomnum>%ld</v_roomnum>\n", vbuf.v_roomnum);
283 cprintf("<v_roomgen>%ld</v_roomgen>\n", vbuf.v_roomgen);
284 cprintf("<v_usernum>%ld</v_usernum>\n", vbuf.v_usernum);
286 client_write(HKEY("<v_seen>"));
287 if ( (!IsEmptyStr(vbuf.v_seen)) && (is_sequence_set(vbuf.v_seen)) ) {
288 xml_strout(vbuf.v_seen);
291 cprintf("%ld", vbuf.v_lastseen);
293 client_write(HKEY("</v_seen>"));
295 if ( (!IsEmptyStr(vbuf.v_answered)) && (is_sequence_set(vbuf.v_answered)) ) {
296 client_write(HKEY("<v_answered>"));
297 xml_strout(vbuf.v_answered);
298 client_write(HKEY("</v_answered>\n"));
301 cprintf("<v_flags>%u</v_flags>\n", vbuf.v_flags);
302 cprintf("<v_view>%d</v_view>\n", vbuf.v_view);
303 client_write(HKEY("</visit>\n"));
308 void migr_export_message(long msgnum) {
310 struct CtdlMessage *msg;
313 /* We can use a static buffer here because there will never be more than
314 * one of this operation happening at any given time, and it's really best
315 * to just keep it allocated once instead of torturing malloc/free.
316 * Call this function with msgnum "-1" to free the buffer when finished.
318 static int encoded_alloc = 0;
319 static char *encoded_msg = NULL;
322 if ((encoded_alloc == 0) && (encoded_msg != NULL)) {
330 /* Ok, here we go ... */
332 msg = CtdlFetchMessage(msgnum, 1);
333 if (msg == NULL) return; /* fail silently */
335 client_write(HKEY("<message>\n"));
336 GetMetaData(&smi, msgnum);
337 cprintf("<msg_msgnum>%ld</msg_msgnum>\n", msgnum);
338 cprintf("<msg_meta_refcount>%d</msg_meta_refcount>\n", smi.meta_refcount);
339 cprintf("<msg_meta_rfc822_length>%ld</msg_meta_rfc822_length>\n", smi.meta_rfc822_length);
340 client_write(HKEY("<msg_meta_content_type>")); xml_strout(smi.meta_content_type); client_write(HKEY("</msg_meta_content_type>\n"));
342 client_write(HKEY("<msg_text>"));
343 CtdlSerializeMessage(&smr, msg);
346 /* Predict the buffer size we need. Expand the buffer if necessary. */
347 int encoded_len = smr.len * 15 / 10 ;
348 if (encoded_len > encoded_alloc) {
349 encoded_alloc = encoded_len;
350 encoded_msg = realloc(encoded_msg, encoded_alloc);
353 if (encoded_msg == NULL) {
354 /* Questionable hack that hopes it'll work next time and we only lose one message */
358 /* Once we do the encoding we know the exact size */
359 encoded_len = CtdlEncodeBase64(encoded_msg, (char *)smr.ser, smr.len, 1);
360 client_write(encoded_msg, encoded_len);
365 client_write(HKEY("</msg_text>\n"));
366 client_write(HKEY("</message>\n"));
370 void migr_export_openids(void) {
371 struct cdbdata *cdboi;
375 cdb_rewind(CDB_EXTAUTH);
376 while (cdboi = cdb_next_item(CDB_EXTAUTH), cdboi != NULL) {
377 if (cdboi->len > sizeof(long)) {
378 client_write(HKEY("<openid>\n"));
379 memcpy(&usernum, cdboi->ptr, sizeof(long));
380 snprintf(url, sizeof url, "%s", (cdboi->ptr)+sizeof(long) );
381 client_write(HKEY("<oid_url>"));
383 client_write(HKEY("</oid_url>\n"));
384 cprintf("<oid_usernum>%ld</oid_usernum>\n", usernum);
385 client_write(HKEY("</openid>\n"));
392 void migr_export_configs(void) {
393 struct cdbdata *cdbcfg;
398 cdb_rewind(CDB_CONFIG);
399 while (cdbcfg = cdb_next_item(CDB_CONFIG), cdbcfg != NULL) {
401 keylen = strlen(cdbcfg->ptr);
403 value = cdbcfg->ptr + keylen + 1;
405 client_write("<config key=\"", 13);
407 client_write("\">", 2);
409 client_write("</config>\n", 10);
415 void migr_export_messages(void) {
420 int prev_progress = 0;
424 migr_global_message_list = fopen(migr_tempfilename1, "r");
425 if (migr_global_message_list != NULL) {
426 syslog(LOG_INFO, "Opened %s", migr_tempfilename1);
427 while ((Ctx->kill_me == 0) &&
428 (fgets(buf, sizeof(buf), migr_global_message_list) != NULL)) {
431 migr_export_message(msgnum);
434 progress = (count * 74 / total_msgs) + 25 ;
435 if ((progress > prev_progress) && (progress < 100)) {
436 cprintf("<progress>%d</progress>\n", progress);
438 prev_progress = progress;
440 fclose(migr_global_message_list);
442 if (Ctx->kill_me == 0) {
443 syslog(LOG_INFO, "Exported %d messages.", count);
446 syslog(LOG_ERR, "Export aborted due to client disconnect!");
449 migr_export_message(-1L); /* This frees the encoding buffer */
453 void migr_do_export(void) {
457 cprintf("%d Exporting all Citadel databases.\n", LISTING_FOLLOWS);
460 client_write(HKEY("<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n"));
461 client_write(HKEY("<citadel_migrate_data>\n"));
462 cprintf("<version>%d</version>\n", REV_LEVEL);
463 cprintf("<progress>%d</progress>\n", 0);
465 /* export the configuration database */
466 migr_export_configs();
467 cprintf("<progress>%d</progress>\n", 2);
469 if (Ctx->kill_me == 0) migr_export_users();
470 cprintf("<progress>%d</progress>\n", 7);
471 if (Ctx->kill_me == 0) migr_export_openids();
472 cprintf("<progress>%d</progress>\n", 12);
473 if (Ctx->kill_me == 0) migr_export_rooms();
474 cprintf("<progress>%d</progress>\n", 17);
475 if (Ctx->kill_me == 0) migr_export_floors();
476 cprintf("<progress>%d</progress>\n", 18);
477 if (Ctx->kill_me == 0) migr_export_visits();
478 cprintf("<progress>%d</progress>\n", 25);
479 if (Ctx->kill_me == 0) migr_export_messages();
480 client_write(HKEY("</citadel_migrate_data>\n"));
481 cprintf("<progress>%d</progress>\n", 100);
482 client_write(HKEY("000\n"));
487 /******************************************************************************
489 * Here's the code that implements the import side. It's going to end up *
490 * being one big loop with lots of global variables. I don't care. *
491 * You wouldn't run multiple concurrent imports anyway. If this offends your *
492 * delicate sensibilities then go rewrite it in Ruby on Rails or something. *
493 ******************************************************************************/
496 int citadel_migrate_data = 0; /* Are we inside a <citadel_migrate_data> tag pair? */
497 StrBuf *migr_chardata = NULL;
498 StrBuf *migr_MsgData = NULL;
499 struct ctdluser usbuf;
500 struct ctdlroom qrbuf;
501 char openid_url[512];
502 long openid_usernum = 0;
503 char FRname[ROOMNAMELEN];
508 long import_msgnum = 0;
511 * This callback stores up the data which appears in between tags.
513 void migr_xml_chardata(void *data, const XML_Char *s, int len)
515 StrBufAppendBufPlain(migr_chardata, s, len, 0);
519 void migr_xml_start(void *data, const char *el, const char **attr) {
522 /*** GENERAL STUFF ***/
524 /* Reset chardata_len to zero and init buffer */
525 FlushStrBuf(migr_chardata);
526 FlushStrBuf(migr_MsgData);
528 if (!strcasecmp(el, "citadel_migrate_data")) {
529 ++citadel_migrate_data;
531 /* As soon as it looks like the input data is a genuine Citadel XML export,
532 * whack the existing database on disk to make room for the new one.
534 if (citadel_migrate_data == 1) {
535 for (i = 0; i < MAXCDB; ++i) {
542 if (citadel_migrate_data != 1) {
543 syslog(LOG_ALERT, "Out-of-sequence tag <%s> detected. Warning: ODD-DATA!", el);
547 /* When we begin receiving XML for one of these record types, clear out the associated
548 * buffer so we don't accidentally carry over any data from a previous record.
550 if (!strcasecmp(el, "user")) memset(&usbuf, 0, sizeof (struct ctdluser));
551 else if (!strcasecmp(el, "openid")) memset(openid_url, 0, sizeof openid_url);
552 else if (!strcasecmp(el, "room")) memset(&qrbuf, 0, sizeof (struct ctdlroom));
553 else if (!strcasecmp(el, "room_messages")) memset(FRname, 0, sizeof FRname);
554 else if (!strcasecmp(el, "floor")) memset(&flbuf, 0, sizeof (struct floor));
555 else if (!strcasecmp(el, "visit")) memset(&vbuf, 0, sizeof (visit));
557 else if (!strcasecmp(el, "message")) {
558 memset(&smi, 0, sizeof (struct MetaData));
561 else if (!strcasecmp(el, "config")) {
567 if (!strcasecmp(attr[0], "key")) {
568 ikey = strdup(attr[1]);
577 int migr_userrecord(void *data, const char *el)
579 if (!strcasecmp(el, "u_version")) usbuf.version = atoi(ChrPtr(migr_chardata));
580 else if (!strcasecmp(el, "u_uid")) usbuf.uid = atol(ChrPtr(migr_chardata));
581 else if (!strcasecmp(el, "u_password")) safestrncpy(usbuf.password, ChrPtr(migr_chardata), sizeof usbuf.password);
582 else if (!strcasecmp(el, "u_flags")) usbuf.flags = atoi(ChrPtr(migr_chardata));
583 else if (!strcasecmp(el, "u_timescalled")) usbuf.timescalled = atol(ChrPtr(migr_chardata));
584 else if (!strcasecmp(el, "u_posted")) usbuf.posted = atol(ChrPtr(migr_chardata));
585 else if (!strcasecmp(el, "u_axlevel")) usbuf.axlevel = atoi(ChrPtr(migr_chardata));
586 else if (!strcasecmp(el, "u_usernum")) usbuf.usernum = atol(ChrPtr(migr_chardata));
587 else if (!strcasecmp(el, "u_lastcall")) usbuf.lastcall = atol(ChrPtr(migr_chardata));
588 else if (!strcasecmp(el, "u_USuserpurge")) usbuf.USuserpurge = atoi(ChrPtr(migr_chardata));
589 else if (!strcasecmp(el, "u_fullname")) safestrncpy(usbuf.fullname, ChrPtr(migr_chardata), sizeof usbuf.fullname);
590 else if (!strcasecmp(el, "u_msgnum_bio")) usbuf.msgnum_bio = atol(ChrPtr(migr_chardata));
591 else if (!strcasecmp(el, "u_msgnum_pic")) usbuf.msgnum_pic = atol(ChrPtr(migr_chardata));
592 else if (!strcasecmp(el, "u_emailaddrs")) safestrncpy(usbuf.emailaddrs, ChrPtr(migr_chardata), sizeof usbuf.emailaddrs);
593 else if (!strcasecmp(el, "u_msgnum_inboxrules")) usbuf.msgnum_inboxrules = atol(ChrPtr(migr_chardata));
594 else if (!strcasecmp(el, "u_lastproc_inboxrules")) usbuf.lastproc_inboxrules = atol(ChrPtr(migr_chardata));
600 int migr_roomrecord(void *data, const char *el)
602 if (!strcasecmp(el, "QRname")) safestrncpy(qrbuf.QRname, ChrPtr(migr_chardata), sizeof qrbuf.QRname);
603 else if (!strcasecmp(el, "QRpasswd")) safestrncpy(qrbuf.QRpasswd, ChrPtr(migr_chardata), sizeof qrbuf.QRpasswd);
604 else if (!strcasecmp(el, "QRroomaide")) qrbuf.QRroomaide = atol(ChrPtr(migr_chardata));
605 else if (!strcasecmp(el, "QRhighest")) qrbuf.QRhighest = atol(ChrPtr(migr_chardata));
606 else if (!strcasecmp(el, "QRgen")) qrbuf.QRgen = atol(ChrPtr(migr_chardata));
607 else if (!strcasecmp(el, "QRflags")) qrbuf.QRflags = atoi(ChrPtr(migr_chardata));
608 else if (!strcasecmp(el, "QRdirname")) safestrncpy(qrbuf.QRdirname, ChrPtr(migr_chardata), sizeof qrbuf.QRdirname);
609 else if (!strcasecmp(el, "QRfloor")) qrbuf.QRfloor = atoi(ChrPtr(migr_chardata));
610 else if (!strcasecmp(el, "QRmtime")) qrbuf.QRmtime = atol(ChrPtr(migr_chardata));
611 else if (!strcasecmp(el, "QRexpire_mode")) qrbuf.QRep.expire_mode = atoi(ChrPtr(migr_chardata));
612 else if (!strcasecmp(el, "QRexpire_value")) qrbuf.QRep.expire_value = atoi(ChrPtr(migr_chardata));
613 else if (!strcasecmp(el, "QRnumber")) qrbuf.QRnumber = atol(ChrPtr(migr_chardata));
614 else if (!strcasecmp(el, "QRorder")) qrbuf.QRorder = atoi(ChrPtr(migr_chardata));
615 else if (!strcasecmp(el, "QRflags2")) qrbuf.QRflags2 = atoi(ChrPtr(migr_chardata));
616 else if (!strcasecmp(el, "QRdefaultview")) qrbuf.QRdefaultview = atoi(ChrPtr(migr_chardata));
617 else if (!strcasecmp(el, "msgnum_info")) qrbuf.msgnum_info = atol(ChrPtr(migr_chardata));
618 else if (!strcasecmp(el, "msgnum_pic")) qrbuf.msgnum_pic = atol(ChrPtr(migr_chardata));
624 int migr_floorrecord(void *data, const char *el)
626 if (!strcasecmp(el, "f_num")) floornum = atoi(ChrPtr(migr_chardata));
627 else if (!strcasecmp(el, "f_flags")) flbuf.f_flags = atoi(ChrPtr(migr_chardata));
628 else if (!strcasecmp(el, "f_name")) safestrncpy(flbuf.f_name, ChrPtr(migr_chardata), sizeof flbuf.f_name);
629 else if (!strcasecmp(el, "f_ref_count")) flbuf.f_ref_count = atoi(ChrPtr(migr_chardata));
630 else if (!strcasecmp(el, "f_ep_expire_mode")) flbuf.f_ep.expire_mode = atoi(ChrPtr(migr_chardata));
631 else if (!strcasecmp(el, "f_ep_expire_value")) flbuf.f_ep.expire_value = atoi(ChrPtr(migr_chardata));
637 int migr_visitrecord(void *data, const char *el)
639 if (!strcasecmp(el, "v_roomnum")) vbuf.v_roomnum = atol(ChrPtr(migr_chardata));
640 else if (!strcasecmp(el, "v_roomgen")) vbuf.v_roomgen = atol(ChrPtr(migr_chardata));
641 else if (!strcasecmp(el, "v_usernum")) vbuf.v_usernum = atol(ChrPtr(migr_chardata));
643 else if (!strcasecmp(el, "v_seen")) {
644 int is_textual_seen = 0;
646 int max = StrLength(migr_chardata);
648 vbuf.v_lastseen = atol(ChrPtr(migr_chardata));
650 for (i=0; i < max; ++i)
651 if (!isdigit(ChrPtr(migr_chardata)[i]))
654 safestrncpy(vbuf.v_seen, ChrPtr(migr_chardata), sizeof vbuf.v_seen);
657 else if (!strcasecmp(el, "v_answered")) safestrncpy(vbuf.v_answered, ChrPtr(migr_chardata), sizeof vbuf.v_answered);
658 else if (!strcasecmp(el, "v_flags")) vbuf.v_flags = atoi(ChrPtr(migr_chardata));
659 else if (!strcasecmp(el, "v_view")) vbuf.v_view = atoi(ChrPtr(migr_chardata));
665 void migr_xml_end(void *data, const char *el)
670 long *msglist = NULL;
671 int msglist_alloc = 0;
672 /*** GENERAL STUFF ***/
674 if (!strcasecmp(el, "citadel_migrate_data")) {
675 --citadel_migrate_data;
679 if (citadel_migrate_data != 1) {
680 syslog(LOG_ALERT, "Out-of-sequence tag <%s> detected. Warning: ODD-DATA!", el);
684 // syslog(LOG_DEBUG, "END TAG: <%s> DATA: <%s>\n", el, (migr_chardata_len ? migr_chardata : ""));
688 if (!strcasecmp(el, "config"))
690 syslog(LOG_DEBUG, "Imported config key=%s", ikey);
693 CtdlSetConfigStr(ikey, (char *)ChrPtr(migr_chardata));
698 syslog(LOG_INFO, "Closed a <config> tag but no key name was supplied.");
703 else if ((!strncasecmp(el, HKEY("u_"))) &&
704 migr_userrecord(data, el))
705 ; /* Nothing to do anymore */
706 else if (!strcasecmp(el, "user")) {
708 syslog(LOG_INFO, "Imported user: %s", usbuf.fullname);
713 else if (!strcasecmp(el, "oid_url")) safestrncpy(openid_url, ChrPtr(migr_chardata), sizeof openid_url);
714 else if (!strcasecmp(el, "oid_usernum")) openid_usernum = atol(ChrPtr(migr_chardata));
716 else if (!strcasecmp(el, "openid")) { /* see serv_openid_rp.c for a description of the record format */
719 oid_data_len = sizeof(long) + strlen(openid_url) + 1;
720 oid_data = malloc(oid_data_len);
721 memcpy(oid_data, &openid_usernum, sizeof(long));
722 memcpy(&oid_data[sizeof(long)], openid_url, strlen(openid_url) + 1);
723 cdb_store(CDB_EXTAUTH, openid_url, strlen(openid_url), oid_data, oid_data_len);
725 syslog(LOG_INFO, "Imported OpenID: %s (%ld)", openid_url, openid_usernum);
729 else if ((!strncasecmp(el, HKEY("QR"))) &&
730 migr_roomrecord(data, el))
731 ; /* Nothing to do anymore */
732 else if (!strcasecmp(el, "room")) {
734 syslog(LOG_INFO, "Imported room: %s", qrbuf.QRname);
737 /*** ROOM MESSAGE POINTERS ***/
739 else if (!strcasecmp(el, "FRname")) safestrncpy(FRname, ChrPtr(migr_chardata), sizeof FRname);
741 else if (!strcasecmp(el, "FRmsglist")) {
742 if (!IsEmptyStr(FRname)) {
744 msglist_alloc = 1000;
745 msglist = malloc(sizeof(long) * msglist_alloc);
747 syslog(LOG_DEBUG, "Message list for: %s", FRname);
749 ptr = ChrPtr(migr_chardata);
751 while ((*ptr != 0) && (!isdigit(*ptr))) {
754 if ((*ptr != 0) && (isdigit(*ptr))) {
757 if (msgcount >= msglist_alloc) {
759 msglist = realloc(msglist, sizeof(long) * msglist_alloc);
761 msglist[msgcount++] = msgnum;
764 while ((*ptr != 0) && (isdigit(*ptr))) {
770 CtdlSaveMsgPointersInRoom(FRname, msglist, msgcount, 0, NULL, 1);
775 syslog(LOG_DEBUG, "Imported %d messages.", msgcount);
776 if (server_shutting_down) {
782 else if ((!strncasecmp(el, HKEY("f_"))) &&
783 migr_floorrecord(data, el))
784 ; /* Nothing to do anymore */
786 else if (!strcasecmp(el, "floor")) {
787 CtdlPutFloor(&flbuf, floornum);
788 syslog(LOG_INFO, "Imported floor #%d (%s)", floornum, flbuf.f_name);
792 else if ((!strncasecmp(el, HKEY("v_"))) && migr_visitrecord(data, el)) {
793 ; /* Nothing to do anymore */
795 else if (!strcasecmp(el, "visit")) {
797 syslog(LOG_INFO, "Imported visit: %ld/%ld/%ld", vbuf.v_roomnum, vbuf.v_roomgen, vbuf.v_usernum);
802 else if (!strcasecmp(el, "msg_msgnum")) smi.meta_msgnum = import_msgnum = atol(ChrPtr(migr_chardata));
803 else if (!strcasecmp(el, "msg_meta_refcount")) smi.meta_refcount = atoi(ChrPtr(migr_chardata));
804 else if (!strcasecmp(el, "msg_meta_rfc822_length")) smi.meta_rfc822_length = atoi(ChrPtr(migr_chardata));
805 else if (!strcasecmp(el, "msg_meta_content_type")) safestrncpy(smi.meta_content_type, ChrPtr(migr_chardata), sizeof smi.meta_content_type);
807 else if (!strcasecmp(el, "msg_text"))
810 struct CtdlMessage *msg;
812 FlushStrBuf(migr_MsgData);
813 StrBufDecodeBase64To(migr_chardata, migr_MsgData);
815 msg = CtdlDeserializeMessage(import_msgnum, -1,
816 ChrPtr(migr_MsgData),
817 StrLength(migr_MsgData));
819 rc = CtdlSaveThisMessage(msg, import_msgnum, 0);
830 "%s message #%ld, size=%d, refcount=%d, bodylength=%ld, content-type: %s",
831 (rc!= 0)?"failed to import ":"Imported ",
833 StrLength(migr_MsgData),
835 smi.meta_rfc822_length,
836 smi.meta_content_type
838 memset(&smi, 0, sizeof(smi));
841 /*** MORE GENERAL STUFF ***/
843 FlushStrBuf(migr_chardata);
850 void migr_do_import(void) {
856 migr_chardata = NewStrBufPlain(NULL, SIZ * 20);
857 migr_MsgData = NewStrBufPlain(NULL, SIZ * 20);
858 Buf = NewStrBufPlain(NULL, SIZ);
859 xp = XML_ParserCreate(NULL);
861 cprintf("%d Failed to create XML parser instance\n", ERROR+INTERNAL_ERROR);
864 XML_SetElementHandler(xp, migr_xml_start, migr_xml_end);
865 XML_SetCharacterDataHandler(xp, migr_xml_chardata);
869 cprintf("%d sock it to me\n", SEND_LISTING);
872 client_set_inbound_buf(SIZ * 10);
874 while (!Finished && client_read_random_blob(Buf, -1) >= 0) {
875 if ((StrLength(Buf) > 4) && !strcmp(ChrPtr(Buf) + StrLength(Buf) - 4, "000\n")) {
877 StrBufCutAt(Buf, StrLength(Buf) - 4, NULL);
879 if (server_shutting_down)
880 break; // Should we break or return?
882 if (StrLength(Buf) == 0)
885 XML_Parse(xp, ChrPtr(Buf), StrLength(Buf), 0);
889 XML_Parse(xp, "", 0, 1);
892 FreeStrBuf(&migr_chardata);
893 FreeStrBuf(&migr_MsgData);
894 rebuild_euid_index();
895 rebuild_usersbynumber();
896 CtdlSetConfigInt("MM_fulltext_wordbreaker", -1); // Set an invalid wordbreaker to force re-indexing
901 /******************************************************************************
902 * Dispatcher, Common code *
903 ******************************************************************************/
905 * Dump out the pathnames of directories which can be copied "as is"
907 void migr_do_listdirs(void) {
908 cprintf("%d Don't forget these:\n", LISTING_FOLLOWS);
909 cprintf("files|%s\n", ctdl_file_dir);
910 cprintf("messages|%s\n", ctdl_message_dir);
911 cprintf("keys|%s\n", ctdl_key_dir);
916 /******************************************************************************
917 * Repair database integrity *
918 ******************************************************************************/
920 StrBuf *PlainMessageBuf = NULL;
921 HashList *UsedMessageIDS = NULL;
923 int migr_restore_message_metadata(long msgnum, int refcount)
925 CitContext *CCC = MyContext();
927 struct CtdlMessage *msg;
930 /* We can use a static buffer here because there will never be more than
931 * one of this operation happening at any given time, and it's really best
932 * to just keep it allocated once instead of torturing malloc/free.
933 * Call this function with msgnum "-1" to free the buffer when finished.
935 static int encoded_alloc = 0;
936 static char *encoded_msg = NULL;
939 if ((encoded_alloc == 0) && (encoded_msg != NULL)) {
943 // todo FreeStrBuf(&PlainMessageBuf); PlainMessageBuf = NULL;
948 if (PlainMessageBuf == NULL) {
949 PlainMessageBuf = NewStrBufPlain(NULL, 10*SIZ);
952 /* Ok, here we go ... */
954 msg = CtdlFetchMessage(msgnum, 1);
959 GetMetaData(&smi, msgnum);
960 smi.meta_msgnum = msgnum;
961 smi.meta_refcount = refcount;
963 /* restore the content type from the message body: */
964 mptr = bmstrcasestr(msg->cm_fields[eMesageText], "Content-type:");
967 safestrncpy(smi.meta_content_type, &mptr[13], sizeof smi.meta_content_type);
968 striplt(smi.meta_content_type);
969 aptr = smi.meta_content_type;
970 while (!IsEmptyStr(aptr)) {
975 memset(aptr, 0, sizeof(smi.meta_content_type) - (aptr - smi.meta_content_type));
981 CCC->redirect_buffer = PlainMessageBuf;
982 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, QP_EADDR);
983 smi.meta_rfc822_length = StrLength(CCC->redirect_buffer);
984 CCC->redirect_buffer = NULL;
987 "Setting message #%ld meta data to: refcount=%d, bodylength=%ld, content-type: %s",
990 smi.meta_rfc822_length,
991 smi.meta_content_type
1002 void migr_check_room_msg(long msgnum, void *userdata) {
1003 fprintf(migr_global_message_list, "%ld %s\n", msgnum, CC->room.QRname);
1007 void migr_check_rooms_backend(struct ctdlroom *buf, void *data) {
1009 /* message list goes inside this tag */
1011 CtdlGetRoom(&CC->room, buf->QRname);
1012 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, migr_check_room_msg, NULL);
1016 void RemoveMessagesFromRooms(StrBuf *RoomNameVec, long msgnum) {
1017 struct MetaData smi;
1018 const char *Pos = NULL;
1019 StrBuf *oneRoom = NewStrBuf();
1021 syslog(LOG_INFO, "removing message pointer %ld from these rooms: %s", msgnum, ChrPtr(RoomNameVec));
1023 while (Pos != StrBufNOTNULL){
1024 StrBufExtract_NextToken(oneRoom, RoomNameVec, &Pos, '|');
1025 CtdlDeleteMessages(ChrPtr(oneRoom), &msgnum, 1, "");
1027 GetMetaData(&smi, msgnum);
1028 AdjRefCount(msgnum, -smi.meta_refcount);
1032 void migr_do_restore_meta(void) {
1043 migr_global_message_list = fopen(migr_tempfilename1, "w");
1044 if (migr_global_message_list != NULL) {
1045 CtdlForEachRoom(migr_check_rooms_backend, NULL);
1046 fclose(migr_global_message_list);
1050 * Process the 'global' message list. (Sort it and remove dups.
1051 * Dups are ok because a message may be in more than one room, but
1052 * this will be handled by exporting the reference count, not by
1053 * exporting the message multiple times.)
1055 snprintf(cmd, sizeof cmd, "sort -n <%s >%s", migr_tempfilename1, migr_tempfilename2);
1056 if (system(cmd) != 0) syslog(LOG_ALERT, "Error %d", errno);
1058 RoomNames = NewStrBuf();
1060 migr_global_message_list = fopen(migr_tempfilename2, "r");
1061 if (migr_global_message_list != NULL) {
1062 syslog(LOG_INFO, "Opened %s", migr_tempfilename1);
1063 while ((Ctx->kill_me == 0) &&
1064 (fgets(buf, sizeof(buf), migr_global_message_list) != NULL)) {
1071 prn = strchr(buf, ' ');
1072 if (lastnum != msgnum) {
1073 failGetMessage = migr_restore_message_metadata(lastnum, refcount);
1074 if (failGetMessage) {
1075 RemoveMessagesFromRooms(RoomNames, lastnum);
1080 StrBufPlain(RoomNames, prn + 1, -1);
1082 StrBufTrim(RoomNames);
1086 if (StrLength(RoomNames) > 0) {
1087 StrBufAppendBufPlain(RoomNames, HKEY("|"), 0);
1089 StrBufAppendBufPlain(RoomNames, prn, -1, 1);
1090 StrBufTrim(RoomNames);
1096 failGetMessage = migr_restore_message_metadata(msgnum, refcount);
1097 if (failGetMessage) {
1098 RemoveMessagesFromRooms(RoomNames, lastnum);
1100 fclose(migr_global_message_list);
1103 migr_restore_message_metadata(-1L, -1); /* This frees the encoding buffer */
1104 cprintf("%d system analysis completed", CIT_OK);
1109 /******************************************************************************
1110 * Dispatcher, Common code *
1111 ******************************************************************************/
1112 void cmd_migr(char *cmdbuf) {
1115 if (CtdlAccessCheck(ac_internal)) return;
1117 if (CtdlTrySingleUser()) {
1118 CtdlDisableHouseKeeping();
1119 CtdlMakeTempFileName(migr_tempfilename1, sizeof migr_tempfilename1);
1120 CtdlMakeTempFileName(migr_tempfilename2, sizeof migr_tempfilename2);
1122 extract_token(cmd, cmdbuf, 0, '|', sizeof cmd);
1123 if (!strcasecmp(cmd, "export")) {
1126 else if (!strcasecmp(cmd, "import")) {
1129 else if (!strcasecmp(cmd, "listdirs")) {
1132 else if (!strcasecmp(cmd, "restoremeta")) {
1133 migr_do_restore_meta();
1136 cprintf("%d illegal command\n", ERROR + ILLEGAL_VALUE);
1139 unlink(migr_tempfilename1);
1140 unlink(migr_tempfilename2);
1142 CtdlEnableHouseKeeping();
1143 CtdlEndSingleUser();
1146 cprintf("%d The migrator is already running.\n", ERROR + RESOURCE_BUSY);
1151 /******************************************************************************
1153 ******************************************************************************/
1155 CTDL_MODULE_INIT(migrate)
1159 CtdlRegisterProtoHook(cmd_migr, "MIGR", "Across-the-wire migration");
1162 /* return our module name for the log */