Remove all references to userpic dir other than those required for ingesting legacy...
[citadel.git] / citadel / modules / migrate / serv_migrate.c
1 /*
2  * This module dumps and/or loads the Citadel database in XML format.
3  *
4  * Copyright (c) 1987-2016 by the citadel.org team
5  *
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.
8  *
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.
13  */
14
15 /*
16  * Explanation of <progress> tags:
17  *
18  * 0%              nothing
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
26  */
27
28 #include "sysdep.h"
29 #include <stdlib.h>
30 #include <unistd.h>
31 #include <stdio.h>
32 #include <fcntl.h>
33 #include <signal.h>
34 #include <pwd.h>
35 #include <errno.h>
36 #include <sys/types.h>
37
38 #if TIME_WITH_SYS_TIME
39 # include <sys/time.h>
40 # include <time.h>
41 #else
42 # if HAVE_SYS_TIME_H
43 #  include <sys/time.h>
44 # else
45 #  include <time.h>
46 # endif
47 #endif
48
49 #include <sys/wait.h>
50 #include <string.h>
51 #include <ctype.h>
52 #include <limits.h>
53 #include <expat.h>
54 #include <libcitadel.h>
55 #include "citadel.h"
56 #include "server.h"
57 #include "citserver.h"
58 #include "support.h"
59 #include "config.h"
60 #include "database.h"
61 #include "msgbase.h"
62 #include "user_ops.h"
63 #include "euidindex.h"
64 #include "ctdl_module.h"
65
66 #define END_OF_MESSAGE  "---eom---dbd---"
67
68 char migr_tempfilename1[PATH_MAX];
69 char migr_tempfilename2[PATH_MAX];
70 FILE *migr_global_message_list;
71 int total_msgs = 0;
72 char *ikey = NULL;                      // If we're importing a config key we store it here.
73
74
75 /******************************************************************************
76  *        Code which implements the export appears in this section            *
77  ******************************************************************************/
78
79 /*
80  * Output a string to the client with these characters escaped:  & < > " '
81  */
82 void xml_strout(char *str) {
83
84         char *c = str;
85
86         if (str == NULL) {
87                 return;
88         }
89
90         while (*c != 0) {
91                 if (*c == '\"') {
92                         client_write(HKEY("&quot;"));
93                 }
94                 else if (*c == '\'') {
95                         client_write(HKEY("&apos;"));
96                 }
97                 else if (*c == '<') {
98                         client_write(HKEY("&lt;"));
99                 }
100                 else if (*c == '>') {
101                         client_write(HKEY("&gt;"));
102                 }
103                 else if (*c == '&') {
104                         client_write(HKEY("&amp;"));
105                 }
106                 else {
107                         client_write(c, 1);
108                 }
109                 ++c;
110         }
111 }
112
113
114 /*
115  * Export a user record as XML
116  */
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"));
133 }
134
135
136 void migr_export_users(void) {
137         ForEachUser(migr_export_users_backend, NULL);
138 }
139
140
141 void migr_export_room_msg(long msgnum, void *userdata) {
142         cprintf("%ld\n", msgnum);
143         fprintf(migr_global_message_list, "%ld\n", msgnum);
144 }
145
146
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"));
159         }
160         cprintf("<QRinfo>%ld</QRinfo>\n", buf->QRinfo);
161         cprintf("<QRfloor>%d</QRfloor>\n", buf->QRfloor);
162         cprintf("<QRmtime>%ld</QRmtime>\n", (long)buf->QRmtime);
163         cprintf("<QRexpire_mode>%d</QRexpire_mode>\n", buf->QRep.expire_mode);
164         cprintf("<QRexpire_value>%d</QRexpire_value>\n", buf->QRep.expire_value);
165         cprintf("<QRnumber>%ld</QRnumber>\n", buf->QRnumber);
166         cprintf("<QRorder>%d</QRorder>\n", buf->QRorder);
167         cprintf("<QRflags2>%u</QRflags2>\n", buf->QRflags2);
168         cprintf("<QRdefaultview>%d</QRdefaultview>\n", buf->QRdefaultview);
169         client_write(HKEY("</room>\n"));
170
171         /* message list goes inside this tag */
172
173         CtdlGetRoom(&CC->room, buf->QRname);
174         client_write(HKEY("<room_messages>"));
175         client_write(HKEY("<FRname>")); xml_strout(CC->room.QRname);    client_write(HKEY("</FRname>\n"));
176         client_write(HKEY("<FRmsglist>"));
177         CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, migr_export_room_msg, NULL);
178         client_write(HKEY("</FRmsglist>\n"));
179         client_write(HKEY("</room_messages>\n"));
180
181
182 }
183
184
185 void migr_export_rooms(void) {
186         char cmd[SIZ];
187         migr_global_message_list = fopen(migr_tempfilename1, "w");
188         if (migr_global_message_list != NULL) {
189                 CtdlForEachRoom(migr_export_rooms_backend, NULL);
190                 fclose(migr_global_message_list);
191         }
192
193         /*
194          * Process the 'global' message list.  (Sort it and remove dups.
195          * Dups are ok because a message may be in more than one room, but
196          * this will be handled by exporting the reference count, not by
197          * exporting the message multiple times.)
198          */
199         snprintf(cmd, sizeof cmd, "sort -n <%s >%s", migr_tempfilename1, migr_tempfilename2);
200         if (system(cmd) != 0) syslog(LOG_ALERT, "Error %d", errno);
201         snprintf(cmd, sizeof cmd, "uniq <%s >%s", migr_tempfilename2, migr_tempfilename1);
202         if (system(cmd) != 0) syslog(LOG_ALERT, "Error %d", errno);
203
204
205         snprintf(cmd, sizeof cmd, "wc -l %s", migr_tempfilename1);
206         FILE *fp = popen(cmd, "r");
207         if (fp) {
208                 fgets(cmd, sizeof cmd, fp);
209                 pclose(fp);
210                 total_msgs = atoi(cmd);
211         }
212         else {
213                 total_msgs = 1; // any nonzero just to keep it from barfing
214         }
215         syslog(LOG_DEBUG, "Total messages to be exported: %d", total_msgs);
216 }
217
218
219 void migr_export_floors(void) {
220         struct floor qfbuf, *buf;
221         int i;
222
223         for (i=0; i < MAXFLOORS; ++i) {
224                 client_write(HKEY("<floor>\n"));
225                 cprintf("<f_num>%d</f_num>\n", i);
226                 CtdlGetFloor(&qfbuf, i);
227                 buf = &qfbuf;
228                 cprintf("<f_flags>%u</f_flags>\n", buf->f_flags);
229                 client_write(HKEY("<f_name>")); xml_strout(buf->f_name); client_write(HKEY("</f_name>\n"));
230                 cprintf("<f_ref_count>%d</f_ref_count>\n", buf->f_ref_count);
231                 cprintf("<f_ep_expire_mode>%d</f_ep_expire_mode>\n", buf->f_ep.expire_mode);
232                 cprintf("<f_ep_expire_value>%d</f_ep_expire_value>\n", buf->f_ep.expire_value);
233                 client_write(HKEY("</floor>\n"));
234         }
235 }
236
237
238 /*
239  * Return nonzero if the supplied string contains only characters which are valid in a sequence set.
240  */
241 int is_sequence_set(char *s) {
242         if (!s) return(0);
243
244         char *c = s;
245         char ch;
246         while (ch = *c++, ch) {
247                 if (!strchr("0123456789*,:", ch)) {
248                         return(0);
249                 }
250         }
251         return(1);
252 }
253
254
255
256 /* 
257  *  Traverse the visits file...
258  */
259 void migr_export_visits(void) {
260         visit vbuf;
261         struct cdbdata *cdbv;
262
263         cdb_rewind(CDB_VISIT);
264
265         while (cdbv = cdb_next_item(CDB_VISIT), cdbv != NULL) {
266                 memset(&vbuf, 0, sizeof(visit));
267                 memcpy(&vbuf, cdbv->ptr,
268                        ((cdbv->len > sizeof(visit)) ?
269                         sizeof(visit) : cdbv->len));
270                 cdb_free(cdbv);
271
272                 client_write(HKEY("<visit>\n"));
273                 cprintf("<v_roomnum>%ld</v_roomnum>\n", vbuf.v_roomnum);
274                 cprintf("<v_roomgen>%ld</v_roomgen>\n", vbuf.v_roomgen);
275                 cprintf("<v_usernum>%ld</v_usernum>\n", vbuf.v_usernum);
276
277                 client_write(HKEY("<v_seen>"));
278                 if ( (!IsEmptyStr(vbuf.v_seen)) && (is_sequence_set(vbuf.v_seen)) ) {
279                         xml_strout(vbuf.v_seen);
280                 }
281                 else {
282                         cprintf("%ld", vbuf.v_lastseen);
283                 }
284                 client_write(HKEY("</v_seen>"));
285
286                 if ( (!IsEmptyStr(vbuf.v_answered)) && (is_sequence_set(vbuf.v_answered)) ) {
287                         client_write(HKEY("<v_answered>"));
288                         xml_strout(vbuf.v_answered);
289                         client_write(HKEY("</v_answered>\n"));
290                 }
291
292                 cprintf("<v_flags>%u</v_flags>\n", vbuf.v_flags);
293                 cprintf("<v_view>%d</v_view>\n", vbuf.v_view);
294                 client_write(HKEY("</visit>\n"));
295         }
296 }
297
298
299 void migr_export_message(long msgnum) {
300         struct MetaData smi;
301         struct CtdlMessage *msg;
302         struct ser_ret smr;
303
304         /* We can use a static buffer here because there will never be more than
305          * one of this operation happening at any given time, and it's really best
306          * to just keep it allocated once instead of torturing malloc/free.
307          * Call this function with msgnum "-1" to free the buffer when finished.
308          */
309         static int encoded_alloc = 0;
310         static char *encoded_msg = NULL;
311
312         if (msgnum < 0) {
313                 if ((encoded_alloc == 0) && (encoded_msg != NULL)) {
314                         free(encoded_msg);
315                         encoded_alloc = 0;
316                         encoded_msg = NULL;
317                 }
318                 return;
319         }
320
321         /* Ok, here we go ... */
322
323         msg = CtdlFetchMessage(msgnum, 1, 0);
324         if (msg == NULL) return;        /* fail silently */
325
326         client_write(HKEY("<message>\n"));
327         GetMetaData(&smi, msgnum);
328         cprintf("<msg_msgnum>%ld</msg_msgnum>\n", msgnum);
329         cprintf("<msg_meta_refcount>%d</msg_meta_refcount>\n", smi.meta_refcount);
330         cprintf("<msg_meta_rfc822_length>%ld</msg_meta_rfc822_length>\n", smi.meta_rfc822_length);
331         client_write(HKEY("<msg_meta_content_type>")); xml_strout(smi.meta_content_type); client_write(HKEY("</msg_meta_content_type>\n"));
332         client_write(HKEY("<msg_mimetype>")); xml_strout(smi.mimetype); client_write(HKEY("</msg_mimetype>\n"));
333
334         client_write(HKEY("<msg_text>"));
335         CtdlSerializeMessage(&smr, msg);
336         CM_Free(msg);
337
338         /* Predict the buffer size we need.  Expand the buffer if necessary. */
339         int encoded_len = smr.len * 15 / 10 ;
340         if (encoded_len > encoded_alloc) {
341                 encoded_alloc = encoded_len;
342                 encoded_msg = realloc(encoded_msg, encoded_alloc);
343         }
344
345         if (encoded_msg == NULL) {
346                 /* Questionable hack that hopes it'll work next time and we only lose one message */
347                 encoded_alloc = 0;
348         }
349         else {
350                 /* Once we do the encoding we know the exact size */
351                 encoded_len = CtdlEncodeBase64(encoded_msg, (char *)smr.ser, smr.len, 1);
352                 client_write(encoded_msg, encoded_len);
353         }
354
355         free(smr.ser);
356
357         client_write(HKEY("</msg_text>\n"));
358         client_write(HKEY("</message>\n"));
359 }
360
361
362
363 void migr_export_openids(void) {
364         struct cdbdata *cdboi;
365         long usernum;
366         char url[512];
367
368         cdb_rewind(CDB_OPENID);
369         while (cdboi = cdb_next_item(CDB_OPENID), cdboi != NULL) {
370                 if (cdboi->len > sizeof(long)) {
371                         client_write(HKEY("<openid>\n"));
372                         memcpy(&usernum, cdboi->ptr, sizeof(long));
373                         snprintf(url, sizeof url, "%s", (cdboi->ptr)+sizeof(long) );
374                         client_write(HKEY("<oid_url>"));
375                         xml_strout(url);
376                         client_write(HKEY("</oid_url>\n"));
377                         cprintf("<oid_usernum>%ld</oid_usernum>\n", usernum);
378                         client_write(HKEY("</openid>\n"));
379                 }
380                 cdb_free(cdboi);
381         }
382 }
383
384
385 void migr_export_configs(void) {
386         struct cdbdata *cdbcfg;
387         int keylen = 0;
388         char *key = NULL;
389         char *value = NULL;
390
391         cdb_rewind(CDB_CONFIG);
392         while (cdbcfg = cdb_next_item(CDB_CONFIG), cdbcfg != NULL) {
393
394                 keylen = strlen(cdbcfg->ptr);
395                 key = cdbcfg->ptr;
396                 value = cdbcfg->ptr + keylen + 1;
397
398                 client_write("<config key=\"", 13);
399                 xml_strout(key);
400                 client_write("\">", 2);
401                 xml_strout(value);
402                 client_write("</config>\n", 10);
403                 cdb_free(cdbcfg);
404         }
405 }
406
407
408
409
410 void migr_export_messages(void) {
411         char buf[SIZ];
412         long msgnum;
413         int count = 0;
414         int progress = 0;
415         int prev_progress = 0;
416         CitContext *Ctx;
417
418         Ctx = CC;
419         migr_global_message_list = fopen(migr_tempfilename1, "r");
420         if (migr_global_message_list != NULL) {
421                 syslog(LOG_INFO, "Opened %s", migr_tempfilename1);
422                 while ((Ctx->kill_me == 0) && 
423                        (fgets(buf, sizeof(buf), migr_global_message_list) != NULL)) {
424                         msgnum = atol(buf);
425                         if (msgnum > 0L) {
426                                 migr_export_message(msgnum);
427                                 ++count;
428                         }
429                         progress = (count * 74 / total_msgs) + 25 ;
430                         if ((progress > prev_progress) && (progress < 100)) {
431                                 cprintf("<progress>%d</progress>\n", progress);
432                         }
433                         prev_progress = progress;
434                 }
435                 fclose(migr_global_message_list);
436         }
437         if (Ctx->kill_me == 0)
438                 syslog(LOG_INFO, "Exported %d messages.", count);
439         else
440                 syslog(LOG_ERR, "Export aborted due to client disconnect!");
441
442         migr_export_message(-1L);       /* This frees the encoding buffer */
443 }
444
445
446
447 void migr_do_export(void) {
448         CitContext *Ctx;
449
450         Ctx = CC;
451         cprintf("%d Exporting all Citadel databases.\n", LISTING_FOLLOWS);
452         Ctx->dont_term = 1;
453
454         client_write(HKEY("<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n"));
455         client_write(HKEY("<citadel_migrate_data>\n"));
456         cprintf("<version>%d</version>\n", REV_LEVEL);
457         cprintf("<progress>%d</progress>\n", 0);
458
459         /* export the configuration database */
460         migr_export_configs();
461         cprintf("<progress>%d</progress>\n", 2);
462         
463         if (Ctx->kill_me == 0)  migr_export_users();
464         cprintf("<progress>%d</progress>\n", 7);
465         if (Ctx->kill_me == 0)  migr_export_openids();
466         cprintf("<progress>%d</progress>\n", 12);
467         if (Ctx->kill_me == 0)  migr_export_rooms();
468         cprintf("<progress>%d</progress>\n", 17);
469         if (Ctx->kill_me == 0)  migr_export_floors();
470         cprintf("<progress>%d</progress>\n", 18);
471         if (Ctx->kill_me == 0)  migr_export_visits();
472         cprintf("<progress>%d</progress>\n", 25);
473         if (Ctx->kill_me == 0)  migr_export_messages();
474         client_write(HKEY("</citadel_migrate_data>\n"));
475         cprintf("<progress>%d</progress>\n", 100);
476         client_write(HKEY("000\n"));
477         Ctx->dont_term = 0;
478 }
479
480
481
482
483 /******************************************************************************
484  *                              Import code                                   *
485  *    Here's the code that implements the import side.  It's going to end up  *
486  *        being one big loop with lots of global variables.  I don't care.    *
487  * You wouldn't run multiple concurrent imports anyway.  If this offends your *
488  * delicate sensibilities  then go rewrite it in Ruby on Rails or something.  *
489  ******************************************************************************/
490
491
492 int citadel_migrate_data = 0;           /* Are we inside a <citadel_migrate_data> tag pair? */
493 StrBuf *migr_chardata = NULL;
494 StrBuf *migr_MsgData = NULL;
495 struct ctdluser usbuf;
496 struct ctdlroom qrbuf;
497 char openid_url[512];
498 long openid_usernum = 0;
499 char FRname[ROOMNAMELEN];
500 struct floor flbuf;
501 int floornum = 0;
502 visit vbuf;
503 struct MetaData smi;
504 long import_msgnum = 0;
505
506 /*
507  * This callback stores up the data which appears in between tags.
508  */
509 void migr_xml_chardata(void *data, const XML_Char *s, int len)
510 {
511         StrBufAppendBufPlain(migr_chardata, s, len, 0);
512 }
513
514
515 void migr_xml_start(void *data, const char *el, const char **attr) {
516         int i;
517
518         /*** GENERAL STUFF ***/
519
520         /* Reset chardata_len to zero and init buffer */
521         FlushStrBuf(migr_chardata);
522         FlushStrBuf(migr_MsgData);
523
524         if (!strcasecmp(el, "citadel_migrate_data")) {
525                 ++citadel_migrate_data;
526
527                 /* As soon as it looks like the input data is a genuine Citadel XML export,
528                  * whack the existing database on disk to make room for the new one.
529                  */
530                 if (citadel_migrate_data == 1) {
531                         for (i = 0; i < MAXCDB; ++i) {
532                                 cdb_trunc(i);
533                         }
534                 }
535                 return;
536         }
537
538         if (citadel_migrate_data != 1) {
539                 syslog(LOG_ALERT, "Out-of-sequence tag <%s> detected.  Warning: ODD-DATA!", el);
540                 return;
541         }
542
543         /* When we begin receiving XML for one of these record types, clear out the associated
544          * buffer so we don't accidentally carry over any data from a previous record.
545          */
546         if (!strcasecmp(el, "user"))                    memset(&usbuf, 0, sizeof (struct ctdluser));
547         else if (!strcasecmp(el, "openid"))             memset(openid_url, 0, sizeof openid_url);
548         else if (!strcasecmp(el, "room"))               memset(&qrbuf, 0, sizeof (struct ctdlroom));
549         else if (!strcasecmp(el, "room_messages"))      memset(FRname, 0, sizeof FRname);
550         else if (!strcasecmp(el, "floor"))              memset(&flbuf, 0, sizeof (struct floor));
551         else if (!strcasecmp(el, "visit"))              memset(&vbuf, 0, sizeof (visit));
552
553         else if (!strcasecmp(el, "message")) {
554                 memset(&smi, 0, sizeof (struct MetaData));
555                 import_msgnum = 0;
556         }
557         else if (!strcasecmp(el, "config")) {
558                 if (ikey != NULL) {
559                         free(ikey);
560                         ikey = NULL;
561                 }
562                 while (*attr) {
563                         if (!strcasecmp(attr[0], "key")) {
564                                 ikey = strdup(attr[1]);
565                         }
566                         attr += 2;
567                 }
568         }
569
570 }
571
572
573 int migr_userrecord(void *data, const char *el)
574 {
575         if (!strcasecmp(el, "u_version"))                       usbuf.version = atoi(ChrPtr(migr_chardata));
576         else if (!strcasecmp(el, "u_uid"))                      usbuf.uid = atol(ChrPtr(migr_chardata));
577         else if (!strcasecmp(el, "u_password"))                 safestrncpy(usbuf.password, ChrPtr(migr_chardata), sizeof usbuf.password);
578         else if (!strcasecmp(el, "u_flags"))                    usbuf.flags = atoi(ChrPtr(migr_chardata));
579         else if (!strcasecmp(el, "u_timescalled"))              usbuf.timescalled = atol(ChrPtr(migr_chardata));
580         else if (!strcasecmp(el, "u_posted"))                   usbuf.posted = atol(ChrPtr(migr_chardata));
581         else if (!strcasecmp(el, "u_axlevel"))                  usbuf.axlevel = atoi(ChrPtr(migr_chardata));
582         else if (!strcasecmp(el, "u_usernum"))                  usbuf.usernum = atol(ChrPtr(migr_chardata));
583         else if (!strcasecmp(el, "u_lastcall"))                 usbuf.lastcall = atol(ChrPtr(migr_chardata));
584         else if (!strcasecmp(el, "u_USuserpurge"))              usbuf.USuserpurge = atoi(ChrPtr(migr_chardata));
585         else if (!strcasecmp(el, "u_fullname"))                 safestrncpy(usbuf.fullname, ChrPtr(migr_chardata), sizeof usbuf.fullname);
586         else if (!strcasecmp(el, "u_msgnum_bio"))               usbuf.msgnum_bio = atol(ChrPtr(migr_chardata));
587         else if (!strcasecmp(el, "u_msgnum_pic"))               usbuf.msgnum_pic = atol(ChrPtr(migr_chardata));
588         else return 0;
589         return 1;
590 }
591
592
593 int migr_roomrecord(void *data, const char *el)
594 {
595         if (!strcasecmp(el, "QRname"))                  safestrncpy(qrbuf.QRname, ChrPtr(migr_chardata), sizeof qrbuf.QRname);
596         else if (!strcasecmp(el, "QRpasswd"))                   safestrncpy(qrbuf.QRpasswd, ChrPtr(migr_chardata), sizeof qrbuf.QRpasswd);
597         else if (!strcasecmp(el, "QRroomaide"))                 qrbuf.QRroomaide = atol(ChrPtr(migr_chardata));
598         else if (!strcasecmp(el, "QRhighest"))                  qrbuf.QRhighest = atol(ChrPtr(migr_chardata));
599         else if (!strcasecmp(el, "QRgen"))                      qrbuf.QRgen = atol(ChrPtr(migr_chardata));
600         else if (!strcasecmp(el, "QRflags"))                    qrbuf.QRflags = atoi(ChrPtr(migr_chardata));
601         else if (!strcasecmp(el, "QRdirname"))                  safestrncpy(qrbuf.QRdirname, ChrPtr(migr_chardata), sizeof qrbuf.QRdirname);
602         else if (!strcasecmp(el, "QRinfo"))                     qrbuf.QRinfo = atol(ChrPtr(migr_chardata));
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 return 0;
612         return 1;
613 }
614
615 int migr_floorrecord(void *data, const char *el)
616 {
617         if (!strcasecmp(el, "f_num"))                   floornum = atoi(ChrPtr(migr_chardata));
618         else if (!strcasecmp(el, "f_flags"))                    flbuf.f_flags = atoi(ChrPtr(migr_chardata));
619         else if (!strcasecmp(el, "f_name"))                     safestrncpy(flbuf.f_name, ChrPtr(migr_chardata), sizeof flbuf.f_name);
620         else if (!strcasecmp(el, "f_ref_count"))                flbuf.f_ref_count = atoi(ChrPtr(migr_chardata));
621         else if (!strcasecmp(el, "f_ep_expire_mode"))           flbuf.f_ep.expire_mode = atoi(ChrPtr(migr_chardata));
622         else if (!strcasecmp(el, "f_ep_expire_value"))          flbuf.f_ep.expire_value = atoi(ChrPtr(migr_chardata));
623         else return 0;
624         return 1;
625 }
626
627 int migr_visitrecord(void *data, const char *el)
628 {
629         if (!strcasecmp(el, "v_roomnum"))                       vbuf.v_roomnum = atol(ChrPtr(migr_chardata));
630         else if (!strcasecmp(el, "v_roomgen"))                  vbuf.v_roomgen = atol(ChrPtr(migr_chardata));
631         else if (!strcasecmp(el, "v_usernum"))                  vbuf.v_usernum = atol(ChrPtr(migr_chardata));
632
633         else if (!strcasecmp(el, "v_seen")) {
634                 int is_textual_seen = 0;
635                 int i;
636                 int max = StrLength(migr_chardata);
637
638                 vbuf.v_lastseen = atol(ChrPtr(migr_chardata));
639                 is_textual_seen = 0;
640                 for (i=0; i < max; ++i) 
641                         if (!isdigit(ChrPtr(migr_chardata)[i]))
642                                 is_textual_seen = 1;
643                 if (is_textual_seen)
644                         safestrncpy(vbuf.v_seen, ChrPtr(migr_chardata), sizeof vbuf.v_seen);
645         }
646
647         else if (!strcasecmp(el, "v_answered"))                 safestrncpy(vbuf.v_answered, ChrPtr(migr_chardata), sizeof vbuf.v_answered);
648         else if (!strcasecmp(el, "v_flags"))                    vbuf.v_flags = atoi(ChrPtr(migr_chardata));
649         else if (!strcasecmp(el, "v_view"))                     vbuf.v_view = atoi(ChrPtr(migr_chardata));
650         else return 0;
651         return 1;
652 }
653
654
655 void migr_xml_end(void *data, const char *el)
656 {
657         const char *ptr;
658         int msgcount = 0;
659         long msgnum = 0L;
660         long *msglist = NULL;
661         int msglist_alloc = 0;
662         /*** GENERAL STUFF ***/
663
664         if (!strcasecmp(el, "citadel_migrate_data")) {
665                 --citadel_migrate_data;
666                 return;
667         }
668
669         if (citadel_migrate_data != 1) {
670                 syslog(LOG_ALERT, "Out-of-sequence tag <%s> detected.  Warning: ODD-DATA!", el);
671                 return;
672         }
673
674         // syslog(LOG_DEBUG, "END TAG: <%s> DATA: <%s>\n", el, (migr_chardata_len ? migr_chardata : ""));
675
676         /*** CONFIG ***/
677
678         if (!strcasecmp(el, "config"))
679         {
680                 syslog(LOG_DEBUG, "Imported config key=%s", ikey);
681
682                 if (ikey != NULL) {
683                         CtdlSetConfigStr(ikey, ChrPtr(migr_chardata));
684                         free(ikey);
685                         ikey = NULL;
686                 }
687                 else {
688                         syslog(LOG_INFO, "Closed a <config> tag but no key name was supplied.");
689                 }
690         }
691
692         /*** USER ***/
693         else if ((!strncasecmp(el, HKEY("u_"))) && 
694                  migr_userrecord(data, el))
695                 ; /* Nothing to do anymore */
696         else if (!strcasecmp(el, "user")) {
697                 CtdlPutUser(&usbuf);
698                 syslog(LOG_INFO, "Imported user: %s", usbuf.fullname);
699         }
700
701         /*** OPENID ***/
702
703         else if (!strcasecmp(el, "oid_url"))                    safestrncpy(openid_url, ChrPtr(migr_chardata), sizeof openid_url);
704         else if (!strcasecmp(el, "oid_usernum"))                openid_usernum = atol(ChrPtr(migr_chardata));
705
706         else if (!strcasecmp(el, "openid")) {                   /* see serv_openid_rp.c for a description of the record format */
707                 char *oid_data;
708                 int oid_data_len;
709                 oid_data_len = sizeof(long) + strlen(openid_url) + 1;
710                 oid_data = malloc(oid_data_len);
711                 memcpy(oid_data, &openid_usernum, sizeof(long));
712                 memcpy(&oid_data[sizeof(long)], openid_url, strlen(openid_url) + 1);
713                 cdb_store(CDB_OPENID, openid_url, strlen(openid_url), oid_data, oid_data_len);
714                 free(oid_data);
715                 syslog(LOG_INFO, "Imported OpenID: %s (%ld)", openid_url, openid_usernum);
716         }
717
718         /*** ROOM ***/
719         else if ((!strncasecmp(el, HKEY("QR"))) && 
720                  migr_roomrecord(data, el))
721                 ; /* Nothing to do anymore */
722         else if (!strcasecmp(el, "room")) {
723                 CtdlPutRoom(&qrbuf);
724                 syslog(LOG_INFO, "Imported room: %s", qrbuf.QRname);
725         }
726
727         /*** ROOM MESSAGE POINTERS ***/
728
729         else if (!strcasecmp(el, "FRname"))                     safestrncpy(FRname, ChrPtr(migr_chardata), sizeof FRname);
730
731         else if (!strcasecmp(el, "FRmsglist")) {
732                 if (!IsEmptyStr(FRname)) {
733                         msgcount = 0;
734                         msglist_alloc = 1000;
735                         msglist = malloc(sizeof(long) * msglist_alloc);
736
737                         syslog(LOG_DEBUG, "Message list for: %s", FRname);
738
739                         ptr = ChrPtr(migr_chardata);
740                         while (*ptr != 0) {
741                                 while ((*ptr != 0) && (!isdigit(*ptr))) {
742                                         ++ptr;
743                                 }
744                                 if ((*ptr != 0) && (isdigit(*ptr))) {
745                                         msgnum = atol(ptr);
746                                         if (msgnum > 0L) {
747                                                 if (msgcount >= msglist_alloc) {
748                                                         msglist_alloc *= 2;
749                                                         msglist = realloc(msglist, sizeof(long) * msglist_alloc);
750                                                 }
751                                                 msglist[msgcount++] = msgnum;
752                                                 }
753                                         }
754                                         while ((*ptr != 0) && (isdigit(*ptr))) {
755                                                 ++ptr;
756                                         }
757                                 }
758                         }
759                         if (msgcount > 0) {
760                                 CtdlSaveMsgPointersInRoom(FRname, msglist, msgcount, 0, NULL, 1);
761                         }
762                         free(msglist);
763                         msglist = NULL;
764                         msglist_alloc = 0;
765                         syslog(LOG_DEBUG, "Imported %d messages.", msgcount);
766                         if (server_shutting_down) {
767                                 return;
768                 }
769         }
770
771         /*** FLOORS ***/
772         else if ((!strncasecmp(el, HKEY("f_"))) && 
773                  migr_floorrecord(data, el))
774                 ; /* Nothing to do anymore */
775
776         else if (!strcasecmp(el, "floor")) {
777                 CtdlPutFloor(&flbuf, floornum);
778                 syslog(LOG_INFO, "Imported floor #%d (%s)", floornum, flbuf.f_name);
779         }
780
781         /*** VISITS ***/
782         else if ((!strncasecmp(el, HKEY("v_"))) && 
783                  migr_visitrecord(data, el))
784                 ; /* Nothing to do anymore */
785         else if (!strcasecmp(el, "visit")) {
786                 put_visit(&vbuf);
787                 syslog(LOG_INFO, "Imported visit: %ld/%ld/%ld", vbuf.v_roomnum, vbuf.v_roomgen, vbuf.v_usernum);
788         }
789
790         /*** MESSAGES ***/
791         
792         else if (!strcasecmp(el, "msg_msgnum"))                 smi.meta_msgnum = import_msgnum = atol(ChrPtr(migr_chardata));
793         else if (!strcasecmp(el, "msg_meta_refcount"))          smi.meta_refcount = atoi(ChrPtr(migr_chardata));
794         else if (!strcasecmp(el, "msg_meta_rfc822_length"))     smi.meta_rfc822_length = atoi(ChrPtr(migr_chardata));
795         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_mimetype"))               safestrncpy(smi.mimetype, ChrPtr(migr_chardata), sizeof smi.mimetype);
797
798         else if (!strcasecmp(el, "msg_text"))
799         {
800                 long rc;
801                 struct CtdlMessage *msg;
802
803                 FlushStrBuf(migr_MsgData);
804                 StrBufDecodeBase64To(migr_chardata, migr_MsgData);
805
806                 msg = CtdlDeserializeMessage(import_msgnum, -1,
807                                              ChrPtr(migr_MsgData), 
808                                              StrLength(migr_MsgData));
809                 if (msg != NULL) {
810                         rc = CtdlSaveThisMessage(msg, import_msgnum, 0);
811                         if (rc == 0) {
812                                 PutMetaData(&smi);
813                         }
814                         CM_Free(msg);
815                 }
816                 else {
817                         rc = -1;
818                 }
819
820                 syslog(LOG_INFO,
821                        "%s message #%ld, size=%d, refcount=%d, bodylength=%ld, content-type: %s / %s",
822                        (rc!= 0)?"failed to import ":"Imported ",
823                        import_msgnum,
824                        StrLength(migr_MsgData),
825                        smi.meta_refcount,
826                        smi.meta_rfc822_length,
827                        smi.meta_content_type,
828                        smi.mimetype);
829                 memset(&smi, 0, sizeof(smi));
830         }
831
832         /*** MORE GENERAL STUFF ***/
833
834         FlushStrBuf(migr_chardata);
835 }
836
837
838
839
840 /*
841  * Import begins here
842  */
843 void migr_do_import(void) {
844         StrBuf *Buf;
845         XML_Parser xp;
846         int Finished = 0;
847         
848         unbuffer_output();
849         migr_chardata = NewStrBufPlain(NULL, SIZ * 20);
850         migr_MsgData = NewStrBufPlain(NULL, SIZ * 20);
851         Buf = NewStrBufPlain(NULL, SIZ);
852         xp = XML_ParserCreate(NULL);
853         if (!xp) {
854                 cprintf("%d Failed to create XML parser instance\n", ERROR+INTERNAL_ERROR);
855                 return;
856         }
857         XML_SetElementHandler(xp, migr_xml_start, migr_xml_end);
858         XML_SetCharacterDataHandler(xp, migr_xml_chardata);
859
860         CC->dont_term = 1;
861
862         cprintf("%d sock it to me\n", SEND_LISTING);
863         unbuffer_output();
864
865         client_set_inbound_buf(SIZ * 10);
866
867         while (!Finished && client_read_random_blob(Buf, -1) >= 0) {
868                 if ((StrLength(Buf) > 4) &&
869                     !strcmp(ChrPtr(Buf) + StrLength(Buf) - 4, "000\n"))
870                 {
871                         Finished = 1;
872                         StrBufCutAt(Buf, StrLength(Buf) - 4, NULL);
873                 }
874                 if (server_shutting_down)
875                         break;  // Should we break or return?
876                 
877                 if (StrLength(Buf) == 0)
878                         continue;
879
880                 XML_Parse(xp, ChrPtr(Buf), StrLength(Buf), 0);
881                 FlushStrBuf(Buf);
882         }
883
884         XML_Parse(xp, "", 0, 1);
885         XML_ParserFree(xp);
886         FreeStrBuf(&Buf);
887         FreeStrBuf(&migr_chardata);
888         FreeStrBuf(&migr_MsgData);
889         rebuild_euid_index();
890         rebuild_usersbynumber();
891         CtdlSetConfigInt("MM_fulltext_wordbreaker", -1);        // Set an invalid wordbreaker to force re-indexing
892         CC->dont_term = 0;
893 }
894
895
896
897 /******************************************************************************
898  *                         Dispatcher, Common code                            *
899  ******************************************************************************/
900 /*
901  * Dump out the pathnames of directories which can be copied "as is"
902  */
903 void migr_do_listdirs(void) {
904         cprintf("%d Don't forget these:\n", LISTING_FOLLOWS);
905         cprintf("files|%s\n",           ctdl_file_dir);
906         cprintf("messages|%s\n",        ctdl_message_dir);
907         cprintf("keys|%s\n",            ctdl_key_dir);
908         cprintf("images|%s\n",          ctdl_image_dir);
909         cprintf("info|%s\n",            ctdl_info_dir);
910         cprintf("000\n");
911 }
912
913 /******************************************************************************
914  *                    Repair database integrity                               *
915  ******************************************************************************/
916
917 StrBuf *PlainMessageBuf = NULL;
918 HashList *UsedMessageIDS = NULL;
919
920 int migr_restore_message_metadata(long msgnum, int refcount)
921 {
922         CitContext *CCC = MyContext();
923         struct MetaData smi;
924         struct CtdlMessage *msg;
925         char *mptr = NULL;
926
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.
931          */
932         static int encoded_alloc = 0;
933         static char *encoded_msg = NULL;
934
935         if (msgnum < 0) {
936                 if ((encoded_alloc == 0) && (encoded_msg != NULL)) {
937                         free(encoded_msg);
938                         encoded_alloc = 0;
939                         encoded_msg = NULL;
940                         // todo FreeStrBuf(&PlainMessageBuf); PlainMessageBuf = NULL;
941                 }
942                 return 0;
943         }
944
945         if (PlainMessageBuf == NULL) {
946                 PlainMessageBuf = NewStrBufPlain(NULL, 10*SIZ);
947         }
948
949         /* Ok, here we go ... */
950
951         msg = CtdlFetchMessage(msgnum, 1, 0);
952         if (msg == NULL) {
953                 return 1;
954         }
955
956         GetMetaData(&smi, msgnum);
957         smi.meta_msgnum = msgnum;
958         smi.meta_refcount = refcount;
959         
960         /* restore the content type from the message body: */
961         mptr = bmstrcasestr(msg->cm_fields[eMesageText], "Content-type:");
962         if (mptr != NULL) {
963                 char *aptr;
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)) {
968                         if ((*aptr == ';')
969                             || (*aptr == ' ')
970                             || (*aptr == 13)
971                             || (*aptr == 10)) {
972                                 memset(aptr, 0, sizeof(smi.meta_content_type) - (aptr - smi.meta_content_type));
973                         }
974                         else aptr++;
975                 }
976         }
977
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;
982
983
984         syslog(LOG_INFO,
985                "Setting message #%ld meta data to: refcount=%d, bodylength=%ld, content-type: %s / %s",
986                smi.meta_msgnum,
987                smi.meta_refcount,
988                smi.meta_rfc822_length,
989                smi.meta_content_type,
990                smi.mimetype);
991
992         PutMetaData(&smi);
993
994         CM_Free(msg);
995
996         return 0;
997 }
998
999 void migr_check_room_msg(long msgnum, void *userdata) {
1000         fprintf(migr_global_message_list, "%ld %s\n", msgnum, CC->room.QRname);
1001 }
1002
1003
1004 void migr_check_rooms_backend(struct ctdlroom *buf, void *data) {
1005
1006         /* message list goes inside this tag */
1007
1008         CtdlGetRoom(&CC->room, buf->QRname);
1009         CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, migr_check_room_msg, NULL);
1010 }
1011
1012 void RemoveMessagesFromRooms(StrBuf *RoomNameVec, long msgnum) {
1013         struct MetaData smi;
1014         const char *Pos = NULL;
1015         StrBuf *oneRoom = NewStrBuf();
1016
1017         syslog(LOG_INFO, "removing message pointer %ld from these rooms: %s", msgnum, ChrPtr(RoomNameVec));
1018
1019         while (Pos != StrBufNOTNULL){
1020                 StrBufExtract_NextToken(oneRoom, RoomNameVec, &Pos, '|');
1021                 CtdlDeleteMessages(ChrPtr(oneRoom), &msgnum, 1, "");
1022         };
1023         GetMetaData(&smi, msgnum);
1024         TDAP_AdjRefCount(msgnum, -smi.meta_refcount);
1025 }
1026
1027 void migr_do_restore_meta(void) {
1028         char buf[SIZ];
1029         int failGetMessage;
1030         long msgnum = 0;
1031         int lastnum = 0;
1032         int refcount = 0;
1033         CitContext *Ctx;
1034         char *prn;
1035         StrBuf *RoomNames;
1036         char cmd[SIZ];
1037
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);
1042         }
1043
1044         /*
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.)
1049          */
1050         snprintf(cmd, sizeof cmd, "sort -n <%s >%s", migr_tempfilename1, migr_tempfilename2);
1051         if (system(cmd) != 0) syslog(LOG_ALERT, "Error %d", errno);
1052
1053         RoomNames = NewStrBuf();
1054         Ctx = CC;
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)) {
1060                         msgnum = atol(buf);
1061                         if (msgnum == 0L) 
1062                                 continue;
1063                         if (lastnum == 0) {
1064                                 lastnum = msgnum;
1065                         }
1066                         prn = strchr(buf, ' ');
1067                         if (lastnum != msgnum) {
1068                                 failGetMessage = migr_restore_message_metadata(lastnum, refcount);
1069                                 if (failGetMessage) {
1070                                         RemoveMessagesFromRooms(RoomNames, lastnum);
1071                                 }
1072                                 refcount = 1;
1073                                 lastnum = msgnum;
1074                                 if (prn != NULL)
1075                                         StrBufPlain(RoomNames, prn + 1, -1);
1076                                 StrBufTrim(RoomNames);
1077                         }
1078                         else {
1079                                 if (prn != NULL) {
1080                                         if (StrLength(RoomNames) > 0)
1081                                                 StrBufAppendBufPlain(RoomNames, HKEY("|"), 0);
1082                                         StrBufAppendBufPlain(RoomNames, prn, -1, 1);
1083                                         StrBufTrim(RoomNames);
1084                                 }
1085                                 refcount ++;
1086                         }
1087                         lastnum = msgnum;
1088                 }
1089                 failGetMessage = migr_restore_message_metadata(msgnum, refcount);
1090                 if (failGetMessage) {
1091                         RemoveMessagesFromRooms(RoomNames, lastnum);
1092                 }
1093                 fclose(migr_global_message_list);
1094         }
1095
1096         migr_restore_message_metadata(-1L, -1); /* This frees the encoding buffer */
1097         cprintf("%d system analysis completed", CIT_OK);
1098         Ctx->kill_me = 1;
1099 }
1100
1101
1102
1103
1104 /******************************************************************************
1105  *                         Dispatcher, Common code                            *
1106  ******************************************************************************/
1107 void cmd_migr(char *cmdbuf) {
1108         char cmd[32];
1109         
1110         if (CtdlAccessCheck(ac_internal)) return;
1111         
1112         if (CtdlTrySingleUser())
1113         {
1114                 CtdlDisableHouseKeeping();
1115                 CtdlMakeTempFileName(migr_tempfilename1, sizeof migr_tempfilename1);
1116                 CtdlMakeTempFileName(migr_tempfilename2, sizeof migr_tempfilename2);
1117
1118                 extract_token(cmd, cmdbuf, 0, '|', sizeof cmd);
1119                 if (!strcasecmp(cmd, "export")) {
1120                         migr_do_export();
1121                 }
1122                 else if (!strcasecmp(cmd, "import")) {
1123                         migr_do_import();
1124                 }
1125                 else if (!strcasecmp(cmd, "listdirs")) {
1126                         migr_do_listdirs();
1127                 }
1128                 else if (!strcasecmp(cmd, "restoremeta")) {
1129                         migr_do_restore_meta();
1130                 }
1131                 else {
1132                         cprintf("%d illegal command\n", ERROR + ILLEGAL_VALUE);
1133                 }
1134
1135                 unlink(migr_tempfilename1);
1136                 unlink(migr_tempfilename2);
1137
1138                 CtdlEnableHouseKeeping();
1139                 CtdlEndSingleUser();
1140         }
1141         else
1142         {
1143                 cprintf("%d The migrator is already running.\n", ERROR + RESOURCE_BUSY);
1144         }
1145 }
1146
1147 /******************************************************************************
1148  *                              Module Hook                                  *
1149  ******************************************************************************/
1150
1151 CTDL_MODULE_INIT(migrate)
1152 {
1153         if (!threading)
1154         {
1155                 CtdlRegisterProtoHook(cmd_migr, "MIGR", "Across-the-wire migration");
1156         }
1157         
1158         /* return our module name for the log */
1159         return "migrate";
1160 }