2 * This module dumps and/or loads the Citadel database in XML format.
4 * Copyright (c) 1987-2016 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(struct ctdluser *buf, void *data) {
118 client_write(HKEY("<user>\n"));
119 cprintf("<u_version>%d</u_version>\n", buf->version);
120 cprintf("<u_uid>%ld</u_uid>\n", (long)buf->uid);
121 client_write(HKEY("<u_password>")); xml_strout(buf->password); client_write(HKEY("</u_password>\n"));
122 cprintf("<u_flags>%u</u_flags>\n", buf->flags);
123 cprintf("<u_timescalled>%ld</u_timescalled>\n", buf->timescalled);
124 cprintf("<u_posted>%ld</u_posted>\n", buf->posted);
125 cprintf("<u_axlevel>%d</u_axlevel>\n", buf->axlevel);
126 cprintf("<u_usernum>%ld</u_usernum>\n", buf->usernum);
127 cprintf("<u_lastcall>%ld</u_lastcall>\n", (long)buf->lastcall);
128 cprintf("<u_USuserpurge>%d</u_USuserpurge>\n", buf->USuserpurge);
129 client_write(HKEY("<u_fullname>")); xml_strout(buf->fullname); client_write(HKEY("</u_fullname>\n"));
130 cprintf("<u_msgnum_bio>%ld</u_msgnum_bio>\n", buf->msgnum_bio);
131 cprintf("<u_msgnum_pic>%ld</u_msgnum_pic>\n", buf->msgnum_pic);
132 client_write(HKEY("</user>\n"));
136 void migr_export_users(void) {
137 ForEachUser(migr_export_users_backend, NULL);
141 void migr_export_room_msg(long msgnum, void *userdata) {
142 cprintf("%ld\n", msgnum);
143 fprintf(migr_global_message_list, "%ld\n", msgnum);
147 void migr_export_rooms_backend(struct ctdlroom *buf, void *data) {
148 client_write(HKEY("<room>\n"));
149 client_write(HKEY("<QRname>")); xml_strout(buf->QRname); client_write(HKEY("</QRname>\n"));
150 client_write(HKEY("<QRpasswd>")); xml_strout(buf->QRpasswd); client_write(HKEY("</QRpasswd>\n"));
151 cprintf("<QRroomaide>%ld</QRroomaide>\n", buf->QRroomaide);
152 cprintf("<QRhighest>%ld</QRhighest>\n", buf->QRhighest);
153 cprintf("<QRgen>%ld</QRgen>\n", (long)buf->QRgen);
154 cprintf("<QRflags>%u</QRflags>\n", buf->QRflags);
155 if (buf->QRflags & QR_DIRECTORY) {
156 client_write(HKEY("<QRdirname>"));
157 xml_strout(buf->QRdirname);
158 client_write(HKEY("</QRdirname>\n"));
160 cprintf("<QRfloor>%d</QRfloor>\n", buf->QRfloor);
161 cprintf("<QRmtime>%ld</QRmtime>\n", (long)buf->QRmtime);
162 cprintf("<QRexpire_mode>%d</QRexpire_mode>\n", buf->QRep.expire_mode);
163 cprintf("<QRexpire_value>%d</QRexpire_value>\n", buf->QRep.expire_value);
164 cprintf("<QRnumber>%ld</QRnumber>\n", buf->QRnumber);
165 cprintf("<QRorder>%d</QRorder>\n", buf->QRorder);
166 cprintf("<QRflags2>%u</QRflags2>\n", buf->QRflags2);
167 cprintf("<QRdefaultview>%d</QRdefaultview>\n", buf->QRdefaultview);
168 cprintf("<msgnum_info>%ld</msgnum_info>\n", buf->msgnum_info);
169 cprintf("<msgnum_pic>%ld</msgnum_pic>\n", buf->msgnum_pic);
170 client_write(HKEY("</room>\n"));
172 /* message list goes inside this tag */
174 CtdlGetRoom(&CC->room, buf->QRname);
175 client_write(HKEY("<room_messages>"));
176 client_write(HKEY("<FRname>")); xml_strout(CC->room.QRname); client_write(HKEY("</FRname>\n"));
177 client_write(HKEY("<FRmsglist>"));
178 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, migr_export_room_msg, NULL);
179 client_write(HKEY("</FRmsglist>\n"));
180 client_write(HKEY("</room_messages>\n"));
186 void migr_export_rooms(void) {
188 migr_global_message_list = fopen(migr_tempfilename1, "w");
189 if (migr_global_message_list != NULL) {
190 CtdlForEachRoom(migr_export_rooms_backend, NULL);
191 fclose(migr_global_message_list);
195 * Process the 'global' message list. (Sort it and remove dups.
196 * Dups are ok because a message may be in more than one room, but
197 * this will be handled by exporting the reference count, not by
198 * exporting the message multiple times.)
200 snprintf(cmd, sizeof cmd, "sort -n <%s >%s", migr_tempfilename1, migr_tempfilename2);
201 if (system(cmd) != 0) syslog(LOG_ALERT, "Error %d", errno);
202 snprintf(cmd, sizeof cmd, "uniq <%s >%s", migr_tempfilename2, migr_tempfilename1);
203 if (system(cmd) != 0) syslog(LOG_ALERT, "Error %d", errno);
206 snprintf(cmd, sizeof cmd, "wc -l %s", migr_tempfilename1);
207 FILE *fp = popen(cmd, "r");
209 fgets(cmd, sizeof cmd, fp);
211 total_msgs = atoi(cmd);
214 total_msgs = 1; // any nonzero just to keep it from barfing
216 syslog(LOG_DEBUG, "Total messages to be exported: %d", total_msgs);
220 void migr_export_floors(void) {
221 struct floor qfbuf, *buf;
224 for (i=0; i < MAXFLOORS; ++i) {
225 client_write(HKEY("<floor>\n"));
226 cprintf("<f_num>%d</f_num>\n", i);
227 CtdlGetFloor(&qfbuf, i);
229 cprintf("<f_flags>%u</f_flags>\n", buf->f_flags);
230 client_write(HKEY("<f_name>")); xml_strout(buf->f_name); client_write(HKEY("</f_name>\n"));
231 cprintf("<f_ref_count>%d</f_ref_count>\n", buf->f_ref_count);
232 cprintf("<f_ep_expire_mode>%d</f_ep_expire_mode>\n", buf->f_ep.expire_mode);
233 cprintf("<f_ep_expire_value>%d</f_ep_expire_value>\n", buf->f_ep.expire_value);
234 client_write(HKEY("</floor>\n"));
240 * Return nonzero if the supplied string contains only characters which are valid in a sequence set.
242 int is_sequence_set(char *s) {
247 while (ch = *c++, ch) {
248 if (!strchr("0123456789*,:", ch)) {
258 * Traverse the visits file...
260 void migr_export_visits(void) {
262 struct cdbdata *cdbv;
264 cdb_rewind(CDB_VISIT);
266 while (cdbv = cdb_next_item(CDB_VISIT), cdbv != NULL) {
267 memset(&vbuf, 0, sizeof(visit));
268 memcpy(&vbuf, cdbv->ptr,
269 ((cdbv->len > sizeof(visit)) ?
270 sizeof(visit) : cdbv->len));
273 client_write(HKEY("<visit>\n"));
274 cprintf("<v_roomnum>%ld</v_roomnum>\n", vbuf.v_roomnum);
275 cprintf("<v_roomgen>%ld</v_roomgen>\n", vbuf.v_roomgen);
276 cprintf("<v_usernum>%ld</v_usernum>\n", vbuf.v_usernum);
278 client_write(HKEY("<v_seen>"));
279 if ( (!IsEmptyStr(vbuf.v_seen)) && (is_sequence_set(vbuf.v_seen)) ) {
280 xml_strout(vbuf.v_seen);
283 cprintf("%ld", vbuf.v_lastseen);
285 client_write(HKEY("</v_seen>"));
287 if ( (!IsEmptyStr(vbuf.v_answered)) && (is_sequence_set(vbuf.v_answered)) ) {
288 client_write(HKEY("<v_answered>"));
289 xml_strout(vbuf.v_answered);
290 client_write(HKEY("</v_answered>\n"));
293 cprintf("<v_flags>%u</v_flags>\n", vbuf.v_flags);
294 cprintf("<v_view>%d</v_view>\n", vbuf.v_view);
295 client_write(HKEY("</visit>\n"));
300 void migr_export_message(long msgnum) {
302 struct CtdlMessage *msg;
305 /* We can use a static buffer here because there will never be more than
306 * one of this operation happening at any given time, and it's really best
307 * to just keep it allocated once instead of torturing malloc/free.
308 * Call this function with msgnum "-1" to free the buffer when finished.
310 static int encoded_alloc = 0;
311 static char *encoded_msg = NULL;
314 if ((encoded_alloc == 0) && (encoded_msg != NULL)) {
322 /* Ok, here we go ... */
324 msg = CtdlFetchMessage(msgnum, 1, 0);
325 if (msg == NULL) return; /* fail silently */
327 client_write(HKEY("<message>\n"));
328 GetMetaData(&smi, msgnum);
329 cprintf("<msg_msgnum>%ld</msg_msgnum>\n", msgnum);
330 cprintf("<msg_meta_refcount>%d</msg_meta_refcount>\n", smi.meta_refcount);
331 cprintf("<msg_meta_rfc822_length>%ld</msg_meta_rfc822_length>\n", smi.meta_rfc822_length);
332 client_write(HKEY("<msg_meta_content_type>")); xml_strout(smi.meta_content_type); client_write(HKEY("</msg_meta_content_type>\n"));
333 client_write(HKEY("<msg_mimetype>")); xml_strout(smi.mimetype); client_write(HKEY("</msg_mimetype>\n"));
335 client_write(HKEY("<msg_text>"));
336 CtdlSerializeMessage(&smr, msg);
339 /* Predict the buffer size we need. Expand the buffer if necessary. */
340 int encoded_len = smr.len * 15 / 10 ;
341 if (encoded_len > encoded_alloc) {
342 encoded_alloc = encoded_len;
343 encoded_msg = realloc(encoded_msg, encoded_alloc);
346 if (encoded_msg == NULL) {
347 /* Questionable hack that hopes it'll work next time and we only lose one message */
351 /* Once we do the encoding we know the exact size */
352 encoded_len = CtdlEncodeBase64(encoded_msg, (char *)smr.ser, smr.len, 1);
353 client_write(encoded_msg, encoded_len);
358 client_write(HKEY("</msg_text>\n"));
359 client_write(HKEY("</message>\n"));
364 void migr_export_openids(void) {
365 struct cdbdata *cdboi;
369 cdb_rewind(CDB_OPENID);
370 while (cdboi = cdb_next_item(CDB_OPENID), cdboi != NULL) {
371 if (cdboi->len > sizeof(long)) {
372 client_write(HKEY("<openid>\n"));
373 memcpy(&usernum, cdboi->ptr, sizeof(long));
374 snprintf(url, sizeof url, "%s", (cdboi->ptr)+sizeof(long) );
375 client_write(HKEY("<oid_url>"));
377 client_write(HKEY("</oid_url>\n"));
378 cprintf("<oid_usernum>%ld</oid_usernum>\n", usernum);
379 client_write(HKEY("</openid>\n"));
386 void migr_export_configs(void) {
387 struct cdbdata *cdbcfg;
392 cdb_rewind(CDB_CONFIG);
393 while (cdbcfg = cdb_next_item(CDB_CONFIG), cdbcfg != NULL) {
395 keylen = strlen(cdbcfg->ptr);
397 value = cdbcfg->ptr + keylen + 1;
399 client_write("<config key=\"", 13);
401 client_write("\">", 2);
403 client_write("</config>\n", 10);
411 void migr_export_messages(void) {
416 int prev_progress = 0;
420 migr_global_message_list = fopen(migr_tempfilename1, "r");
421 if (migr_global_message_list != NULL) {
422 syslog(LOG_INFO, "Opened %s", migr_tempfilename1);
423 while ((Ctx->kill_me == 0) &&
424 (fgets(buf, sizeof(buf), migr_global_message_list) != NULL)) {
427 migr_export_message(msgnum);
430 progress = (count * 74 / total_msgs) + 25 ;
431 if ((progress > prev_progress) && (progress < 100)) {
432 cprintf("<progress>%d</progress>\n", progress);
434 prev_progress = progress;
436 fclose(migr_global_message_list);
438 if (Ctx->kill_me == 0)
439 syslog(LOG_INFO, "Exported %d messages.", count);
441 syslog(LOG_ERR, "Export aborted due to client disconnect!");
443 migr_export_message(-1L); /* This frees the encoding buffer */
448 void migr_do_export(void) {
452 cprintf("%d Exporting all Citadel databases.\n", LISTING_FOLLOWS);
455 client_write(HKEY("<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n"));
456 client_write(HKEY("<citadel_migrate_data>\n"));
457 cprintf("<version>%d</version>\n", REV_LEVEL);
458 cprintf("<progress>%d</progress>\n", 0);
460 /* export the configuration database */
461 migr_export_configs();
462 cprintf("<progress>%d</progress>\n", 2);
464 if (Ctx->kill_me == 0) migr_export_users();
465 cprintf("<progress>%d</progress>\n", 7);
466 if (Ctx->kill_me == 0) migr_export_openids();
467 cprintf("<progress>%d</progress>\n", 12);
468 if (Ctx->kill_me == 0) migr_export_rooms();
469 cprintf("<progress>%d</progress>\n", 17);
470 if (Ctx->kill_me == 0) migr_export_floors();
471 cprintf("<progress>%d</progress>\n", 18);
472 if (Ctx->kill_me == 0) migr_export_visits();
473 cprintf("<progress>%d</progress>\n", 25);
474 if (Ctx->kill_me == 0) migr_export_messages();
475 client_write(HKEY("</citadel_migrate_data>\n"));
476 cprintf("<progress>%d</progress>\n", 100);
477 client_write(HKEY("000\n"));
484 /******************************************************************************
486 * Here's the code that implements the import side. It's going to end up *
487 * being one big loop with lots of global variables. I don't care. *
488 * You wouldn't run multiple concurrent imports anyway. If this offends your *
489 * delicate sensibilities then go rewrite it in Ruby on Rails or something. *
490 ******************************************************************************/
493 int citadel_migrate_data = 0; /* Are we inside a <citadel_migrate_data> tag pair? */
494 StrBuf *migr_chardata = NULL;
495 StrBuf *migr_MsgData = NULL;
496 struct ctdluser usbuf;
497 struct ctdlroom qrbuf;
498 char openid_url[512];
499 long openid_usernum = 0;
500 char FRname[ROOMNAMELEN];
505 long import_msgnum = 0;
508 * This callback stores up the data which appears in between tags.
510 void migr_xml_chardata(void *data, const XML_Char *s, int len)
512 StrBufAppendBufPlain(migr_chardata, s, len, 0);
516 void migr_xml_start(void *data, const char *el, const char **attr) {
519 /*** GENERAL STUFF ***/
521 /* Reset chardata_len to zero and init buffer */
522 FlushStrBuf(migr_chardata);
523 FlushStrBuf(migr_MsgData);
525 if (!strcasecmp(el, "citadel_migrate_data")) {
526 ++citadel_migrate_data;
528 /* As soon as it looks like the input data is a genuine Citadel XML export,
529 * whack the existing database on disk to make room for the new one.
531 if (citadel_migrate_data == 1) {
532 for (i = 0; i < MAXCDB; ++i) {
539 if (citadel_migrate_data != 1) {
540 syslog(LOG_ALERT, "Out-of-sequence tag <%s> detected. Warning: ODD-DATA!", el);
544 /* When we begin receiving XML for one of these record types, clear out the associated
545 * buffer so we don't accidentally carry over any data from a previous record.
547 if (!strcasecmp(el, "user")) memset(&usbuf, 0, sizeof (struct ctdluser));
548 else if (!strcasecmp(el, "openid")) memset(openid_url, 0, sizeof openid_url);
549 else if (!strcasecmp(el, "room")) memset(&qrbuf, 0, sizeof (struct ctdlroom));
550 else if (!strcasecmp(el, "room_messages")) memset(FRname, 0, sizeof FRname);
551 else if (!strcasecmp(el, "floor")) memset(&flbuf, 0, sizeof (struct floor));
552 else if (!strcasecmp(el, "visit")) memset(&vbuf, 0, sizeof (visit));
554 else if (!strcasecmp(el, "message")) {
555 memset(&smi, 0, sizeof (struct MetaData));
558 else if (!strcasecmp(el, "config")) {
564 if (!strcasecmp(attr[0], "key")) {
565 ikey = strdup(attr[1]);
574 int migr_userrecord(void *data, const char *el)
576 if (!strcasecmp(el, "u_version")) usbuf.version = atoi(ChrPtr(migr_chardata));
577 else if (!strcasecmp(el, "u_uid")) usbuf.uid = atol(ChrPtr(migr_chardata));
578 else if (!strcasecmp(el, "u_password")) safestrncpy(usbuf.password, ChrPtr(migr_chardata), sizeof usbuf.password);
579 else if (!strcasecmp(el, "u_flags")) usbuf.flags = atoi(ChrPtr(migr_chardata));
580 else if (!strcasecmp(el, "u_timescalled")) usbuf.timescalled = atol(ChrPtr(migr_chardata));
581 else if (!strcasecmp(el, "u_posted")) usbuf.posted = atol(ChrPtr(migr_chardata));
582 else if (!strcasecmp(el, "u_axlevel")) usbuf.axlevel = atoi(ChrPtr(migr_chardata));
583 else if (!strcasecmp(el, "u_usernum")) usbuf.usernum = atol(ChrPtr(migr_chardata));
584 else if (!strcasecmp(el, "u_lastcall")) usbuf.lastcall = atol(ChrPtr(migr_chardata));
585 else if (!strcasecmp(el, "u_USuserpurge")) usbuf.USuserpurge = atoi(ChrPtr(migr_chardata));
586 else if (!strcasecmp(el, "u_fullname")) safestrncpy(usbuf.fullname, ChrPtr(migr_chardata), sizeof usbuf.fullname);
587 else if (!strcasecmp(el, "u_msgnum_bio")) usbuf.msgnum_bio = atol(ChrPtr(migr_chardata));
588 else if (!strcasecmp(el, "u_msgnum_pic")) usbuf.msgnum_pic = atol(ChrPtr(migr_chardata));
594 int migr_roomrecord(void *data, const char *el)
596 if (!strcasecmp(el, "QRname")) safestrncpy(qrbuf.QRname, ChrPtr(migr_chardata), sizeof qrbuf.QRname);
597 else if (!strcasecmp(el, "QRpasswd")) safestrncpy(qrbuf.QRpasswd, ChrPtr(migr_chardata), sizeof qrbuf.QRpasswd);
598 else if (!strcasecmp(el, "QRroomaide")) qrbuf.QRroomaide = atol(ChrPtr(migr_chardata));
599 else if (!strcasecmp(el, "QRhighest")) qrbuf.QRhighest = atol(ChrPtr(migr_chardata));
600 else if (!strcasecmp(el, "QRgen")) qrbuf.QRgen = atol(ChrPtr(migr_chardata));
601 else if (!strcasecmp(el, "QRflags")) qrbuf.QRflags = atoi(ChrPtr(migr_chardata));
602 else if (!strcasecmp(el, "QRdirname")) safestrncpy(qrbuf.QRdirname, ChrPtr(migr_chardata), sizeof qrbuf.QRdirname);
603 else if (!strcasecmp(el, "QRfloor")) qrbuf.QRfloor = atoi(ChrPtr(migr_chardata));
604 else if (!strcasecmp(el, "QRmtime")) qrbuf.QRmtime = atol(ChrPtr(migr_chardata));
605 else if (!strcasecmp(el, "QRexpire_mode")) qrbuf.QRep.expire_mode = atoi(ChrPtr(migr_chardata));
606 else if (!strcasecmp(el, "QRexpire_value")) qrbuf.QRep.expire_value = atoi(ChrPtr(migr_chardata));
607 else if (!strcasecmp(el, "QRnumber")) qrbuf.QRnumber = atol(ChrPtr(migr_chardata));
608 else if (!strcasecmp(el, "QRorder")) qrbuf.QRorder = atoi(ChrPtr(migr_chardata));
609 else if (!strcasecmp(el, "QRflags2")) qrbuf.QRflags2 = atoi(ChrPtr(migr_chardata));
610 else if (!strcasecmp(el, "QRdefaultview")) qrbuf.QRdefaultview = atoi(ChrPtr(migr_chardata));
611 else if (!strcasecmp(el, "msgnum_info")) qrbuf.msgnum_info = atol(ChrPtr(migr_chardata));
612 else if (!strcasecmp(el, "msgnum_pic")) qrbuf.msgnum_pic = atol(ChrPtr(migr_chardata));
617 int migr_floorrecord(void *data, const char *el)
619 if (!strcasecmp(el, "f_num")) floornum = atoi(ChrPtr(migr_chardata));
620 else if (!strcasecmp(el, "f_flags")) flbuf.f_flags = atoi(ChrPtr(migr_chardata));
621 else if (!strcasecmp(el, "f_name")) safestrncpy(flbuf.f_name, ChrPtr(migr_chardata), sizeof flbuf.f_name);
622 else if (!strcasecmp(el, "f_ref_count")) flbuf.f_ref_count = atoi(ChrPtr(migr_chardata));
623 else if (!strcasecmp(el, "f_ep_expire_mode")) flbuf.f_ep.expire_mode = atoi(ChrPtr(migr_chardata));
624 else if (!strcasecmp(el, "f_ep_expire_value")) flbuf.f_ep.expire_value = atoi(ChrPtr(migr_chardata));
629 int migr_visitrecord(void *data, const char *el)
631 if (!strcasecmp(el, "v_roomnum")) vbuf.v_roomnum = atol(ChrPtr(migr_chardata));
632 else if (!strcasecmp(el, "v_roomgen")) vbuf.v_roomgen = atol(ChrPtr(migr_chardata));
633 else if (!strcasecmp(el, "v_usernum")) vbuf.v_usernum = atol(ChrPtr(migr_chardata));
635 else if (!strcasecmp(el, "v_seen")) {
636 int is_textual_seen = 0;
638 int max = StrLength(migr_chardata);
640 vbuf.v_lastseen = atol(ChrPtr(migr_chardata));
642 for (i=0; i < max; ++i)
643 if (!isdigit(ChrPtr(migr_chardata)[i]))
646 safestrncpy(vbuf.v_seen, ChrPtr(migr_chardata), sizeof vbuf.v_seen);
649 else if (!strcasecmp(el, "v_answered")) safestrncpy(vbuf.v_answered, ChrPtr(migr_chardata), sizeof vbuf.v_answered);
650 else if (!strcasecmp(el, "v_flags")) vbuf.v_flags = atoi(ChrPtr(migr_chardata));
651 else if (!strcasecmp(el, "v_view")) vbuf.v_view = atoi(ChrPtr(migr_chardata));
657 void migr_xml_end(void *data, const char *el)
662 long *msglist = NULL;
663 int msglist_alloc = 0;
664 /*** GENERAL STUFF ***/
666 if (!strcasecmp(el, "citadel_migrate_data")) {
667 --citadel_migrate_data;
671 if (citadel_migrate_data != 1) {
672 syslog(LOG_ALERT, "Out-of-sequence tag <%s> detected. Warning: ODD-DATA!", el);
676 // syslog(LOG_DEBUG, "END TAG: <%s> DATA: <%s>\n", el, (migr_chardata_len ? migr_chardata : ""));
680 if (!strcasecmp(el, "config"))
682 syslog(LOG_DEBUG, "Imported config key=%s", ikey);
685 CtdlSetConfigStr(ikey, (char *)ChrPtr(migr_chardata));
690 syslog(LOG_INFO, "Closed a <config> tag but no key name was supplied.");
695 else if ((!strncasecmp(el, HKEY("u_"))) &&
696 migr_userrecord(data, el))
697 ; /* Nothing to do anymore */
698 else if (!strcasecmp(el, "user")) {
700 syslog(LOG_INFO, "Imported user: %s", usbuf.fullname);
705 else if (!strcasecmp(el, "oid_url")) safestrncpy(openid_url, ChrPtr(migr_chardata), sizeof openid_url);
706 else if (!strcasecmp(el, "oid_usernum")) openid_usernum = atol(ChrPtr(migr_chardata));
708 else if (!strcasecmp(el, "openid")) { /* see serv_openid_rp.c for a description of the record format */
711 oid_data_len = sizeof(long) + strlen(openid_url) + 1;
712 oid_data = malloc(oid_data_len);
713 memcpy(oid_data, &openid_usernum, sizeof(long));
714 memcpy(&oid_data[sizeof(long)], openid_url, strlen(openid_url) + 1);
715 cdb_store(CDB_OPENID, openid_url, strlen(openid_url), oid_data, oid_data_len);
717 syslog(LOG_INFO, "Imported OpenID: %s (%ld)", openid_url, openid_usernum);
721 else if ((!strncasecmp(el, HKEY("QR"))) &&
722 migr_roomrecord(data, el))
723 ; /* Nothing to do anymore */
724 else if (!strcasecmp(el, "room")) {
726 syslog(LOG_INFO, "Imported room: %s", qrbuf.QRname);
729 /*** ROOM MESSAGE POINTERS ***/
731 else if (!strcasecmp(el, "FRname")) safestrncpy(FRname, ChrPtr(migr_chardata), sizeof FRname);
733 else if (!strcasecmp(el, "FRmsglist")) {
734 if (!IsEmptyStr(FRname)) {
736 msglist_alloc = 1000;
737 msglist = malloc(sizeof(long) * msglist_alloc);
739 syslog(LOG_DEBUG, "Message list for: %s", FRname);
741 ptr = ChrPtr(migr_chardata);
743 while ((*ptr != 0) && (!isdigit(*ptr))) {
746 if ((*ptr != 0) && (isdigit(*ptr))) {
749 if (msgcount >= msglist_alloc) {
751 msglist = realloc(msglist, sizeof(long) * msglist_alloc);
753 msglist[msgcount++] = msgnum;
756 while ((*ptr != 0) && (isdigit(*ptr))) {
762 CtdlSaveMsgPointersInRoom(FRname, msglist, msgcount, 0, NULL, 1);
767 syslog(LOG_DEBUG, "Imported %d messages.", msgcount);
768 if (server_shutting_down) {
774 else if ((!strncasecmp(el, HKEY("f_"))) &&
775 migr_floorrecord(data, el))
776 ; /* Nothing to do anymore */
778 else if (!strcasecmp(el, "floor")) {
779 CtdlPutFloor(&flbuf, floornum);
780 syslog(LOG_INFO, "Imported floor #%d (%s)", floornum, flbuf.f_name);
784 else if ((!strncasecmp(el, HKEY("v_"))) &&
785 migr_visitrecord(data, el))
786 ; /* Nothing to do anymore */
787 else if (!strcasecmp(el, "visit")) {
789 syslog(LOG_INFO, "Imported visit: %ld/%ld/%ld", vbuf.v_roomnum, vbuf.v_roomgen, vbuf.v_usernum);
794 else if (!strcasecmp(el, "msg_msgnum")) smi.meta_msgnum = import_msgnum = atol(ChrPtr(migr_chardata));
795 else if (!strcasecmp(el, "msg_meta_refcount")) smi.meta_refcount = atoi(ChrPtr(migr_chardata));
796 else if (!strcasecmp(el, "msg_meta_rfc822_length")) smi.meta_rfc822_length = atoi(ChrPtr(migr_chardata));
797 else if (!strcasecmp(el, "msg_meta_content_type")) safestrncpy(smi.meta_content_type, ChrPtr(migr_chardata), sizeof smi.meta_content_type);
798 else if (!strcasecmp(el, "msg_mimetype")) safestrncpy(smi.mimetype, ChrPtr(migr_chardata), sizeof smi.mimetype);
800 else if (!strcasecmp(el, "msg_text"))
803 struct CtdlMessage *msg;
805 FlushStrBuf(migr_MsgData);
806 StrBufDecodeBase64To(migr_chardata, migr_MsgData);
808 msg = CtdlDeserializeMessage(import_msgnum, -1,
809 ChrPtr(migr_MsgData),
810 StrLength(migr_MsgData));
812 rc = CtdlSaveThisMessage(msg, import_msgnum, 0);
823 "%s message #%ld, size=%d, refcount=%d, bodylength=%ld, content-type: %s / %s",
824 (rc!= 0)?"failed to import ":"Imported ",
826 StrLength(migr_MsgData),
828 smi.meta_rfc822_length,
829 smi.meta_content_type,
831 memset(&smi, 0, sizeof(smi));
834 /*** MORE GENERAL STUFF ***/
836 FlushStrBuf(migr_chardata);
845 void migr_do_import(void) {
851 migr_chardata = NewStrBufPlain(NULL, SIZ * 20);
852 migr_MsgData = NewStrBufPlain(NULL, SIZ * 20);
853 Buf = NewStrBufPlain(NULL, SIZ);
854 xp = XML_ParserCreate(NULL);
856 cprintf("%d Failed to create XML parser instance\n", ERROR+INTERNAL_ERROR);
859 XML_SetElementHandler(xp, migr_xml_start, migr_xml_end);
860 XML_SetCharacterDataHandler(xp, migr_xml_chardata);
864 cprintf("%d sock it to me\n", SEND_LISTING);
867 client_set_inbound_buf(SIZ * 10);
869 while (!Finished && client_read_random_blob(Buf, -1) >= 0) {
870 if ((StrLength(Buf) > 4) &&
871 !strcmp(ChrPtr(Buf) + StrLength(Buf) - 4, "000\n"))
874 StrBufCutAt(Buf, StrLength(Buf) - 4, NULL);
876 if (server_shutting_down)
877 break; // Should we break or return?
879 if (StrLength(Buf) == 0)
882 XML_Parse(xp, ChrPtr(Buf), StrLength(Buf), 0);
886 XML_Parse(xp, "", 0, 1);
889 FreeStrBuf(&migr_chardata);
890 FreeStrBuf(&migr_MsgData);
891 rebuild_euid_index();
892 rebuild_usersbynumber();
893 CtdlSetConfigInt("MM_fulltext_wordbreaker", -1); // Set an invalid wordbreaker to force re-indexing
898 /******************************************************************************
899 * Dispatcher, Common code *
900 ******************************************************************************/
902 * Dump out the pathnames of directories which can be copied "as is"
904 void migr_do_listdirs(void) {
905 cprintf("%d Don't forget these:\n", LISTING_FOLLOWS);
906 cprintf("files|%s\n", ctdl_file_dir);
907 cprintf("messages|%s\n", ctdl_message_dir);
908 cprintf("keys|%s\n", ctdl_key_dir);
913 /******************************************************************************
914 * Repair database integrity *
915 ******************************************************************************/
917 StrBuf *PlainMessageBuf = NULL;
918 HashList *UsedMessageIDS = NULL;
920 int migr_restore_message_metadata(long msgnum, int refcount)
922 CitContext *CCC = MyContext();
924 struct CtdlMessage *msg;
927 /* We can use a static buffer here because there will never be more than
928 * one of this operation happening at any given time, and it's really best
929 * to just keep it allocated once instead of torturing malloc/free.
930 * Call this function with msgnum "-1" to free the buffer when finished.
932 static int encoded_alloc = 0;
933 static char *encoded_msg = NULL;
936 if ((encoded_alloc == 0) && (encoded_msg != NULL)) {
940 // todo FreeStrBuf(&PlainMessageBuf); PlainMessageBuf = NULL;
945 if (PlainMessageBuf == NULL) {
946 PlainMessageBuf = NewStrBufPlain(NULL, 10*SIZ);
949 /* Ok, here we go ... */
951 msg = CtdlFetchMessage(msgnum, 1, 0);
956 GetMetaData(&smi, msgnum);
957 smi.meta_msgnum = msgnum;
958 smi.meta_refcount = refcount;
960 /* restore the content type from the message body: */
961 mptr = bmstrcasestr(msg->cm_fields[eMesageText], "Content-type:");
964 safestrncpy(smi.meta_content_type, &mptr[13], sizeof smi.meta_content_type);
965 striplt(smi.meta_content_type);
966 aptr = smi.meta_content_type;
967 while (!IsEmptyStr(aptr)) {
972 memset(aptr, 0, sizeof(smi.meta_content_type) - (aptr - smi.meta_content_type));
978 CCC->redirect_buffer = PlainMessageBuf;
979 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, QP_EADDR);
980 smi.meta_rfc822_length = StrLength(CCC->redirect_buffer);
981 CCC->redirect_buffer = NULL;
985 "Setting message #%ld meta data to: refcount=%d, bodylength=%ld, content-type: %s / %s",
988 smi.meta_rfc822_length,
989 smi.meta_content_type,
999 void migr_check_room_msg(long msgnum, void *userdata) {
1000 fprintf(migr_global_message_list, "%ld %s\n", msgnum, CC->room.QRname);
1004 void migr_check_rooms_backend(struct ctdlroom *buf, void *data) {
1006 /* message list goes inside this tag */
1008 CtdlGetRoom(&CC->room, buf->QRname);
1009 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, migr_check_room_msg, NULL);
1012 void RemoveMessagesFromRooms(StrBuf *RoomNameVec, long msgnum) {
1013 struct MetaData smi;
1014 const char *Pos = NULL;
1015 StrBuf *oneRoom = NewStrBuf();
1017 syslog(LOG_INFO, "removing message pointer %ld from these rooms: %s", msgnum, ChrPtr(RoomNameVec));
1019 while (Pos != StrBufNOTNULL){
1020 StrBufExtract_NextToken(oneRoom, RoomNameVec, &Pos, '|');
1021 CtdlDeleteMessages(ChrPtr(oneRoom), &msgnum, 1, "");
1023 GetMetaData(&smi, msgnum);
1024 TDAP_AdjRefCount(msgnum, -smi.meta_refcount);
1027 void migr_do_restore_meta(void) {
1038 migr_global_message_list = fopen(migr_tempfilename1, "w");
1039 if (migr_global_message_list != NULL) {
1040 CtdlForEachRoom(migr_check_rooms_backend, NULL);
1041 fclose(migr_global_message_list);
1045 * Process the 'global' message list. (Sort it and remove dups.
1046 * Dups are ok because a message may be in more than one room, but
1047 * this will be handled by exporting the reference count, not by
1048 * exporting the message multiple times.)
1050 snprintf(cmd, sizeof cmd, "sort -n <%s >%s", migr_tempfilename1, migr_tempfilename2);
1051 if (system(cmd) != 0) syslog(LOG_ALERT, "Error %d", errno);
1053 RoomNames = NewStrBuf();
1055 migr_global_message_list = fopen(migr_tempfilename2, "r");
1056 if (migr_global_message_list != NULL) {
1057 syslog(LOG_INFO, "Opened %s", migr_tempfilename1);
1058 while ((Ctx->kill_me == 0) &&
1059 (fgets(buf, sizeof(buf), migr_global_message_list) != NULL)) {
1066 prn = strchr(buf, ' ');
1067 if (lastnum != msgnum) {
1068 failGetMessage = migr_restore_message_metadata(lastnum, refcount);
1069 if (failGetMessage) {
1070 RemoveMessagesFromRooms(RoomNames, lastnum);
1075 StrBufPlain(RoomNames, prn + 1, -1);
1076 StrBufTrim(RoomNames);
1080 if (StrLength(RoomNames) > 0)
1081 StrBufAppendBufPlain(RoomNames, HKEY("|"), 0);
1082 StrBufAppendBufPlain(RoomNames, prn, -1, 1);
1083 StrBufTrim(RoomNames);
1089 failGetMessage = migr_restore_message_metadata(msgnum, refcount);
1090 if (failGetMessage) {
1091 RemoveMessagesFromRooms(RoomNames, lastnum);
1093 fclose(migr_global_message_list);
1096 migr_restore_message_metadata(-1L, -1); /* This frees the encoding buffer */
1097 cprintf("%d system analysis completed", CIT_OK);
1104 /******************************************************************************
1105 * Dispatcher, Common code *
1106 ******************************************************************************/
1107 void cmd_migr(char *cmdbuf) {
1110 if (CtdlAccessCheck(ac_internal)) return;
1112 if (CtdlTrySingleUser())
1114 CtdlDisableHouseKeeping();
1115 CtdlMakeTempFileName(migr_tempfilename1, sizeof migr_tempfilename1);
1116 CtdlMakeTempFileName(migr_tempfilename2, sizeof migr_tempfilename2);
1118 extract_token(cmd, cmdbuf, 0, '|', sizeof cmd);
1119 if (!strcasecmp(cmd, "export")) {
1122 else if (!strcasecmp(cmd, "import")) {
1125 else if (!strcasecmp(cmd, "listdirs")) {
1128 else if (!strcasecmp(cmd, "restoremeta")) {
1129 migr_do_restore_meta();
1132 cprintf("%d illegal command\n", ERROR + ILLEGAL_VALUE);
1135 unlink(migr_tempfilename1);
1136 unlink(migr_tempfilename2);
1138 CtdlEnableHouseKeeping();
1139 CtdlEndSingleUser();
1143 cprintf("%d The migrator is already running.\n", ERROR + RESOURCE_BUSY);
1147 /******************************************************************************
1149 ******************************************************************************/
1151 CTDL_MODULE_INIT(migrate)
1155 CtdlRegisterProtoHook(cmd_migr, "MIGR", "Across-the-wire migration");
1158 /* return our module name for the log */