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>
43 #include <libcitadel.h>
46 #include "citserver.h"
52 #include "euidindex.h"
53 #include "ctdl_module.h"
55 #define END_OF_MESSAGE "---eom---dbd---"
57 char migr_tempfilename1[PATH_MAX];
58 char migr_tempfilename2[PATH_MAX];
59 FILE *migr_global_message_list;
61 char *ikey = NULL; // If we're importing a config key we store it here.
64 /******************************************************************************
65 * Code which implements the export appears in this section *
66 ******************************************************************************/
69 * Output a string to the client with these characters escaped: & < > " '
71 void xml_strout(char *str) {
81 client_write(HKEY("""));
83 else if (*c == '\'') {
84 client_write(HKEY("'"));
87 client_write(HKEY("<"));
90 client_write(HKEY(">"));
93 client_write(HKEY("&"));
104 * Export a user record as XML
106 void migr_export_users_backend(char *username, void *data) {
109 if (CtdlGetUser(&u, username) != 0) {
113 client_write(HKEY("<user>\n"));
114 cprintf("<u_version>%d</u_version>\n", u.version);
115 cprintf("<u_uid>%ld</u_uid>\n", (long)u.uid);
116 client_write(HKEY("<u_password>")); xml_strout(u.password); client_write(HKEY("</u_password>\n"));
117 cprintf("<u_flags>%u</u_flags>\n", u.flags);
118 cprintf("<u_timescalled>%ld</u_timescalled>\n", u.timescalled);
119 cprintf("<u_posted>%ld</u_posted>\n", u.posted);
120 cprintf("<u_axlevel>%d</u_axlevel>\n", u.axlevel);
121 cprintf("<u_usernum>%ld</u_usernum>\n", u.usernum);
122 cprintf("<u_lastcall>%ld</u_lastcall>\n", (long)u.lastcall);
123 cprintf("<u_USuserpurge>%d</u_USuserpurge>\n", u.USuserpurge);
124 client_write(HKEY("<u_fullname>")); xml_strout(u.fullname); client_write(HKEY("</u_fullname>\n"));
125 cprintf("<u_msgnum_bio>%ld</u_msgnum_bio>\n", u.msgnum_bio);
126 cprintf("<u_msgnum_pic>%ld</u_msgnum_pic>\n", u.msgnum_pic);
127 cprintf("<u_emailaddrs>%s</u_emailaddrs>\n", u.emailaddrs);
128 cprintf("<u_msgnum_inboxrules>%ld</u_msgnum_inboxrules>\n", u.msgnum_inboxrules);
129 cprintf("<u_lastproc_inboxrules>%ld</u_lastproc_inboxrules>\n", u.lastproc_inboxrules);
130 client_write(HKEY("</user>\n"));
134 void migr_export_users(void) {
135 ForEachUser(migr_export_users_backend, NULL);
139 void migr_export_room_msg(long msgnum, void *userdata) {
140 cprintf("%ld\n", msgnum);
141 fprintf(migr_global_message_list, "%ld\n", msgnum);
145 void migr_export_rooms_backend(struct ctdlroom *buf, void *data) {
146 client_write(HKEY("<room>\n"));
147 client_write(HKEY("<QRname>")); xml_strout(buf->QRname); client_write(HKEY("</QRname>\n"));
148 client_write(HKEY("<QRpasswd>")); xml_strout(buf->QRpasswd); client_write(HKEY("</QRpasswd>\n"));
149 cprintf("<QRroomaide>%ld</QRroomaide>\n", buf->QRroomaide);
150 cprintf("<QRhighest>%ld</QRhighest>\n", buf->QRhighest);
151 cprintf("<QRgen>%ld</QRgen>\n", (long)buf->QRgen);
152 cprintf("<QRflags>%u</QRflags>\n", buf->QRflags);
153 if (buf->QRflags & QR_DIRECTORY) {
154 client_write(HKEY("<QRdirname>"));
155 xml_strout(buf->QRdirname);
156 client_write(HKEY("</QRdirname>\n"));
158 cprintf("<QRfloor>%d</QRfloor>\n", buf->QRfloor);
159 cprintf("<QRmtime>%ld</QRmtime>\n", (long)buf->QRmtime);
160 cprintf("<QRexpire_mode>%d</QRexpire_mode>\n", buf->QRep.expire_mode);
161 cprintf("<QRexpire_value>%d</QRexpire_value>\n", buf->QRep.expire_value);
162 cprintf("<QRnumber>%ld</QRnumber>\n", buf->QRnumber);
163 cprintf("<QRorder>%d</QRorder>\n", buf->QRorder);
164 cprintf("<QRflags2>%u</QRflags2>\n", buf->QRflags2);
165 cprintf("<QRdefaultview>%d</QRdefaultview>\n", buf->QRdefaultview);
166 cprintf("<msgnum_info>%ld</msgnum_info>\n", buf->msgnum_info);
167 cprintf("<msgnum_pic>%ld</msgnum_pic>\n", buf->msgnum_pic);
168 client_write(HKEY("</room>\n"));
170 /* message list goes inside this tag */
172 CtdlGetRoom(&CC->room, buf->QRname);
173 client_write(HKEY("<room_messages>"));
174 client_write(HKEY("<FRname>")); xml_strout(CC->room.QRname); client_write(HKEY("</FRname>\n"));
175 client_write(HKEY("<FRmsglist>"));
176 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, migr_export_room_msg, NULL);
177 client_write(HKEY("</FRmsglist>\n"));
178 client_write(HKEY("</room_messages>\n"));
184 void migr_export_rooms(void) {
186 migr_global_message_list = fopen(migr_tempfilename1, "w");
187 if (migr_global_message_list != NULL) {
188 CtdlForEachRoom(migr_export_rooms_backend, NULL);
189 fclose(migr_global_message_list);
193 * Process the 'global' message list. (Sort it and remove dups.
194 * Dups are ok because a message may be in more than one room, but
195 * this will be handled by exporting the reference count, not by
196 * exporting the message multiple times.)
198 snprintf(cmd, sizeof cmd, "sort -n <%s >%s", migr_tempfilename1, migr_tempfilename2);
199 if (system(cmd) != 0) syslog(LOG_ALERT, "Error %d", errno);
200 snprintf(cmd, sizeof cmd, "uniq <%s >%s", migr_tempfilename2, migr_tempfilename1);
201 if (system(cmd) != 0) syslog(LOG_ALERT, "Error %d", errno);
204 snprintf(cmd, sizeof cmd, "wc -l %s", migr_tempfilename1);
205 FILE *fp = popen(cmd, "r");
207 fgets(cmd, sizeof cmd, fp);
209 total_msgs = atoi(cmd);
212 total_msgs = 1; // any nonzero just to keep it from barfing
214 syslog(LOG_DEBUG, "Total messages to be exported: %d", total_msgs);
218 void migr_export_floors(void) {
219 struct floor qfbuf, *buf;
222 for (i=0; i < MAXFLOORS; ++i) {
223 client_write(HKEY("<floor>\n"));
224 cprintf("<f_num>%d</f_num>\n", i);
225 CtdlGetFloor(&qfbuf, i);
227 cprintf("<f_flags>%u</f_flags>\n", buf->f_flags);
228 client_write(HKEY("<f_name>")); xml_strout(buf->f_name); client_write(HKEY("</f_name>\n"));
229 cprintf("<f_ref_count>%d</f_ref_count>\n", buf->f_ref_count);
230 cprintf("<f_ep_expire_mode>%d</f_ep_expire_mode>\n", buf->f_ep.expire_mode);
231 cprintf("<f_ep_expire_value>%d</f_ep_expire_value>\n", buf->f_ep.expire_value);
232 client_write(HKEY("</floor>\n"));
238 * Return nonzero if the supplied string contains only characters which are valid in a sequence set.
240 int is_sequence_set(char *s) {
245 while (ch = *c++, ch) {
246 if (!strchr("0123456789*,:", ch)) {
255 * Traverse the visits file...
257 void migr_export_visits(void) {
259 struct cdbdata *cdbv;
261 cdb_rewind(CDB_VISIT);
263 while (cdbv = cdb_next_item(CDB_VISIT), cdbv != NULL) {
264 memset(&vbuf, 0, sizeof(visit));
265 memcpy(&vbuf, cdbv->ptr,
266 ((cdbv->len > sizeof(visit)) ?
267 sizeof(visit) : cdbv->len));
270 client_write(HKEY("<visit>\n"));
271 cprintf("<v_roomnum>%ld</v_roomnum>\n", vbuf.v_roomnum);
272 cprintf("<v_roomgen>%ld</v_roomgen>\n", vbuf.v_roomgen);
273 cprintf("<v_usernum>%ld</v_usernum>\n", vbuf.v_usernum);
275 client_write(HKEY("<v_seen>"));
276 if ( (!IsEmptyStr(vbuf.v_seen)) && (is_sequence_set(vbuf.v_seen)) ) {
277 xml_strout(vbuf.v_seen);
280 cprintf("%ld", vbuf.v_lastseen);
282 client_write(HKEY("</v_seen>"));
284 if ( (!IsEmptyStr(vbuf.v_answered)) && (is_sequence_set(vbuf.v_answered)) ) {
285 client_write(HKEY("<v_answered>"));
286 xml_strout(vbuf.v_answered);
287 client_write(HKEY("</v_answered>\n"));
290 cprintf("<v_flags>%u</v_flags>\n", vbuf.v_flags);
291 cprintf("<v_view>%d</v_view>\n", vbuf.v_view);
292 client_write(HKEY("</visit>\n"));
297 void migr_export_message(long msgnum) {
299 struct CtdlMessage *msg;
302 /* We can use a static buffer here because there will never be more than
303 * one of this operation happening at any given time, and it's really best
304 * to just keep it allocated once instead of torturing malloc/free.
305 * Call this function with msgnum "-1" to free the buffer when finished.
307 static int encoded_alloc = 0;
308 static char *encoded_msg = NULL;
311 if ((encoded_alloc == 0) && (encoded_msg != NULL)) {
319 /* Ok, here we go ... */
321 msg = CtdlFetchMessage(msgnum, 1);
322 if (msg == NULL) return; /* fail silently */
324 client_write(HKEY("<message>\n"));
325 GetMetaData(&smi, msgnum);
326 cprintf("<msg_msgnum>%ld</msg_msgnum>\n", msgnum);
327 cprintf("<msg_meta_refcount>%d</msg_meta_refcount>\n", smi.meta_refcount);
328 cprintf("<msg_meta_rfc822_length>%ld</msg_meta_rfc822_length>\n", smi.meta_rfc822_length);
329 client_write(HKEY("<msg_meta_content_type>")); xml_strout(smi.meta_content_type); client_write(HKEY("</msg_meta_content_type>\n"));
331 client_write(HKEY("<msg_text>"));
332 CtdlSerializeMessage(&smr, msg);
335 /* Predict the buffer size we need. Expand the buffer if necessary. */
336 int encoded_len = smr.len * 15 / 10 ;
337 if (encoded_len > encoded_alloc) {
338 encoded_alloc = encoded_len;
339 encoded_msg = realloc(encoded_msg, encoded_alloc);
342 if (encoded_msg == NULL) {
343 /* Questionable hack that hopes it'll work next time and we only lose one message */
347 /* Once we do the encoding we know the exact size */
348 encoded_len = CtdlEncodeBase64(encoded_msg, (char *)smr.ser, smr.len, 1);
349 client_write(encoded_msg, encoded_len);
354 client_write(HKEY("</msg_text>\n"));
355 client_write(HKEY("</message>\n"));
359 void migr_export_openids(void) {
360 struct cdbdata *cdboi;
364 cdb_rewind(CDB_EXTAUTH);
365 while (cdboi = cdb_next_item(CDB_EXTAUTH), cdboi != NULL) {
366 if (cdboi->len > sizeof(long)) {
367 client_write(HKEY("<openid>\n"));
368 memcpy(&usernum, cdboi->ptr, sizeof(long));
369 snprintf(url, sizeof url, "%s", (cdboi->ptr)+sizeof(long) );
370 client_write(HKEY("<oid_url>"));
372 client_write(HKEY("</oid_url>\n"));
373 cprintf("<oid_usernum>%ld</oid_usernum>\n", usernum);
374 client_write(HKEY("</openid>\n"));
381 void migr_export_configs(void) {
382 struct cdbdata *cdbcfg;
387 cdb_rewind(CDB_CONFIG);
388 while (cdbcfg = cdb_next_item(CDB_CONFIG), cdbcfg != NULL) {
390 keylen = strlen(cdbcfg->ptr);
392 value = cdbcfg->ptr + keylen + 1;
394 client_write("<config key=\"", 13);
396 client_write("\">", 2);
398 client_write("</config>\n", 10);
404 void migr_export_messages(void) {
409 int prev_progress = 0;
413 migr_global_message_list = fopen(migr_tempfilename1, "r");
414 if (migr_global_message_list != NULL) {
415 syslog(LOG_INFO, "Opened %s", migr_tempfilename1);
416 while ((Ctx->kill_me == 0) &&
417 (fgets(buf, sizeof(buf), migr_global_message_list) != NULL)) {
420 migr_export_message(msgnum);
423 progress = (count * 74 / total_msgs) + 25 ;
424 if ((progress > prev_progress) && (progress < 100)) {
425 cprintf("<progress>%d</progress>\n", progress);
427 prev_progress = progress;
429 fclose(migr_global_message_list);
431 if (Ctx->kill_me == 0) {
432 syslog(LOG_INFO, "Exported %d messages.", count);
435 syslog(LOG_ERR, "Export aborted due to client disconnect!");
438 migr_export_message(-1L); /* This frees the encoding buffer */
442 void migr_do_export(void) {
446 cprintf("%d Exporting all Citadel databases.\n", LISTING_FOLLOWS);
449 client_write(HKEY("<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n"));
450 client_write(HKEY("<citadel_migrate_data>\n"));
451 cprintf("<version>%d</version>\n", REV_LEVEL);
452 cprintf("<progress>%d</progress>\n", 0);
454 /* export the configuration database */
455 migr_export_configs();
456 cprintf("<progress>%d</progress>\n", 2);
458 if (Ctx->kill_me == 0) migr_export_users();
459 cprintf("<progress>%d</progress>\n", 7);
460 if (Ctx->kill_me == 0) migr_export_openids();
461 cprintf("<progress>%d</progress>\n", 12);
462 if (Ctx->kill_me == 0) migr_export_rooms();
463 cprintf("<progress>%d</progress>\n", 17);
464 if (Ctx->kill_me == 0) migr_export_floors();
465 cprintf("<progress>%d</progress>\n", 18);
466 if (Ctx->kill_me == 0) migr_export_visits();
467 cprintf("<progress>%d</progress>\n", 25);
468 if (Ctx->kill_me == 0) migr_export_messages();
469 client_write(HKEY("</citadel_migrate_data>\n"));
470 cprintf("<progress>%d</progress>\n", 100);
471 client_write(HKEY("000\n"));
476 /******************************************************************************
478 * Here's the code that implements the import side. It's going to end up *
479 * being one big loop with lots of global variables. I don't care. *
480 * You wouldn't run multiple concurrent imports anyway. If this offends your *
481 * delicate sensibilities then go rewrite it in Ruby on Rails or something. *
482 ******************************************************************************/
485 int citadel_migrate_data = 0; /* Are we inside a <citadel_migrate_data> tag pair? */
486 StrBuf *migr_chardata = NULL;
487 StrBuf *migr_MsgData = NULL;
488 struct ctdluser usbuf;
489 struct ctdlroom qrbuf;
490 char openid_url[512];
491 long openid_usernum = 0;
492 char FRname[ROOMNAMELEN];
497 long import_msgnum = 0;
500 * This callback stores up the data which appears in between tags.
502 void migr_xml_chardata(void *data, const XML_Char *s, int len)
504 StrBufAppendBufPlain(migr_chardata, s, len, 0);
508 void migr_xml_start(void *data, const char *el, const char **attr) {
511 /*** GENERAL STUFF ***/
513 /* Reset chardata_len to zero and init buffer */
514 FlushStrBuf(migr_chardata);
515 FlushStrBuf(migr_MsgData);
517 if (!strcasecmp(el, "citadel_migrate_data")) {
518 ++citadel_migrate_data;
520 /* As soon as it looks like the input data is a genuine Citadel XML export,
521 * whack the existing database on disk to make room for the new one.
523 if (citadel_migrate_data == 1) {
524 for (i = 0; i < MAXCDB; ++i) {
531 if (citadel_migrate_data != 1) {
532 syslog(LOG_ALERT, "Out-of-sequence tag <%s> detected. Warning: ODD-DATA!", el);
536 /* When we begin receiving XML for one of these record types, clear out the associated
537 * buffer so we don't accidentally carry over any data from a previous record.
539 if (!strcasecmp(el, "user")) memset(&usbuf, 0, sizeof (struct ctdluser));
540 else if (!strcasecmp(el, "openid")) memset(openid_url, 0, sizeof openid_url);
541 else if (!strcasecmp(el, "room")) memset(&qrbuf, 0, sizeof (struct ctdlroom));
542 else if (!strcasecmp(el, "room_messages")) memset(FRname, 0, sizeof FRname);
543 else if (!strcasecmp(el, "floor")) memset(&flbuf, 0, sizeof (struct floor));
544 else if (!strcasecmp(el, "visit")) memset(&vbuf, 0, sizeof (visit));
546 else if (!strcasecmp(el, "message")) {
547 memset(&smi, 0, sizeof (struct MetaData));
550 else if (!strcasecmp(el, "config")) {
556 if (!strcasecmp(attr[0], "key")) {
557 ikey = strdup(attr[1]);
566 int migr_userrecord(void *data, const char *el)
568 if (!strcasecmp(el, "u_version")) usbuf.version = atoi(ChrPtr(migr_chardata));
569 else if (!strcasecmp(el, "u_uid")) usbuf.uid = atol(ChrPtr(migr_chardata));
570 else if (!strcasecmp(el, "u_password")) safestrncpy(usbuf.password, ChrPtr(migr_chardata), sizeof usbuf.password);
571 else if (!strcasecmp(el, "u_flags")) usbuf.flags = atoi(ChrPtr(migr_chardata));
572 else if (!strcasecmp(el, "u_timescalled")) usbuf.timescalled = atol(ChrPtr(migr_chardata));
573 else if (!strcasecmp(el, "u_posted")) usbuf.posted = atol(ChrPtr(migr_chardata));
574 else if (!strcasecmp(el, "u_axlevel")) usbuf.axlevel = atoi(ChrPtr(migr_chardata));
575 else if (!strcasecmp(el, "u_usernum")) usbuf.usernum = atol(ChrPtr(migr_chardata));
576 else if (!strcasecmp(el, "u_lastcall")) usbuf.lastcall = atol(ChrPtr(migr_chardata));
577 else if (!strcasecmp(el, "u_USuserpurge")) usbuf.USuserpurge = atoi(ChrPtr(migr_chardata));
578 else if (!strcasecmp(el, "u_fullname")) safestrncpy(usbuf.fullname, ChrPtr(migr_chardata), sizeof usbuf.fullname);
579 else if (!strcasecmp(el, "u_msgnum_bio")) usbuf.msgnum_bio = atol(ChrPtr(migr_chardata));
580 else if (!strcasecmp(el, "u_msgnum_pic")) usbuf.msgnum_pic = atol(ChrPtr(migr_chardata));
581 else if (!strcasecmp(el, "u_emailaddrs")) safestrncpy(usbuf.emailaddrs, ChrPtr(migr_chardata), sizeof usbuf.emailaddrs);
582 else if (!strcasecmp(el, "u_msgnum_inboxrules")) usbuf.msgnum_inboxrules = atol(ChrPtr(migr_chardata));
583 else if (!strcasecmp(el, "u_lastproc_inboxrules")) usbuf.lastproc_inboxrules = atol(ChrPtr(migr_chardata));
589 int migr_roomrecord(void *data, const char *el)
591 if (!strcasecmp(el, "QRname")) safestrncpy(qrbuf.QRname, ChrPtr(migr_chardata), sizeof qrbuf.QRname);
592 else if (!strcasecmp(el, "QRpasswd")) safestrncpy(qrbuf.QRpasswd, ChrPtr(migr_chardata), sizeof qrbuf.QRpasswd);
593 else if (!strcasecmp(el, "QRroomaide")) qrbuf.QRroomaide = atol(ChrPtr(migr_chardata));
594 else if (!strcasecmp(el, "QRhighest")) qrbuf.QRhighest = atol(ChrPtr(migr_chardata));
595 else if (!strcasecmp(el, "QRgen")) qrbuf.QRgen = atol(ChrPtr(migr_chardata));
596 else if (!strcasecmp(el, "QRflags")) qrbuf.QRflags = atoi(ChrPtr(migr_chardata));
597 else if (!strcasecmp(el, "QRdirname")) safestrncpy(qrbuf.QRdirname, ChrPtr(migr_chardata), sizeof qrbuf.QRdirname);
598 else if (!strcasecmp(el, "QRfloor")) qrbuf.QRfloor = atoi(ChrPtr(migr_chardata));
599 else if (!strcasecmp(el, "QRmtime")) qrbuf.QRmtime = atol(ChrPtr(migr_chardata));
600 else if (!strcasecmp(el, "QRexpire_mode")) qrbuf.QRep.expire_mode = atoi(ChrPtr(migr_chardata));
601 else if (!strcasecmp(el, "QRexpire_value")) qrbuf.QRep.expire_value = atoi(ChrPtr(migr_chardata));
602 else if (!strcasecmp(el, "QRnumber")) qrbuf.QRnumber = atol(ChrPtr(migr_chardata));
603 else if (!strcasecmp(el, "QRorder")) qrbuf.QRorder = atoi(ChrPtr(migr_chardata));
604 else if (!strcasecmp(el, "QRflags2")) qrbuf.QRflags2 = atoi(ChrPtr(migr_chardata));
605 else if (!strcasecmp(el, "QRdefaultview")) qrbuf.QRdefaultview = atoi(ChrPtr(migr_chardata));
606 else if (!strcasecmp(el, "msgnum_info")) qrbuf.msgnum_info = atol(ChrPtr(migr_chardata));
607 else if (!strcasecmp(el, "msgnum_pic")) qrbuf.msgnum_pic = atol(ChrPtr(migr_chardata));
613 int migr_floorrecord(void *data, const char *el)
615 if (!strcasecmp(el, "f_num")) floornum = atoi(ChrPtr(migr_chardata));
616 else if (!strcasecmp(el, "f_flags")) flbuf.f_flags = atoi(ChrPtr(migr_chardata));
617 else if (!strcasecmp(el, "f_name")) safestrncpy(flbuf.f_name, ChrPtr(migr_chardata), sizeof flbuf.f_name);
618 else if (!strcasecmp(el, "f_ref_count")) flbuf.f_ref_count = atoi(ChrPtr(migr_chardata));
619 else if (!strcasecmp(el, "f_ep_expire_mode")) flbuf.f_ep.expire_mode = atoi(ChrPtr(migr_chardata));
620 else if (!strcasecmp(el, "f_ep_expire_value")) flbuf.f_ep.expire_value = atoi(ChrPtr(migr_chardata));
626 int migr_visitrecord(void *data, const char *el)
628 if (!strcasecmp(el, "v_roomnum")) vbuf.v_roomnum = atol(ChrPtr(migr_chardata));
629 else if (!strcasecmp(el, "v_roomgen")) vbuf.v_roomgen = atol(ChrPtr(migr_chardata));
630 else if (!strcasecmp(el, "v_usernum")) vbuf.v_usernum = atol(ChrPtr(migr_chardata));
632 else if (!strcasecmp(el, "v_seen")) {
633 int is_textual_seen = 0;
635 int max = StrLength(migr_chardata);
637 vbuf.v_lastseen = atol(ChrPtr(migr_chardata));
639 for (i=0; i < max; ++i)
640 if (!isdigit(ChrPtr(migr_chardata)[i]))
643 safestrncpy(vbuf.v_seen, ChrPtr(migr_chardata), sizeof vbuf.v_seen);
646 else if (!strcasecmp(el, "v_answered")) safestrncpy(vbuf.v_answered, ChrPtr(migr_chardata), sizeof vbuf.v_answered);
647 else if (!strcasecmp(el, "v_flags")) vbuf.v_flags = atoi(ChrPtr(migr_chardata));
648 else if (!strcasecmp(el, "v_view")) vbuf.v_view = atoi(ChrPtr(migr_chardata));
654 void migr_xml_end(void *data, const char *el)
659 long *msglist = NULL;
660 int msglist_alloc = 0;
661 /*** GENERAL STUFF ***/
663 if (!strcasecmp(el, "citadel_migrate_data")) {
664 --citadel_migrate_data;
668 if (citadel_migrate_data != 1) {
669 syslog(LOG_ALERT, "Out-of-sequence tag <%s> detected. Warning: ODD-DATA!", el);
673 // syslog(LOG_DEBUG, "END TAG: <%s> DATA: <%s>\n", el, (migr_chardata_len ? migr_chardata : ""));
677 if (!strcasecmp(el, "config"))
679 syslog(LOG_DEBUG, "Imported config key=%s", ikey);
682 CtdlSetConfigStr(ikey, (char *)ChrPtr(migr_chardata));
687 syslog(LOG_INFO, "Closed a <config> tag but no key name was supplied.");
692 else if ((!strncasecmp(el, HKEY("u_"))) &&
693 migr_userrecord(data, el))
694 ; /* Nothing to do anymore */
695 else if (!strcasecmp(el, "user")) {
697 syslog(LOG_INFO, "Imported user: %s", usbuf.fullname);
702 else if (!strcasecmp(el, "oid_url")) safestrncpy(openid_url, ChrPtr(migr_chardata), sizeof openid_url);
703 else if (!strcasecmp(el, "oid_usernum")) openid_usernum = atol(ChrPtr(migr_chardata));
705 else if (!strcasecmp(el, "openid")) { /* see serv_openid_rp.c for a description of the record format */
708 oid_data_len = sizeof(long) + strlen(openid_url) + 1;
709 oid_data = malloc(oid_data_len);
710 memcpy(oid_data, &openid_usernum, sizeof(long));
711 memcpy(&oid_data[sizeof(long)], openid_url, strlen(openid_url) + 1);
712 cdb_store(CDB_EXTAUTH, openid_url, strlen(openid_url), oid_data, oid_data_len);
714 syslog(LOG_INFO, "Imported OpenID: %s (%ld)", openid_url, openid_usernum);
718 else if ((!strncasecmp(el, HKEY("QR"))) &&
719 migr_roomrecord(data, el))
720 ; /* Nothing to do anymore */
721 else if (!strcasecmp(el, "room")) {
723 syslog(LOG_INFO, "Imported room: %s", qrbuf.QRname);
726 /*** ROOM MESSAGE POINTERS ***/
728 else if (!strcasecmp(el, "FRname")) safestrncpy(FRname, ChrPtr(migr_chardata), sizeof FRname);
730 else if (!strcasecmp(el, "FRmsglist")) {
731 if (!IsEmptyStr(FRname)) {
733 msglist_alloc = 1000;
734 msglist = malloc(sizeof(long) * msglist_alloc);
736 syslog(LOG_DEBUG, "Message list for: %s", FRname);
738 ptr = ChrPtr(migr_chardata);
740 while ((*ptr != 0) && (!isdigit(*ptr))) {
743 if ((*ptr != 0) && (isdigit(*ptr))) {
746 if (msgcount >= msglist_alloc) {
748 msglist = realloc(msglist, sizeof(long) * msglist_alloc);
750 msglist[msgcount++] = msgnum;
753 while ((*ptr != 0) && (isdigit(*ptr))) {
759 CtdlSaveMsgPointersInRoom(FRname, msglist, msgcount, 0, NULL, 1);
764 syslog(LOG_DEBUG, "Imported %d messages.", msgcount);
765 if (server_shutting_down) {
771 else if ((!strncasecmp(el, HKEY("f_"))) &&
772 migr_floorrecord(data, el))
773 ; /* Nothing to do anymore */
775 else if (!strcasecmp(el, "floor")) {
776 CtdlPutFloor(&flbuf, floornum);
777 syslog(LOG_INFO, "Imported floor #%d (%s)", floornum, flbuf.f_name);
781 else if ((!strncasecmp(el, HKEY("v_"))) && migr_visitrecord(data, el)) {
782 ; /* Nothing to do anymore */
784 else if (!strcasecmp(el, "visit")) {
786 syslog(LOG_INFO, "Imported visit: %ld/%ld/%ld", vbuf.v_roomnum, vbuf.v_roomgen, vbuf.v_usernum);
791 else if (!strcasecmp(el, "msg_msgnum")) smi.meta_msgnum = import_msgnum = atol(ChrPtr(migr_chardata));
792 else if (!strcasecmp(el, "msg_meta_refcount")) smi.meta_refcount = atoi(ChrPtr(migr_chardata));
793 else if (!strcasecmp(el, "msg_meta_rfc822_length")) smi.meta_rfc822_length = atoi(ChrPtr(migr_chardata));
794 else if (!strcasecmp(el, "msg_meta_content_type")) safestrncpy(smi.meta_content_type, ChrPtr(migr_chardata), sizeof smi.meta_content_type);
796 else if (!strcasecmp(el, "msg_text"))
799 struct CtdlMessage *msg;
801 FlushStrBuf(migr_MsgData);
802 StrBufDecodeBase64To(migr_chardata, migr_MsgData);
804 msg = CtdlDeserializeMessage(import_msgnum, -1,
805 ChrPtr(migr_MsgData),
806 StrLength(migr_MsgData));
808 rc = CtdlSaveThisMessage(msg, import_msgnum, 0);
819 "%s message #%ld, size=%d, refcount=%d, bodylength=%ld, content-type: %s",
820 (rc!= 0)?"failed to import ":"Imported ",
822 StrLength(migr_MsgData),
824 smi.meta_rfc822_length,
825 smi.meta_content_type
827 memset(&smi, 0, sizeof(smi));
830 /*** MORE GENERAL STUFF ***/
832 FlushStrBuf(migr_chardata);
839 void migr_do_import(void) {
845 migr_chardata = NewStrBufPlain(NULL, SIZ * 20);
846 migr_MsgData = NewStrBufPlain(NULL, SIZ * 20);
847 Buf = NewStrBufPlain(NULL, SIZ);
848 xp = XML_ParserCreate(NULL);
850 cprintf("%d Failed to create XML parser instance\n", ERROR+INTERNAL_ERROR);
853 XML_SetElementHandler(xp, migr_xml_start, migr_xml_end);
854 XML_SetCharacterDataHandler(xp, migr_xml_chardata);
858 cprintf("%d sock it to me\n", SEND_LISTING);
861 client_set_inbound_buf(SIZ * 10);
863 while (!Finished && client_read_random_blob(Buf, -1) >= 0) {
864 if ((StrLength(Buf) > 4) && !strcmp(ChrPtr(Buf) + StrLength(Buf) - 4, "000\n")) {
866 StrBufCutAt(Buf, StrLength(Buf) - 4, NULL);
868 if (server_shutting_down)
869 break; // Should we break or return?
871 if (StrLength(Buf) == 0)
874 XML_Parse(xp, ChrPtr(Buf), StrLength(Buf), 0);
878 XML_Parse(xp, "", 0, 1);
881 FreeStrBuf(&migr_chardata);
882 FreeStrBuf(&migr_MsgData);
883 rebuild_euid_index();
884 rebuild_usersbynumber();
885 CtdlSetConfigInt("MM_fulltext_wordbreaker", -1); // Set an invalid wordbreaker to force re-indexing
890 /******************************************************************************
891 * Dispatcher, Common code *
892 ******************************************************************************/
894 * Dump out the pathnames of directories which can be copied "as is"
896 void migr_do_listdirs(void) {
897 cprintf("%d Don't forget these:\n", LISTING_FOLLOWS);
898 cprintf("files|%s\n", ctdl_file_dir);
899 cprintf("messages|%s\n", ctdl_message_dir);
900 cprintf("keys|%s\n", ctdl_key_dir);
905 /******************************************************************************
906 * Repair database integrity *
907 ******************************************************************************/
909 StrBuf *PlainMessageBuf = NULL;
910 HashList *UsedMessageIDS = NULL;
912 int migr_restore_message_metadata(long msgnum, int refcount)
914 CitContext *CCC = MyContext();
916 struct CtdlMessage *msg;
919 /* We can use a static buffer here because there will never be more than
920 * one of this operation happening at any given time, and it's really best
921 * to just keep it allocated once instead of torturing malloc/free.
922 * Call this function with msgnum "-1" to free the buffer when finished.
924 static int encoded_alloc = 0;
925 static char *encoded_msg = NULL;
928 if ((encoded_alloc == 0) && (encoded_msg != NULL)) {
932 // todo FreeStrBuf(&PlainMessageBuf); PlainMessageBuf = NULL;
937 if (PlainMessageBuf == NULL) {
938 PlainMessageBuf = NewStrBufPlain(NULL, 10*SIZ);
941 /* Ok, here we go ... */
943 msg = CtdlFetchMessage(msgnum, 1);
948 GetMetaData(&smi, msgnum);
949 smi.meta_msgnum = msgnum;
950 smi.meta_refcount = refcount;
952 /* restore the content type from the message body: */
953 mptr = bmstrcasestr(msg->cm_fields[eMesageText], "Content-type:");
956 safestrncpy(smi.meta_content_type, &mptr[13], sizeof smi.meta_content_type);
957 striplt(smi.meta_content_type);
958 aptr = smi.meta_content_type;
959 while (!IsEmptyStr(aptr)) {
964 memset(aptr, 0, sizeof(smi.meta_content_type) - (aptr - smi.meta_content_type));
970 CCC->redirect_buffer = PlainMessageBuf;
971 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, QP_EADDR);
972 smi.meta_rfc822_length = StrLength(CCC->redirect_buffer);
973 CCC->redirect_buffer = NULL;
976 "Setting message #%ld meta data to: refcount=%d, bodylength=%ld, content-type: %s",
979 smi.meta_rfc822_length,
980 smi.meta_content_type
991 void migr_check_room_msg(long msgnum, void *userdata) {
992 fprintf(migr_global_message_list, "%ld %s\n", msgnum, CC->room.QRname);
996 void migr_check_rooms_backend(struct ctdlroom *buf, void *data) {
998 /* message list goes inside this tag */
1000 CtdlGetRoom(&CC->room, buf->QRname);
1001 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, migr_check_room_msg, NULL);
1005 void RemoveMessagesFromRooms(StrBuf *RoomNameVec, long msgnum) {
1006 struct MetaData smi;
1007 const char *Pos = NULL;
1008 StrBuf *oneRoom = NewStrBuf();
1010 syslog(LOG_INFO, "removing message pointer %ld from these rooms: %s", msgnum, ChrPtr(RoomNameVec));
1012 while (Pos != StrBufNOTNULL){
1013 StrBufExtract_NextToken(oneRoom, RoomNameVec, &Pos, '|');
1014 CtdlDeleteMessages(ChrPtr(oneRoom), &msgnum, 1, "");
1016 GetMetaData(&smi, msgnum);
1017 AdjRefCount(msgnum, -smi.meta_refcount);
1021 void migr_do_restore_meta(void) {
1032 migr_global_message_list = fopen(migr_tempfilename1, "w");
1033 if (migr_global_message_list != NULL) {
1034 CtdlForEachRoom(migr_check_rooms_backend, NULL);
1035 fclose(migr_global_message_list);
1039 * Process the 'global' message list. (Sort it and remove dups.
1040 * Dups are ok because a message may be in more than one room, but
1041 * this will be handled by exporting the reference count, not by
1042 * exporting the message multiple times.)
1044 snprintf(cmd, sizeof cmd, "sort -n <%s >%s", migr_tempfilename1, migr_tempfilename2);
1045 if (system(cmd) != 0) syslog(LOG_ALERT, "Error %d", errno);
1047 RoomNames = NewStrBuf();
1049 migr_global_message_list = fopen(migr_tempfilename2, "r");
1050 if (migr_global_message_list != NULL) {
1051 syslog(LOG_INFO, "Opened %s", migr_tempfilename1);
1052 while ((Ctx->kill_me == 0) &&
1053 (fgets(buf, sizeof(buf), migr_global_message_list) != NULL)) {
1060 prn = strchr(buf, ' ');
1061 if (lastnum != msgnum) {
1062 failGetMessage = migr_restore_message_metadata(lastnum, refcount);
1063 if (failGetMessage) {
1064 RemoveMessagesFromRooms(RoomNames, lastnum);
1069 StrBufPlain(RoomNames, prn + 1, -1);
1071 StrBufTrim(RoomNames);
1075 if (StrLength(RoomNames) > 0) {
1076 StrBufAppendBufPlain(RoomNames, HKEY("|"), 0);
1078 StrBufAppendBufPlain(RoomNames, prn, -1, 1);
1079 StrBufTrim(RoomNames);
1085 failGetMessage = migr_restore_message_metadata(msgnum, refcount);
1086 if (failGetMessage) {
1087 RemoveMessagesFromRooms(RoomNames, lastnum);
1089 fclose(migr_global_message_list);
1092 migr_restore_message_metadata(-1L, -1); /* This frees the encoding buffer */
1093 cprintf("%d system analysis completed", CIT_OK);
1098 /******************************************************************************
1099 * Dispatcher, Common code *
1100 ******************************************************************************/
1101 void cmd_migr(char *cmdbuf) {
1104 if (CtdlAccessCheck(ac_internal)) return;
1106 if (CtdlTrySingleUser()) {
1107 CtdlDisableHouseKeeping();
1108 CtdlMakeTempFileName(migr_tempfilename1, sizeof migr_tempfilename1);
1109 CtdlMakeTempFileName(migr_tempfilename2, sizeof migr_tempfilename2);
1111 extract_token(cmd, cmdbuf, 0, '|', sizeof cmd);
1112 if (!strcasecmp(cmd, "export")) {
1115 else if (!strcasecmp(cmd, "import")) {
1118 else if (!strcasecmp(cmd, "listdirs")) {
1121 else if (!strcasecmp(cmd, "restoremeta")) {
1122 migr_do_restore_meta();
1125 cprintf("%d illegal command\n", ERROR + ILLEGAL_VALUE);
1128 unlink(migr_tempfilename1);
1129 unlink(migr_tempfilename2);
1131 CtdlEnableHouseKeeping();
1132 CtdlEndSingleUser();
1135 cprintf("%d The migrator is already running.\n", ERROR + RESOURCE_BUSY);
1140 /******************************************************************************
1142 ******************************************************************************/
1144 CTDL_MODULE_INIT(migrate)
1148 CtdlRegisterProtoHook(cmd_migr, "MIGR", "Across-the-wire migration");
1151 /* return our module name for the log */