citadel/modules/upgrade/serv_upgrade.c

   1 /*
   2  * Transparently handle the upgrading of server data formats.  If we see
   3  * an existing version number of our database, we can make some intelligent
   4  * guesses about what kind of data format changes need to be applied, and
   5  * we apply them transparently.
   6  *
   7  * Copyright (c) 1987-2017 by the citadel.org team
   8  *
   9  * This program is open source software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License version 3.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  */
  17
  18 #include "sysdep.h"
  19 #include <stdlib.h>
  20 #include <unistd.h>
  21 #include <stdio.h>
  22 #include <fcntl.h>
  23 #include <signal.h>
  24 #include <pwd.h>
  25 #include <errno.h>
  26 #include <sys/types.h>
  27
  28 #if TIME_WITH_SYS_TIME
  29 # include <sys/time.h>
  30 # include <time.h>
  31 #else
  32 # if HAVE_SYS_TIME_H
  33 #  include <sys/time.h>
  34 # else
  35 #  include <time.h>
  36 # endif
  37 #endif
  38
  39 #include <sys/wait.h>
  40 #include <string.h>
  41 #include <limits.h>
  42 #include <libcitadel.h>
  43 #include "citadel.h"
  44 #include "server.h"
  45 #include "citserver.h"
  46 #include "support.h"
  47 #include "config.h"
  48 #include "control.h"
  49 #include "database.h"
  50 #include "user_ops.h"
  51 #include "msgbase.h"
  52 #include "serv_upgrade.h"
  53 #include "euidindex.h"
  54 #include "ctdl_module.h"
  55 #include "serv_vcard.h"
  56 #include "internet_addressing.h"
  57
  58
  59 /*
  60  * Fix up the name for Citadel user 0 and try to remove any extra users with number 0
  61  */
  62 void fix_sys_user_name(void)
  63 {
  64         struct ctdluser usbuf;
  65         char usernamekey[USERNAME_SIZE];
  66
  67         /** If we have a user called Citadel rename them to SYS_Citadel */
  68         if (CtdlGetUser(&usbuf, "Citadel") == 0)
  69         {
  70                 rename_user("Citadel", "SYS_Citadel");
  71         }
  72
  73         while (CtdlGetUserByNumber(&usbuf, 0) == 0)
  74         {
  75                 /* delete user with number 0 and no name */
  76                 if (IsEmptyStr(usbuf.fullname)) {
  77                         cdb_delete(CDB_USERS, "", 0);
  78                 }
  79                 else {
  80                         /* temporarily set this user to -1 */
  81                         usbuf.usernum = -1;
  82                         CtdlPutUser(&usbuf);
  83                 }
  84         }
  85
  86         /* Make sure user SYS_* is user 0 */
  87         while (CtdlGetUserByNumber(&usbuf, -1) == 0)
  88         {
  89                 if (strncmp(usbuf.fullname, "SYS_", 4))
  90                 {       /* Delete any user 0 that doesn't start with SYS_ */
  91                         makeuserkey(usernamekey, usbuf.fullname, cutuserkey(usbuf.fullname));
  92                         cdb_delete(CDB_USERS, usernamekey, strlen(usernamekey));
  93                 }
  94                 else {
  95                         usbuf.usernum = 0;
  96                         CtdlPutUser(&usbuf);
  97                 }
  98         }
  99 }
 100
 101
 102 /*
 103  * Back end processing function for reindex_uids()
 104  * Call this function as a ForEachUser backend in order to queue up
 105  * user names, or call it with a null user to make it do the processing.
 106  * This allows us to maintain the list as a static instead of passing
 107  * pointers around.
 108  */
 109 void reindex_uids_backend(struct ctdluser *usbuf, void *data) {
 110         static struct UserProcList *uplist = NULL;
 111         struct UserProcList *ptr;
 112         struct ctdluser us;
 113
 114         /* this is the calling mode where we add a user */
 115
 116         if (usbuf != NULL) {
 117                 ptr = (struct UserProcList *) malloc(sizeof (struct UserProcList));
 118                 if (ptr == NULL) {
 119                         return;
 120                 }
 121
 122                 safestrncpy(ptr->user, usbuf->fullname, sizeof ptr->user);
 123                 ptr->next = uplist;
 124                 uplist = ptr;
 125                 return;
 126         }
 127
 128         /* this is the calling mode where we do the processing */
 129
 130         while (uplist != NULL) {
 131
 132                 if (CtdlGetUserLock(&us, uplist->user) == 0) {
 133                         syslog(LOG_DEBUG, "Processing <%s> (%d)", uplist->user, us.uid);
 134                         if (us.uid == CTDLUID) {
 135                                 us.uid = NATIVE_AUTH_UID;
 136                         }
 137                         CtdlPutUserLock(&us);
 138                 }
 139
 140                 ptr = uplist;
 141                 uplist = uplist->next;
 142                 free(ptr);
 143         }
 144 }
 145
 146 /*
 147  * Build extauth index of all users with uid-based join (system auth, LDAP auth)
 148  * Also changes all users with a uid of CTDLUID to NATIVE_AUTH_UID (-1)
 149  */
 150 void reindex_uids(void) {
 151         syslog(LOG_WARNING, "upgrade: reindexing and applying uid changes");
 152         ForEachUser(reindex_uids_backend, NULL);
 153         reindex_uids_backend(NULL, NULL);
 154         return;
 155 }
 156
 157
 158
 159 /*
 160  * These accounts may have been created by code that ran between mid 2008 and early 2011.
 161  * If present they are no longer in use and may be deleted.
 162  */
 163 void remove_thread_users(void) {
 164         char *deleteusers[] = {
 165                 "SYS_checkpoint",
 166                 "SYS_extnotify",
 167                 "SYS_IGnet Queue",
 168                 "SYS_indexer",
 169                 "SYS_network",
 170                 "SYS_popclient",
 171                 "SYS_purger",
 172                 "SYS_rssclient",
 173                 "SYS_select_on_master",
 174                 "SYS_SMTP Send"
 175         };
 176
 177         int i;
 178         struct ctdluser usbuf;
 179         for (i=0; i<(sizeof(deleteusers)/sizeof(char *)); ++i) {
 180                 if (CtdlGetUser(&usbuf, deleteusers[i]) == 0) {
 181                         usbuf.axlevel = 0;
 182                         strcpy(usbuf.password, "deleteme");
 183                         CtdlPutUser(&usbuf);
 184                         syslog(LOG_INFO,
 185                                 "System user account <%s> is no longer in use and will be deleted.",
 186                                 deleteusers[i]
 187                         );
 188                 }
 189         }
 190 }
 191
 192
 193 /*
 194  * Attempt to guess the name of the time zone currently in use
 195  * on the underlying host system.
 196  */
 197 void guess_time_zone(void) {
 198         FILE *fp;
 199         char buf[PATH_MAX];
 200
 201         fp = popen(file_guesstimezone, "r");
 202         if (fp) {
 203                 if (fgets(buf, sizeof buf, fp) && (strlen(buf) > 2)) {
 204                         buf[strlen(buf)-1] = 0;
 205                         CtdlSetConfigStr("c_default_cal_zone", buf);
 206                         syslog(LOG_INFO, "Configuring timezone: %s", buf);
 207                 }
 208                 fclose(fp);
 209         }
 210 }
 211
 212
 213 /*
 214  * Per-room callback function for ingest_old_roominfo_and_roompic_files()
 215  *
 216  * This is the second pass, where we process the list of rooms with info or pic files.
 217  */
 218 void iorarf_oneroom(char *roomname, char *infofile, char *picfile)
 219 {
 220         FILE *fp;
 221         long data_length;
 222         char *unencoded_data;
 223         char *encoded_data;
 224         long info_msgnum = 0;
 225         long pic_msgnum = 0;
 226         char subject[SIZ];
 227
 228         // Test for the presence of a legacy "room info file"
 229         if (!IsEmptyStr(infofile)) {
 230                 fp = fopen(infofile, "r");
 231         }
 232         else {
 233                 fp = NULL;
 234         }
 235         if (fp) {
 236                 fseek(fp, 0, SEEK_END);
 237                 data_length = ftell(fp);
 238
 239                 if (data_length >= 1) {
 240                         rewind(fp);
 241                         unencoded_data = malloc(data_length);
 242                         if (unencoded_data) {
 243                                 fread(unencoded_data, data_length, 1, fp);
 244                                 encoded_data = malloc((data_length * 2) + 100);
 245                                 if (encoded_data) {
 246                                         sprintf(encoded_data, "Content-type: text/plain\nContent-transfer-encoding: base64\n\n");
 247                                         CtdlEncodeBase64(&encoded_data[strlen(encoded_data)], unencoded_data, data_length, 1);
 248                                         snprintf(subject, sizeof subject, "Imported room banner for %s", roomname);
 249                                         info_msgnum = quickie_message("Citadel", NULL, NULL, SYSCONFIGROOM, encoded_data, FMT_RFC822, subject);
 250                                         free(encoded_data);
 251                                 }
 252                                 free(unencoded_data);
 253                         }
 254                 }
 255                 fclose(fp);
 256                 if (info_msgnum > 0) unlink(infofile);
 257         }
 258
 259         // Test for the presence of a legacy "room picture file" and import it.
 260         if (!IsEmptyStr(picfile)) {
 261                 fp = fopen(picfile, "r");
 262         }
 263         else {
 264                 fp = NULL;
 265         }
 266         if (fp) {
 267                 fseek(fp, 0, SEEK_END);
 268                 data_length = ftell(fp);
 269
 270                 if (data_length >= 1) {
 271                         rewind(fp);
 272                         unencoded_data = malloc(data_length);
 273                         if (unencoded_data) {
 274                                 fread(unencoded_data, data_length, 1, fp);
 275                                 encoded_data = malloc((data_length * 2) + 100);
 276                                 if (encoded_data) {
 277                                         sprintf(encoded_data, "Content-type: image/gif\nContent-transfer-encoding: base64\n\n");
 278                                         CtdlEncodeBase64(&encoded_data[strlen(encoded_data)], unencoded_data, data_length, 1);
 279                                         snprintf(subject, sizeof subject, "Imported room icon for %s", roomname);
 280                                         pic_msgnum = quickie_message("Citadel", NULL, NULL, SYSCONFIGROOM, encoded_data, FMT_RFC822, subject);
 281                                         free(encoded_data);
 282                                 }
 283                                 free(unencoded_data);
 284                         }
 285                 }
 286                 fclose(fp);
 287                 if (pic_msgnum > 0) unlink(picfile);
 288         }
 289
 290         // Now we have the message numbers of our new banner and icon.  Record them in the room record.
 291         // NOTE: we are not deleting the old msgnum_info because that position in the record was previously
 292         // a pointer to the highest message number which existed in the room when the info file was saved,
 293         // and we don't want to delete messages that are not *actually* old banners.
 294         struct ctdlroom qrbuf;
 295         if (CtdlGetRoomLock(&qrbuf, roomname) == 0) {
 296                 qrbuf.msgnum_info = info_msgnum;
 297                 qrbuf.msgnum_pic = pic_msgnum;
 298                 CtdlPutRoomLock(&qrbuf);
 299         }
 300
 301 }
 302
 303
 304 struct iorarf_list {
 305         struct iorarf_list *next;
 306         char name[ROOMNAMELEN];
 307         char info[PATH_MAX];
 308         char pic[PATH_MAX];
 309 };
 310
 311
 312 /*
 313  * Per-room callback function for ingest_old_roominfo_and_roompic_files()
 314  *
 315  * This is the first pass, where the list of qualifying rooms is gathered.
 316  */
 317 void iorarf_backend(struct ctdlroom *qrbuf, void *data)
 318 {
 319         FILE *fp;
 320         struct iorarf_list **iorarf_list = (struct iorarf_list **)data;
 321
 322         struct iorarf_list *i = malloc(sizeof(struct iorarf_list));
 323         i->next = *iorarf_list;
 324         strcpy(i->name, qrbuf->QRname);
 325         strcpy(i->info, "");
 326         strcpy(i->pic, "");
 327
 328         // Test for the presence of a legacy "room info file"
 329         assoc_file_name(i->info, sizeof i->info, qrbuf, ctdl_info_dir);
 330         fp = fopen(i->info, "r");
 331         if (fp) {
 332                 fclose(fp);
 333         }
 334         else {
 335                 i->info[0] = 0;
 336         }
 337
 338         // Test for the presence of a legacy "room picture file"
 339         assoc_file_name(i->pic, sizeof i->pic, qrbuf, ctdl_image_dir);
 340         fp = fopen(i->pic, "r");
 341         if (fp) {
 342                 fclose(fp);
 343         }
 344         else {
 345                 i->pic[0] = 0;
 346         }
 347
 348         if ( (!IsEmptyStr(i->info)) || (!IsEmptyStr(i->pic)) ) {
 349                 *iorarf_list = i;
 350         }
 351         else {
 352                 free(i);
 353         }
 354 }
 355
 356
 357 /*
 358  * Prior to Citadel Server version 902, room info and pictures (which comprise the
 359  * displayed banner for each room) were stored in the filesystem.  If we are upgrading
 360  * from version >000 to version >=902, ingest those files into the database.
 361  */
 362 void ingest_old_roominfo_and_roompic_files(void)
 363 {
 364         struct iorarf_list *il = NULL;
 365
 366         CtdlForEachRoom(iorarf_backend, &il);
 367
 368         struct iorarf_list *p;
 369         while (il) {
 370                 iorarf_oneroom(il->name, il->info, il->pic);
 371                 p = il->next;
 372                 free(il);
 373                 il = p;
 374         }
 375
 376         unlink(ctdl_info_dir);
 377 }
 378
 379
 380 /*
 381  * Perform any upgrades that can be done automatically based on our knowledge of the previous
 382  * version of Citadel server that was running here.
 383  *
 384  * Note that if the previous version was 0 then this is a new installation running for the first time.
 385  */
 386 void update_config(void) {
 387
 388         int oldver = CtdlGetConfigInt("MM_hosted_upgrade_level");
 389
 390         if (oldver < 606) {
 391                 CtdlSetConfigInt("c_rfc822_strict_from", 0);
 392         }
 393
 394         if (oldver < 609) {
 395                 CtdlSetConfigInt("c_purge_hour", 3);
 396         }
 397
 398         if (oldver < 615) {
 399                 CtdlSetConfigInt("c_ldap_port", 389);
 400         }
 401
 402         if (oldver < 623) {
 403                 CtdlSetConfigStr("c_ip_addr", "*");
 404         }
 405
 406         if (oldver < 650) {
 407                 CtdlSetConfigInt("c_enable_fulltext", 1);
 408         }
 409
 410         if (oldver < 652) {
 411                 CtdlSetConfigInt("c_auto_cull", 1);
 412         }
 413
 414         if (oldver < 725) {
 415                 CtdlSetConfigInt("c_xmpp_c2s_port", 5222);
 416                 CtdlSetConfigInt("c_xmpp_s2s_port", 5269);
 417         }
 418
 419         if (oldver < 830) {
 420                 CtdlSetConfigInt("c_nntp_port", 119);
 421                 CtdlSetConfigInt("c_nntps_port", 563);
 422         }
 423
 424         if (IsEmptyStr(CtdlGetConfigStr("c_default_cal_zone"))) {
 425                 guess_time_zone();
 426         }
 427 }
 428
 429
 430 /*
 431  * Helper function for move_inet_addrs_from_vcards_to_user_records()
 432  *
 433  * Call this function as a ForEachUser backend in order to queue up
 434  * user names, or call it with a null user to make it do the processing.
 435  * This allows us to maintain the list as a static instead of passing
 436  * pointers around.
 437  */
 438 void miafvtur_backend(struct ctdluser *usbuf, void *data) {
 439
 440         struct miafvtur {
 441                 char name[64];
 442                 char emails[512];
 443         };
 444
 445         static struct miafvtur *m = NULL;
 446         static int num_m = 0;
 447         static int alloc_m = 0;
 448
 449         /* this is the calling mode where we add a user */
 450
 451         if (usbuf != NULL) {
 452                 char primary_inet_email[512] = { 0 };
 453                 char other_inet_emails[512] = { 0 };
 454                 struct vCard *v = vcard_get_user(usbuf);
 455                 if (!v) return;
 456                 extract_inet_email_addrs(primary_inet_email, sizeof primary_inet_email, other_inet_emails, sizeof other_inet_emails, v, 1);
 457                 vcard_free(v);
 458
 459                 if ( (IsEmptyStr(primary_inet_email)) && (IsEmptyStr(other_inet_emails)) ) {
 460                         return;
 461                 }
 462
 463                 if (num_m >= alloc_m) {
 464                         if (alloc_m == 0) {
 465                                 alloc_m = 100;
 466                                 m = malloc(sizeof(struct miafvtur) * alloc_m);
 467                         }
 468                         else {
 469                                 alloc_m *= 2;
 470                                 m = realloc(m, (sizeof(struct miafvtur) * alloc_m));
 471                         }
 472                 }
 473
 474                 strcpy(m[num_m].name, usbuf->fullname);
 475                 snprintf(m[num_m].emails, 512, "%s%s%s",
 476                         (!IsEmptyStr(primary_inet_email) ? primary_inet_email : ""),
 477                         ((!IsEmptyStr(primary_inet_email)&&(!IsEmptyStr(other_inet_emails))) ? "|" : ""),
 478                         (!IsEmptyStr(other_inet_emails) ? other_inet_emails : "")
 479                 );
 480                 ++num_m;
 481                 return;
 482         }
 483
 484         /* this is the calling mode where we do the processing */
 485
 486         int i;
 487         struct ctdluser u;
 488
 489         for (i=0; i<num_m; ++i) {
 490                 syslog(LOG_DEBUG, "<%s> = <%s>", m[i].name, m[i].emails);
 491                 if (CtdlGetUser(&u, m[i].name) == 0) {
 492                         safestrncpy(u.emailaddrs, m[i].emails, sizeof u.emailaddrs);
 493                         CtdlPutUser(&u);
 494                 }
 495         }
 496         free(m);
 497         num_m = 0;
 498         alloc_m = 0;
 499         return;
 500 }
 501
 502
 503 /*
 504  * Prior to version 912 we kept a user's various Internet email addresses in their vCards.
 505  * This function moves them over to the user record, which is where we keep them now.
 506  */
 507 void move_inet_addrs_from_vcards_to_user_records(void)
 508 {
 509         ForEachUser(miafvtur_backend, NULL);
 510         miafvtur_backend(NULL, NULL);
 511         CtdlRebuildDirectoryIndex();
 512 }
 513
 514
 515 /*
 516  * Based on the server version number reported by the existing database,
 517  * run in-place data format upgrades until everything is up to date.
 518  */
 519 void check_server_upgrades(void) {
 520
 521         syslog(LOG_INFO, "Existing database version on disk is %d", CtdlGetConfigInt("MM_hosted_upgrade_level"));
 522
 523         if (CtdlGetConfigInt("MM_hosted_upgrade_level") < REV_LEVEL) {
 524                 syslog(LOG_WARNING, "Server hosted updates need to be processed at this time.  Please wait...");
 525         }
 526         else {
 527                 return;
 528         }
 529
 530         update_config();
 531
 532         if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 591)) {
 533                 syslog(LOG_EMERG, "This database is too old to be upgraded.  Citadel server will exit.");
 534                 exit(EXIT_FAILURE);
 535         }
 536         if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 913)) {
 537                 reindex_uids();
 538         }
 539         if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 659)) {
 540                 rebuild_euid_index();
 541         }
 542         if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 735) {
 543                 fix_sys_user_name();
 544         }
 545         if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 736) {
 546                 rebuild_usersbynumber();
 547         }
 548         if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 790) {
 549                 remove_thread_users();
 550         }
 551         if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 810) {
 552                 struct ctdlroom QRoom;
 553                 if (!CtdlGetRoom(&QRoom, SMTP_SPOOLOUT_ROOM)) {
 554                         QRoom.QRdefaultview = VIEW_QUEUE;
 555                         CtdlPutRoom(&QRoom);
 556                 }
 557                 if (!CtdlGetRoom(&QRoom, FNBL_QUEUE_ROOM)) {
 558                         QRoom.QRdefaultview = VIEW_QUEUE;
 559                         CtdlPutRoom(&QRoom);
 560                 }
 561         }
 562
 563         if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 902)) {
 564                 ingest_old_roominfo_and_roompic_files();
 565         }
 566
 567         if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 912)) {
 568                 move_inet_addrs_from_vcards_to_user_records();
 569         }
 570
 571         CtdlSetConfigInt("MM_hosted_upgrade_level", REV_LEVEL);
 572
 573         /*
 574          * Negative values for maxsessions are not allowed.
 575          */
 576         if (CtdlGetConfigInt("c_maxsessions") < 0) {
 577                 CtdlSetConfigInt("c_maxsessions", 0);
 578         }
 579
 580         /* We need a system default message expiry policy, because this is
 581          * the top level and there's no 'higher' policy to fall back on.
 582          * By default, do not expire messages at all.
 583          */
 584         if (CtdlGetConfigInt("c_ep_mode") == 0) {
 585                 CtdlSetConfigInt("c_ep_mode", EXPIRE_MANUAL);
 586                 CtdlSetConfigInt("c_ep_value", 0);
 587         }
 588 }
 589
 590
 591 CTDL_MODULE_UPGRADE(upgrade)
 592 {
 593         check_server_upgrades();
 594
 595         /* return our module id for the Log */
 596         return "upgrade";
 597 }