/*
* This module dumps and/or loads the Citadel database in XML format.
*
- * Copyright (c) 1987-2020 by the citadel.org team
+ * Copyright (c) 1987-2021 by the citadel.org team
*
* This program is open source software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 3.
/*
* Explanation of <progress> tags:
*
- * 0% nothing
- * 2% finished exporting configuration
- * 7% finished exporting users
- * 12% finished exporting openids
- * 17% finished exporting rooms
- * 18% finished exporting floors
- * 25% finished exporting visits
- * 100% finished exporting messages
+ * 0% started
+ * 2% finished exporting configuration
+ * 7% finished exporting users
+ * 12% finished exporting openids
+ * 17% finished exporting rooms
+ * 18% finished exporting floors
+ * 25% finished exporting visits
+ * 26-99% exporting messages
+ * 100% finished exporting messages
+ *
+ * These tags are inserted into the XML stream to give the reader an approximation of its progress.
*/
#include "sysdep.h"
#include <pwd.h>
#include <errno.h>
#include <sys/types.h>
-
-#if TIME_WITH_SYS_TIME
-# include <sys/time.h>
-# include <time.h>
-#else
-# if HAVE_SYS_TIME_H
-# include <sys/time.h>
-# else
-# include <time.h>
-# endif
-#endif
-
+#include <time.h>
#include <sys/wait.h>
#include <string.h>
#include <ctype.h>
#include "euidindex.h"
#include "ctdl_module.h"
-#define END_OF_MESSAGE "---eom---dbd---"
-
char migr_tempfilename1[PATH_MAX];
char migr_tempfilename2[PATH_MAX];
FILE *migr_global_message_list;
int total_msgs = 0;
char *ikey = NULL; // If we're importing a config key we store it here.
-
/******************************************************************************
* Code which implements the export appears in this section *
******************************************************************************/
cprintf("<u_msgnum_pic>%ld</u_msgnum_pic>\n", u.msgnum_pic);
cprintf("<u_emailaddrs>%s</u_emailaddrs>\n", u.emailaddrs);
cprintf("<u_msgnum_inboxrules>%ld</u_msgnum_inboxrules>\n", u.msgnum_inboxrules);
+ cprintf("<u_lastproc_inboxrules>%ld</u_lastproc_inboxrules>\n", u.lastproc_inboxrules);
client_write(HKEY("</user>\n"));
}
void migr_export_room_msg(long msgnum, void *userdata) {
- cprintf("%ld\n", msgnum);
+ static int count = 0;
+
+ cprintf("%ld,", msgnum);
+ if (++count%10==0) {
+ cprintf("\n");
+ }
fprintf(migr_global_message_list, "%ld\n", msgnum);
}
void migr_export_rooms_backend(struct ctdlroom *buf, void *data) {
client_write(HKEY("<room>\n"));
- client_write(HKEY("<QRname>")); xml_strout(buf->QRname); client_write(HKEY("</QRname>\n"));
- client_write(HKEY("<QRpasswd>")); xml_strout(buf->QRpasswd); client_write(HKEY("</QRpasswd>\n"));
+ client_write(HKEY("<QRname>"));
+ xml_strout(buf->QRname);
+ client_write(HKEY("</QRname>\n"));
+ client_write(HKEY("<QRpasswd>"));
+ xml_strout(buf->QRpasswd);
+ client_write(HKEY("</QRpasswd>\n"));
cprintf("<QRroomaide>%ld</QRroomaide>\n", buf->QRroomaide);
cprintf("<QRhighest>%ld</QRhighest>\n", buf->QRhighest);
cprintf("<QRgen>%ld</QRgen>\n", (long)buf->QRgen);
client_write(HKEY("</room>\n"));
/* message list goes inside this tag */
-
CtdlGetRoom(&CC->room, buf->QRname);
client_write(HKEY("<room_messages>"));
- client_write(HKEY("<FRname>")); xml_strout(CC->room.QRname); client_write(HKEY("</FRname>\n"));
- client_write(HKEY("<FRmsglist>"));
+ client_write(HKEY("<FRname>"));
+ xml_strout(buf->QRname); // buf->QRname rather than CC->room.QRname to guarantee consistency
+ client_write(HKEY("</FRname>\n"));
+ client_write(HKEY("<FRmsglist>\n"));
CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, migr_export_room_msg, NULL);
client_write(HKEY("</FRmsglist>\n"));
client_write(HKEY("</room_messages>\n"));
-
-
}
* exporting the message multiple times.)
*/
snprintf(cmd, sizeof cmd, "sort -n <%s >%s", migr_tempfilename1, migr_tempfilename2);
- if (system(cmd) != 0) syslog(LOG_ALERT, "Error %d", errno);
+ if (system(cmd) != 0) {
+ syslog(LOG_ERR, "migrate: error %d", errno);
+ }
snprintf(cmd, sizeof cmd, "uniq <%s >%s", migr_tempfilename2, migr_tempfilename1);
- if (system(cmd) != 0) syslog(LOG_ALERT, "Error %d", errno);
-
+ if (system(cmd) != 0) {
+ syslog(LOG_ERR, "migrate: error %d", errno);
+ }
snprintf(cmd, sizeof cmd, "wc -l %s", migr_tempfilename1);
FILE *fp = popen(cmd, "r");
else {
total_msgs = 1; // any nonzero just to keep it from barfing
}
- syslog(LOG_DEBUG, "Total messages to be exported: %d", total_msgs);
+ syslog(LOG_DEBUG, "migrate: total messages to be exported: %d", total_msgs);
}
struct MetaData smi;
struct CtdlMessage *msg;
struct ser_ret smr;
+ long bytes_written = 0;
+ long this_block = 0;
+
+ // We can use a static buffer here because there will never be more than
+ // one of this operation happening at any given time, and it's really best
+ // to just keep it allocated once instead of torturing malloc/free.
+ // Call this function with msgnum "-1" to free the buffer when finished.
- /* We can use a static buffer here because there will never be more than
- * one of this operation happening at any given time, and it's really best
- * to just keep it allocated once instead of torturing malloc/free.
- * Call this function with msgnum "-1" to free the buffer when finished.
- */
static int encoded_alloc = 0;
static char *encoded_msg = NULL;
return;
}
- /* Ok, here we go ... */
+ // Ok, here we go ...
msg = CtdlFetchMessage(msgnum, 1);
- if (msg == NULL) return; /* fail silently */
+ if (msg == NULL) return; // fail silently
client_write(HKEY("<message>\n"));
GetMetaData(&smi, msgnum);
CtdlSerializeMessage(&smr, msg);
CM_Free(msg);
- /* Predict the buffer size we need. Expand the buffer if necessary. */
+ // Predict the buffer size we need. Expand the buffer if necessary.
int encoded_len = smr.len * 15 / 10 ;
if (encoded_len > encoded_alloc) {
encoded_alloc = encoded_len;
}
if (encoded_msg == NULL) {
- /* Questionable hack that hopes it'll work next time and we only lose one message */
+ // Questionable hack that hopes it'll work next time and we only lose one message
encoded_alloc = 0;
}
else {
- /* Once we do the encoding we know the exact size */
+ // Once we do the encoding we know the exact size
encoded_len = CtdlEncodeBase64(encoded_msg, (char *)smr.ser, smr.len, 1);
- client_write(encoded_msg, encoded_len);
+
+ // Careful now. If the message is gargantuan, trying to write multiple gigamegs in one
+ // big write operation can make our transport unhappy. So we'll chunk it up 10 KB at a time.
+ bytes_written = 0;
+ while ( (bytes_written < encoded_len) && (!server_shutting_down) ) {
+ this_block = encoded_len - bytes_written;
+ if (this_block > 10240) {
+ this_block = 10240;
+ }
+ client_write(&encoded_msg[bytes_written], this_block);
+ bytes_written += this_block;
+ }
}
free(smr.ser);
Ctx = CC;
migr_global_message_list = fopen(migr_tempfilename1, "r");
if (migr_global_message_list != NULL) {
- syslog(LOG_INFO, "Opened %s", migr_tempfilename1);
+ syslog(LOG_INFO, "migrate: opened %s", migr_tempfilename1);
while ((Ctx->kill_me == 0) &&
(fgets(buf, sizeof(buf), migr_global_message_list) != NULL)) {
msgnum = atol(buf);
fclose(migr_global_message_list);
}
if (Ctx->kill_me == 0) {
- syslog(LOG_INFO, "Exported %d messages.", count);
+ syslog(LOG_INFO, "migrate: exported %d messages.", count);
}
else {
- syslog(LOG_ERR, "Export aborted due to client disconnect!");
+ syslog(LOG_ERR, "migrate: export aborted due to client disconnect!");
}
migr_export_message(-1L); /* This frees the encoding buffer */
if (Ctx->kill_me == 0) migr_export_visits();
cprintf("<progress>%d</progress>\n", 25);
if (Ctx->kill_me == 0) migr_export_messages();
- client_write(HKEY("</citadel_migrate_data>\n"));
cprintf("<progress>%d</progress>\n", 100);
+ client_write(HKEY("</citadel_migrate_data>\n"));
client_write(HKEY("000\n"));
Ctx->dont_term = 0;
}
/*
* This callback stores up the data which appears in between tags.
*/
-void migr_xml_chardata(void *data, const XML_Char *s, int len)
-{
+void migr_xml_chardata(void *data, const XML_Char *s, int len) {
StrBufAppendBufPlain(migr_chardata, s, len, 0);
}
}
if (citadel_migrate_data != 1) {
- syslog(LOG_ALERT, "Out-of-sequence tag <%s> detected. Warning: ODD-DATA!", el);
+ syslog(LOG_ERR, "migrate: out-of-sequence tag <%s> detected. Warning: ODD-DATA!", el);
return;
}
}
-int migr_userrecord(void *data, const char *el)
-{
+int migr_userrecord(void *data, const char *el) {
if (!strcasecmp(el, "u_version")) usbuf.version = atoi(ChrPtr(migr_chardata));
else if (!strcasecmp(el, "u_uid")) usbuf.uid = atol(ChrPtr(migr_chardata));
else if (!strcasecmp(el, "u_password")) safestrncpy(usbuf.password, ChrPtr(migr_chardata), sizeof usbuf.password);
else if (!strcasecmp(el, "u_msgnum_pic")) usbuf.msgnum_pic = atol(ChrPtr(migr_chardata));
else if (!strcasecmp(el, "u_emailaddrs")) safestrncpy(usbuf.emailaddrs, ChrPtr(migr_chardata), sizeof usbuf.emailaddrs);
else if (!strcasecmp(el, "u_msgnum_inboxrules")) usbuf.msgnum_inboxrules = atol(ChrPtr(migr_chardata));
+ else if (!strcasecmp(el, "u_lastproc_inboxrules")) usbuf.lastproc_inboxrules = atol(ChrPtr(migr_chardata));
else return 0;
return 1;
}
-int migr_roomrecord(void *data, const char *el)
-{
+int migr_roomrecord(void *data, const char *el) {
if (!strcasecmp(el, "QRname")) safestrncpy(qrbuf.QRname, ChrPtr(migr_chardata), sizeof qrbuf.QRname);
else if (!strcasecmp(el, "QRpasswd")) safestrncpy(qrbuf.QRpasswd, ChrPtr(migr_chardata), sizeof qrbuf.QRpasswd);
else if (!strcasecmp(el, "QRroomaide")) qrbuf.QRroomaide = atol(ChrPtr(migr_chardata));
}
-int migr_floorrecord(void *data, const char *el)
-{
+int migr_floorrecord(void *data, const char *el) {
if (!strcasecmp(el, "f_num")) floornum = atoi(ChrPtr(migr_chardata));
else if (!strcasecmp(el, "f_flags")) flbuf.f_flags = atoi(ChrPtr(migr_chardata));
else if (!strcasecmp(el, "f_name")) safestrncpy(flbuf.f_name, ChrPtr(migr_chardata), sizeof flbuf.f_name);
}
-int migr_visitrecord(void *data, const char *el)
-{
+int migr_visitrecord(void *data, const char *el) {
if (!strcasecmp(el, "v_roomnum")) vbuf.v_roomnum = atol(ChrPtr(migr_chardata));
else if (!strcasecmp(el, "v_roomgen")) vbuf.v_roomgen = atol(ChrPtr(migr_chardata));
else if (!strcasecmp(el, "v_usernum")) vbuf.v_usernum = atol(ChrPtr(migr_chardata));
}
-void migr_xml_end(void *data, const char *el)
-{
+void migr_xml_end(void *data, const char *el) {
const char *ptr;
int msgcount = 0;
long msgnum = 0L;
}
if (citadel_migrate_data != 1) {
- syslog(LOG_ALERT, "Out-of-sequence tag <%s> detected. Warning: ODD-DATA!", el);
+ syslog(LOG_ERR, "migrate: out-of-sequence tag <%s> detected. Warning: ODD-DATA!", el);
return;
}
/*** CONFIG ***/
- if (!strcasecmp(el, "config"))
- {
- syslog(LOG_DEBUG, "Imported config key=%s", ikey);
+ if (!strcasecmp(el, "config")) {
+ syslog(LOG_DEBUG, "migrate: imported config key=%s", ikey);
if (ikey != NULL) {
CtdlSetConfigStr(ikey, (char *)ChrPtr(migr_chardata));
ikey = NULL;
}
else {
- syslog(LOG_INFO, "Closed a <config> tag but no key name was supplied.");
+ syslog(LOG_INFO, "migrate: closed a <config> tag but no key name was supplied.");
}
}
; /* Nothing to do anymore */
else if (!strcasecmp(el, "user")) {
CtdlPutUser(&usbuf);
- syslog(LOG_INFO, "Imported user: %s", usbuf.fullname);
+ syslog(LOG_INFO, "migrate: imported user: %s", usbuf.fullname);
}
/*** OPENID ***/
memcpy(&oid_data[sizeof(long)], openid_url, strlen(openid_url) + 1);
cdb_store(CDB_EXTAUTH, openid_url, strlen(openid_url), oid_data, oid_data_len);
free(oid_data);
- syslog(LOG_INFO, "Imported OpenID: %s (%ld)", openid_url, openid_usernum);
+ syslog(LOG_INFO, "migrate: imported OpenID: %s (%ld)", openid_url, openid_usernum);
}
/*** ROOM ***/
; /* Nothing to do anymore */
else if (!strcasecmp(el, "room")) {
CtdlPutRoom(&qrbuf);
- syslog(LOG_INFO, "Imported room: %s", qrbuf.QRname);
+ syslog(LOG_INFO, "migrate: imported room: %s", qrbuf.QRname);
}
/*** ROOM MESSAGE POINTERS ***/
- else if (!strcasecmp(el, "FRname")) safestrncpy(FRname, ChrPtr(migr_chardata), sizeof FRname);
+ else if (!strcasecmp(el, "FRname")) {
+ safestrncpy(FRname, ChrPtr(migr_chardata), sizeof FRname);
+ }
else if (!strcasecmp(el, "FRmsglist")) {
if (!IsEmptyStr(FRname)) {
msglist_alloc = 1000;
msglist = malloc(sizeof(long) * msglist_alloc);
- syslog(LOG_DEBUG, "Message list for: %s", FRname);
+ syslog(LOG_DEBUG, "migrate: message list for: %s", FRname);
ptr = ChrPtr(migr_chardata);
while (*ptr != 0) {
free(msglist);
msglist = NULL;
msglist_alloc = 0;
- syslog(LOG_DEBUG, "Imported %d messages.", msgcount);
+ syslog(LOG_DEBUG, "migrate: imported %d messages.", msgcount);
if (server_shutting_down) {
return;
}
else if (!strcasecmp(el, "floor")) {
CtdlPutFloor(&flbuf, floornum);
- syslog(LOG_INFO, "Imported floor #%d (%s)", floornum, flbuf.f_name);
+ syslog(LOG_INFO, "migrate: imported floor #%d (%s)", floornum, flbuf.f_name);
}
/*** VISITS ***/
}
else if (!strcasecmp(el, "visit")) {
put_visit(&vbuf);
- syslog(LOG_INFO, "Imported visit: %ld/%ld/%ld", vbuf.v_roomnum, vbuf.v_roomgen, vbuf.v_usernum);
+ syslog(LOG_INFO, "migrate: imported visit: %ld/%ld/%ld", vbuf.v_roomnum, vbuf.v_roomgen, vbuf.v_usernum);
}
/*** MESSAGES ***/
else if (!strcasecmp(el, "msg_meta_rfc822_length")) smi.meta_rfc822_length = atoi(ChrPtr(migr_chardata));
else if (!strcasecmp(el, "msg_meta_content_type")) safestrncpy(smi.meta_content_type, ChrPtr(migr_chardata), sizeof smi.meta_content_type);
- else if (!strcasecmp(el, "msg_text"))
- {
+ else if (!strcasecmp(el, "msg_text")) {
long rc;
struct CtdlMessage *msg;
}
syslog(LOG_INFO,
- "%s message #%ld, size=%d, refcount=%d, bodylength=%ld, content-type: %s",
+ "migrate: %s message #%ld, size=%d, refcount=%d, bodylength=%ld, content-type: %s",
(rc!= 0)?"failed to import ":"Imported ",
import_msgnum,
StrLength(migr_MsgData),
* Import begins here
*/
void migr_do_import(void) {
- StrBuf *Buf;
XML_Parser xp;
- int Finished = 0;
+ char buf[SIZ];
unbuffer_output();
migr_chardata = NewStrBufPlain(NULL, SIZ * 20);
migr_MsgData = NewStrBufPlain(NULL, SIZ * 20);
- Buf = NewStrBufPlain(NULL, SIZ);
xp = XML_ParserCreate(NULL);
if (!xp) {
cprintf("%d Failed to create XML parser instance\n", ERROR+INTERNAL_ERROR);
client_set_inbound_buf(SIZ * 10);
- while (!Finished && client_read_random_blob(Buf, -1) >= 0) {
- if ((StrLength(Buf) > 4) && !strcmp(ChrPtr(Buf) + StrLength(Buf) - 4, "000\n")) {
- Finished = 1;
- StrBufCutAt(Buf, StrLength(Buf) - 4, NULL);
- }
+ while (client_getln(buf, sizeof buf) >= 0 && strcmp(buf, "000")) {
+ XML_Parse(xp, buf, strlen(buf), 0);
if (server_shutting_down)
break; // Should we break or return?
-
- if (StrLength(Buf) == 0)
- continue;
-
- XML_Parse(xp, ChrPtr(Buf), StrLength(Buf), 0);
- FlushStrBuf(Buf);
}
XML_Parse(xp, "", 0, 1);
XML_ParserFree(xp);
- FreeStrBuf(&Buf);
FreeStrBuf(&migr_chardata);
FreeStrBuf(&migr_MsgData);
rebuild_euid_index();
StrBuf *PlainMessageBuf = NULL;
HashList *UsedMessageIDS = NULL;
-int migr_restore_message_metadata(long msgnum, int refcount)
-{
- CitContext *CCC = MyContext();
+int migr_restore_message_metadata(long msgnum, int refcount) {
struct MetaData smi;
struct CtdlMessage *msg;
char *mptr = NULL;
}
}
- CCC->redirect_buffer = PlainMessageBuf;
+ CC->redirect_buffer = PlainMessageBuf;
CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, QP_EADDR);
- smi.meta_rfc822_length = StrLength(CCC->redirect_buffer);
- CCC->redirect_buffer = NULL;
+ smi.meta_rfc822_length = StrLength(CC->redirect_buffer);
+ CC->redirect_buffer = NULL;
syslog(LOG_INFO,
- "Setting message #%ld meta data to: refcount=%d, bodylength=%ld, content-type: %s",
+ "migrate: setting message #%ld meta data to: refcount=%d, bodylength=%ld, content-type: %s",
smi.meta_msgnum,
smi.meta_refcount,
smi.meta_rfc822_length,
);
PutMetaData(&smi);
-
CM_Free(msg);
-
return 0;
}
void migr_check_rooms_backend(struct ctdlroom *buf, void *data) {
-
/* message list goes inside this tag */
-
CtdlGetRoom(&CC->room, buf->QRname);
CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, migr_check_room_msg, NULL);
}
const char *Pos = NULL;
StrBuf *oneRoom = NewStrBuf();
- syslog(LOG_INFO, "removing message pointer %ld from these rooms: %s", msgnum, ChrPtr(RoomNameVec));
+ syslog(LOG_INFO, "migrate: removing message pointer %ld from these rooms: %s", msgnum, ChrPtr(RoomNameVec));
while (Pos != StrBufNOTNULL){
StrBufExtract_NextToken(oneRoom, RoomNameVec, &Pos, '|');
* exporting the message multiple times.)
*/
snprintf(cmd, sizeof cmd, "sort -n <%s >%s", migr_tempfilename1, migr_tempfilename2);
- if (system(cmd) != 0) syslog(LOG_ALERT, "Error %d", errno);
+ if (system(cmd) != 0) {
+ syslog(LOG_ERR, "migrate: error %d", errno);
+ }
RoomNames = NewStrBuf();
Ctx = CC;
migr_global_message_list = fopen(migr_tempfilename2, "r");
if (migr_global_message_list != NULL) {
- syslog(LOG_INFO, "Opened %s", migr_tempfilename1);
+ syslog(LOG_INFO, "migrate: opened %s", migr_tempfilename1);
while ((Ctx->kill_me == 0) &&
(fgets(buf, sizeof(buf), migr_global_message_list) != NULL)) {
msgnum = atol(buf);
void cmd_migr(char *cmdbuf) {
char cmd[32];
- if (CtdlAccessCheck(ac_internal)) return;
+ if (CtdlAccessCheck(ac_aide)) return;
if (CtdlTrySingleUser()) {
CtdlDisableHouseKeeping();