citadel/control.c

   1 /*
   2  * $Id$
   3  *
   4  * This module handles states which are global to the entire server.
   5  *
   6  */
   7
   8 #include "sysdep.h"
   9 #include <stdlib.h>
  10 #include <unistd.h>
  11 #include <stdio.h>
  12 #include <fcntl.h>
  13 #include <signal.h>
  14
  15 #if TIME_WITH_SYS_TIME
  16 # include <sys/time.h>
  17 # include <time.h>
  18 #else
  19 # if HAVE_SYS_TIME_H
  20 #  include <sys/time.h>
  21 # else
  22 #  include <time.h>
  23 # endif
  24 #endif
  25
  26 #include <ctype.h>
  27 #include <string.h>
  28 #include <errno.h>
  29 #include <limits.h>
  30 #include <sys/types.h>
  31 #include <sys/file.h>
  32 #include <libcitadel.h>
  33 #include "citadel.h"
  34 #include "server.h"
  35 #include "control.h"
  36 #include "sysdep_decls.h"
  37 #include "support.h"
  38 #include "config.h"
  39 #include "msgbase.h"
  40 #include "citserver.h"
  41 #include "room_ops.h"
  42 #include "user_ops.h"
  43 #include "database.h"
  44 #include "threads.h"
  45
  46 #ifndef HAVE_SNPRINTF
  47 #include "snprintf.h"
  48 #endif
  49
  50 struct CitControl CitControl;
  51 extern struct config config;
  52 FILE *control_fp = NULL;
  53 long control_highest_user = 0;
  54
  55
  56 /*
  57  * lock_control  -  acquire a lock on the control record file.
  58  *                  This keeps multiple citservers from running concurrently.
  59  */
  60 void lock_control(void)
  61 {
  62 #ifdef HAVE_FLOCK
  63 /*
  64  * TODO: solaris manpages describe this function, but the headers
  65  * don't show it!
  66  */
  67
  68         if (flock(fileno(control_fp), (LOCK_EX | LOCK_NB))) {
  69                 CtdlLogPrintf(CTDL_EMERG, "citserver: unable to lock %s.\n", file_citadel_control);
  70                 CtdlLogPrintf(CTDL_EMERG, "Is another citserver already running?\n");
  71                 exit(CTDLEXIT_CONTROL);
  72         }
  73 #endif
  74 }
  75
  76 /*
  77  * callback to get highest room number when rebuilding control file
  78  */
  79 void control_find_highest(struct ctdlroom *qrbuf, void *data)
  80 {
  81         struct ctdlroom room;
  82         struct cdbdata *cdbfr;
  83         long *msglist;
  84         int num_msgs=0;
  85         int c;
  86
  87
  88         if (qrbuf->QRnumber > CitControl.MMnextroom)
  89                 CitControl.MMnextroom = qrbuf->QRnumber;
  90
  91         getroom (&room, qrbuf->QRname);
  92
  93         /* Load the message list */
  94         cdbfr = cdb_fetch(CDB_MSGLISTS, &room.QRnumber, sizeof(long));
  95         if (cdbfr != NULL) {
  96                 msglist = (long *) cdbfr->ptr;
  97                 num_msgs = cdbfr->len / sizeof(long);
  98         } else {
  99                 return; /* No messages at all?  No further action. */
 100         }
 101
 102         if (num_msgs>0)
 103         {
 104                 for (c=0; c<num_msgs; c++)
 105                 {
 106                         if (msglist[c] > CitControl.MMhighest)
 107                                 CitControl.MMhighest = msglist[c];
 108                 }
 109         }
 110         cdb_free(cdbfr);
 111         return;
 112 }
 113
 114
 115 /*
 116  * Callback to get highest user number.
 117  */
 118
 119 void control_find_user (struct ctdluser *EachUser, void *out_data)
 120 {
 121         if (EachUser->usernum > CitControl.MMnextuser)
 122                 CitControl.MMnextuser = EachUser->usernum;
 123 }
 124
 125
 126 /*
 127  * get_control  -  read the control record into memory.
 128  */
 129 void get_control(void)
 130 {
 131         static int already_have_control = 0;
 132
 133         /*
 134          * If we already have the control record in memory, there's no point
 135          * in reading it from disk again.
 136          */
 137         if (already_have_control) return;
 138
 139         /* Zero it out.  If the control record on disk is missing or short,
 140          * the system functions with all control record fields initialized
 141          * to zero.
 142          */
 143         memset(&CitControl, 0, sizeof(struct CitControl));
 144         if (control_fp == NULL) {
 145                 control_fp = fopen(file_citadel_control, "rb+");
 146                 if (control_fp != NULL) {
 147                         lock_control();
 148                         fchown(fileno(control_fp), config.c_ctdluid, -1);
 149                 }
 150         }
 151         if (control_fp == NULL) {
 152                 control_fp = fopen(file_citadel_control, "wb+");
 153                 if (control_fp != NULL) {
 154                         lock_control();
 155                         fchown(fileno(control_fp), config.c_ctdluid, -1);
 156                         memset(&CitControl, 0, sizeof(struct CitControl));
 157                         // Find highest room number and message number.
 158                         ForEachRoom(control_find_highest, NULL);
 159                         ForEachUser(control_find_user, NULL);
 160                         fwrite(&CitControl, sizeof(struct CitControl),
 161                                1, control_fp);
 162                         rewind(control_fp);
 163                 }
 164         }
 165         if (control_fp == NULL) {
 166                 CtdlLogPrintf(CTDL_ALERT, "ERROR opening %s: %s\n",
 167                                 file_citadel_control,
 168                                 strerror(errno));
 169                 return;
 170         }
 171
 172         rewind(control_fp);
 173         fread(&CitControl, sizeof(struct CitControl), 1, control_fp);
 174         already_have_control = 1;
 175 }
 176
 177 /*
 178  * put_control  -  write the control record to disk.
 179  */
 180 void put_control(void)
 181 {
 182
 183         if (control_fp != NULL) {
 184                 rewind(control_fp);
 185                 fwrite(&CitControl, sizeof(struct CitControl), 1,
 186                        control_fp);
 187                 fflush(control_fp);
 188         }
 189 }
 190
 191 /**
 192  * release_control - close our fd on exit
 193  */
 194 void release_control(void)
 195 {
 196         if (control_fp != NULL)
 197                 fclose(control_fp);
 198         control_fp = NULL;
 199 }
 200
 201 /*
 202  * get_new_message_number()  -  Obtain a new, unique ID to be used for a message.
 203  */
 204 long get_new_message_number(void)
 205 {
 206         long retval = 0L;
 207         begin_critical_section(S_CONTROL);
 208         get_control();
 209         retval = ++CitControl.MMhighest;
 210         put_control();
 211         end_critical_section(S_CONTROL);
 212         return(retval);
 213 }
 214
 215
 216 /*
 217  * CtdlGetCurrentMessageNumber()  -  Obtain the current highest message number in the system
 218  * This provides a quick way to initialise a variable that might be used to indicate
 219  * messages that should not be processed. EG. a new Sieve script will use this
 220  * to record determine that messages older than this should not be processed.
 221  */
 222 long CtdlGetCurrentMessageNumber(void)
 223 {
 224         long retval = 0L;
 225         begin_critical_section(S_CONTROL);
 226         get_control();
 227         retval = CitControl.MMhighest;
 228         end_critical_section(S_CONTROL);
 229         return(retval);
 230 }
 231
 232
 233 /*
 234  * get_new_user_number()  -  Obtain a new, unique ID to be used for a user.
 235  */
 236 long get_new_user_number(void)
 237 {
 238         long retval = 0L;
 239         begin_critical_section(S_CONTROL);
 240         get_control();
 241         retval = ++CitControl.MMnextuser;
 242         put_control();
 243         end_critical_section(S_CONTROL);
 244         return(retval);
 245 }
 246
 247
 248
 249 /*
 250  * get_new_room_number()  -  Obtain a new, unique ID to be used for a room.
 251  */
 252 long get_new_room_number(void)
 253 {
 254         long retval = 0L;
 255         begin_critical_section(S_CONTROL);
 256         get_control();
 257         retval = ++CitControl.MMnextroom;
 258         put_control();
 259         end_critical_section(S_CONTROL);
 260         return(retval);
 261 }
 262
 263
 264
 265 /*
 266  * Get or set global configuration options
 267  */
 268 void cmd_conf(char *argbuf)
 269 {
 270         char cmd[16];
 271         char buf[256];
 272         int a;
 273         char *confptr;
 274         char confname[128];
 275
 276         if (CtdlAccessCheck(ac_aide)) return;
 277
 278         extract_token(cmd, argbuf, 0, '|', sizeof cmd);
 279         if (!strcasecmp(cmd, "GET")) {
 280                 cprintf("%d Configuration...\n", LISTING_FOLLOWS);
 281                 cprintf("%s\n", config.c_nodename);
 282                 cprintf("%s\n", config.c_fqdn);
 283                 cprintf("%s\n", config.c_humannode);
 284                 cprintf("%s\n", config.c_phonenum);
 285                 cprintf("%d\n", config.c_creataide);
 286                 cprintf("%d\n", config.c_sleeping);
 287                 cprintf("%d\n", config.c_initax);
 288                 cprintf("%d\n", config.c_regiscall);
 289                 cprintf("%d\n", config.c_twitdetect);
 290                 cprintf("%s\n", config.c_twitroom);
 291                 cprintf("%s\n", config.c_moreprompt);
 292                 cprintf("%d\n", config.c_restrict);
 293                 cprintf("%s\n", config.c_site_location);
 294                 cprintf("%s\n", config.c_sysadm);
 295                 cprintf("%d\n", config.c_maxsessions);
 296                 cprintf("xxx\n"); /* placeholder -- field no longer in use */
 297                 cprintf("%d\n", config.c_userpurge);
 298                 cprintf("%d\n", config.c_roompurge);
 299                 cprintf("%s\n", config.c_logpages);
 300                 cprintf("%d\n", config.c_createax);
 301                 cprintf("%ld\n", config.c_maxmsglen);
 302                 cprintf("%d\n", config.c_min_workers);
 303                 cprintf("%d\n", config.c_max_workers);
 304                 cprintf("%d\n", config.c_pop3_port);
 305                 cprintf("%d\n", config.c_smtp_port);
 306                 cprintf("%d\n", config.c_rfc822_strict_from);
 307                 cprintf("%d\n", config.c_aide_zap);
 308                 cprintf("%d\n", config.c_imap_port);
 309                 cprintf("%ld\n", config.c_net_freq);
 310                 cprintf("%d\n", config.c_disable_newu);
 311                 cprintf("1\n"); /* niu */
 312                 cprintf("%d\n", config.c_purge_hour);
 313 #ifdef HAVE_LDAP
 314                 cprintf("%s\n", config.c_ldap_host);
 315                 cprintf("%d\n", config.c_ldap_port);
 316                 cprintf("%s\n", config.c_ldap_base_dn);
 317                 cprintf("%s\n", config.c_ldap_bind_dn);
 318                 cprintf("%s\n", config.c_ldap_bind_pw);
 319 #else
 320                 cprintf("\n");
 321                 cprintf("0\n");
 322                 cprintf("\n");
 323                 cprintf("\n");
 324                 cprintf("\n");
 325 #endif
 326                 cprintf("%s\n", config.c_ip_addr);
 327                 cprintf("%d\n", config.c_msa_port);
 328                 cprintf("%d\n", config.c_imaps_port);
 329                 cprintf("%d\n", config.c_pop3s_port);
 330                 cprintf("%d\n", config.c_smtps_port);
 331                 cprintf("%d\n", config.c_enable_fulltext);
 332                 cprintf("%d\n", config.c_auto_cull);
 333                 cprintf("%d\n", config.c_instant_expunge);
 334                 cprintf("%d\n", config.c_allow_spoofing);
 335                 cprintf("%d\n", config.c_journal_email);
 336                 cprintf("%d\n", config.c_journal_pubmsgs);
 337                 cprintf("%s\n", config.c_journal_dest);
 338                 cprintf("%s\n", config.c_default_cal_zone);
 339                 cprintf("%d\n", config.c_pftcpdict_port);
 340                 cprintf("%d\n", config.c_managesieve_port);
 341                 cprintf("%d\n", config.c_auth_mode);
 342                 cprintf("%s\n", config.c_funambol_host);
 343                 cprintf("%d\n", config.c_funambol_port);
 344                 cprintf("%s\n", config.c_funambol_source);
 345                 cprintf("%s\n", config.c_funambol_auth);
 346                 cprintf("%d\n", config.c_rbl_at_greeting);
 347                 cprintf("%s\n", config.c_master_user);
 348                 cprintf("%s\n", config.c_master_pass);
 349                 cprintf("%s\n", config.c_pager_program);
 350                 cprintf("%d\n", config.c_imap_keep_from);
 351                 cprintf("%d\n", config.c_xmpp_c2s_port);
 352                 cprintf("%d\n", config.c_xmpp_s2s_port);
 353                 cprintf("%ld\n", config.c_pop3_fetch);
 354                 cprintf("%ld\n", config.c_pop3_fastest);
 355                 cprintf("000\n");
 356         }
 357
 358         else if (!strcasecmp(cmd, "SET")) {
 359                 unbuffer_output();
 360                 cprintf("%d Send configuration...\n", SEND_LISTING);
 361                 a = 0;
 362                 while (client_getln(buf, sizeof buf) >= 0 && strcmp(buf, "000")) {
 363                         switch (a) {
 364                         case 0:
 365                                 safestrncpy(config.c_nodename, buf,
 366                                             sizeof config.c_nodename);
 367                                 break;
 368                         case 1:
 369                                 safestrncpy(config.c_fqdn, buf,
 370                                             sizeof config.c_fqdn);
 371                                 break;
 372                         case 2:
 373                                 safestrncpy(config.c_humannode, buf,
 374                                             sizeof config.c_humannode);
 375                                 break;
 376                         case 3:
 377                                 safestrncpy(config.c_phonenum, buf,
 378                                             sizeof config.c_phonenum);
 379                                 break;
 380                         case 4:
 381                                 config.c_creataide = atoi(buf);
 382                                 break;
 383                         case 5:
 384                                 config.c_sleeping = atoi(buf);
 385                                 break;
 386                         case 6:
 387                                 config.c_initax = atoi(buf);
 388                                 if (config.c_initax < 1)
 389                                         config.c_initax = 1;
 390                                 if (config.c_initax > 6)
 391                                         config.c_initax = 6;
 392                                 break;
 393                         case 7:
 394                                 config.c_regiscall = atoi(buf);
 395                                 if (config.c_regiscall != 0)
 396                                         config.c_regiscall = 1;
 397                                 break;
 398                         case 8:
 399                                 config.c_twitdetect = atoi(buf);
 400                                 if (config.c_twitdetect != 0)
 401                                         config.c_twitdetect = 1;
 402                                 break;
 403                         case 9:
 404                                 safestrncpy(config.c_twitroom, buf,
 405                                             sizeof config.c_twitroom);
 406                                 break;
 407                         case 10:
 408                                 safestrncpy(config.c_moreprompt, buf,
 409                                             sizeof config.c_moreprompt);
 410                                 break;
 411                         case 11:
 412                                 config.c_restrict = atoi(buf);
 413                                 if (config.c_restrict != 0)
 414                                         config.c_restrict = 1;
 415                                 break;
 416                         case 12:
 417                                 safestrncpy(config.c_site_location, buf,
 418                                             sizeof config.c_site_location);
 419                                 break;
 420                         case 13:
 421                                 safestrncpy(config.c_sysadm, buf,
 422                                             sizeof config.c_sysadm);
 423                                 break;
 424                         case 14:
 425                                 config.c_maxsessions = atoi(buf);
 426                                 if (config.c_maxsessions < 0)
 427                                         config.c_maxsessions = 0;
 428                                 break;
 429                         case 15:
 430                                 /* placeholder -- field no longer in use */
 431                                 break;
 432                         case 16:
 433                                 config.c_userpurge = atoi(buf);
 434                                 break;
 435                         case 17:
 436                                 config.c_roompurge = atoi(buf);
 437                                 break;
 438                         case 18:
 439                                 safestrncpy(config.c_logpages, buf,
 440                                             sizeof config.c_logpages);
 441                                 break;
 442                         case 19:
 443                                 config.c_createax = atoi(buf);
 444                                 if (config.c_createax < 1)
 445                                         config.c_createax = 1;
 446                                 if (config.c_createax > 6)
 447                                         config.c_createax = 6;
 448                                 break;
 449                         case 20:
 450                                 if (atoi(buf) >= 8192)
 451                                         config.c_maxmsglen = atoi(buf);
 452                                 break;
 453                         case 21:
 454                                 if (atoi(buf) >= 2)
 455                                         config.c_min_workers = atoi(buf);
 456                         case 22:
 457                                 if (atoi(buf) >= config.c_min_workers)
 458                                         config.c_max_workers = atoi(buf);
 459                         case 23:
 460                                 config.c_pop3_port = atoi(buf);
 461                                 break;
 462                         case 24:
 463                                 config.c_smtp_port = atoi(buf);
 464                                 break;
 465                         case 25:
 466                                 config.c_rfc822_strict_from = atoi(buf);
 467                                 break;
 468                         case 26:
 469                                 config.c_aide_zap = atoi(buf);
 470                                 if (config.c_aide_zap != 0)
 471                                         config.c_aide_zap = 1;
 472                                 break;
 473                         case 27:
 474                                 config.c_imap_port = atoi(buf);
 475                                 break;
 476                         case 28:
 477                                 config.c_net_freq = atol(buf);
 478                                 break;
 479                         case 29:
 480                                 config.c_disable_newu = atoi(buf);
 481                                 if (config.c_disable_newu != 0)
 482                                         config.c_disable_newu = 1;
 483                                 break;
 484                         case 30:
 485                                 /* niu */
 486                                 break;
 487                         case 31:
 488                                 if ((config.c_purge_hour >= 0)
 489                                    && (config.c_purge_hour <= 23)) {
 490                                         config.c_purge_hour = atoi(buf);
 491                                 }
 492                                 break;
 493 #ifdef HAVE_LDAP
 494                         case 32:
 495                                 safestrncpy(config.c_ldap_host, buf,
 496                                             sizeof config.c_ldap_host);
 497                                 break;
 498                         case 33:
 499                                 config.c_ldap_port = atoi(buf);
 500                                 break;
 501                         case 34:
 502                                 safestrncpy(config.c_ldap_base_dn, buf,
 503                                             sizeof config.c_ldap_base_dn);
 504                                 break;
 505                         case 35:
 506                                 safestrncpy(config.c_ldap_bind_dn, buf,
 507                                             sizeof config.c_ldap_bind_dn);
 508                                 break;
 509                         case 36:
 510                                 safestrncpy(config.c_ldap_bind_pw, buf,
 511                                             sizeof config.c_ldap_bind_pw);
 512                                 break;
 513 #endif
 514                         case 37:
 515                                 safestrncpy(config.c_ip_addr, buf,
 516                                                 sizeof config.c_ip_addr);
 517                         case 38:
 518                                 config.c_msa_port = atoi(buf);
 519                                 break;
 520                         case 39:
 521                                 config.c_imaps_port = atoi(buf);
 522                                 break;
 523                         case 40:
 524                                 config.c_pop3s_port = atoi(buf);
 525                                 break;
 526                         case 41:
 527                                 config.c_smtps_port = atoi(buf);
 528                                 break;
 529                         case 42:
 530                                 config.c_enable_fulltext = atoi(buf);
 531                                 break;
 532                         case 43:
 533                                 config.c_auto_cull = atoi(buf);
 534                                 break;
 535                         case 44:
 536                                 config.c_instant_expunge = atoi(buf);
 537                                 break;
 538                         case 45:
 539                                 config.c_allow_spoofing = atoi(buf);
 540                                 break;
 541                         case 46:
 542                                 config.c_journal_email = atoi(buf);
 543                                 break;
 544                         case 47:
 545                                 config.c_journal_pubmsgs = atoi(buf);
 546                                 break;
 547                         case 48:
 548                                 safestrncpy(config.c_journal_dest, buf,
 549                                                 sizeof config.c_journal_dest);
 550                         case 49:
 551                                 safestrncpy(config.c_default_cal_zone, buf,
 552                                                 sizeof config.c_default_cal_zone);
 553                                 break;
 554                         case 50:
 555                                 config.c_pftcpdict_port = atoi(buf);
 556                                 break;
 557                         case 51:
 558                                 config.c_managesieve_port = atoi(buf);
 559                                 break;
 560                         case 52:
 561                                 config.c_auth_mode = atoi(buf);
 562                         case 53:
 563                                 safestrncpy(config.c_funambol_host, buf,
 564                                         sizeof config.c_funambol_host);
 565                                 break;
 566                         case 54:
 567                                 config.c_funambol_port = atoi(buf);
 568                                 break;
 569                         case 55:
 570                                 safestrncpy(config.c_funambol_source,
 571                                         buf,
 572                                         sizeof config.c_funambol_source);
 573                                 break;
 574                         case 56:
 575                                 safestrncpy(config.c_funambol_auth,
 576                                         buf,
 577                                         sizeof config.c_funambol_auth);
 578                                 break;
 579                         case 57:
 580                                 config.c_rbl_at_greeting = atoi(buf);
 581                                 break;
 582                         case 58:
 583                                 safestrncpy(config.c_master_user, buf, sizeof config.c_master_user);
 584                                 break;
 585                         case 59:
 586                                 safestrncpy(config.c_master_pass, buf, sizeof config.c_master_pass);
 587                                 break;
 588                         case 60:
 589                                 safestrncpy(config.c_pager_program,
 590                                         buf,
 591                                         sizeof config.c_pager_program);
 592                                 break;
 593                         case 61:
 594                                 config.c_imap_keep_from = atoi(buf);
 595                                 break;
 596                         case 62:
 597                                 config.c_xmpp_c2s_port = atoi(buf);
 598                                 break;
 599                         case 63:
 600                                 config.c_xmpp_s2s_port = atoi(buf);
 601                                 break;
 602                         case 64:
 603                                 config.c_pop3_fetch = atol(buf);
 604                                 break;
 605                         case 65:
 606                                 config.c_pop3_fastest = atol(buf);
 607                                 break;
 608                         }
 609                         ++a;
 610                 }
 611                 put_config();
 612                 snprintf(buf, sizeof buf,
 613                          "The global system configuration has been edited by %s.\n",
 614                          CC->curr_user);
 615                 aide_message(buf,"Citadel Configuration Manager Message");
 616
 617                 if (!IsEmptyStr(config.c_logpages))
 618                         create_room(config.c_logpages, 3, "", 0, 1, 1, VIEW_BBS);
 619
 620                 /* If full text indexing has been disabled, invalidate the
 621                  * index so it doesn't try to use it later.
 622                  */
 623                 if (config.c_enable_fulltext == 0) {
 624                         CitControl.fulltext_wordbreaker = 0;
 625                         put_control();
 626                 }
 627         }
 628
 629         else if (!strcasecmp(cmd, "GETSYS")) {
 630                 extract_token(confname, argbuf, 1, '|', sizeof confname);
 631                 confptr = CtdlGetSysConfig(confname);
 632                 if (confptr != NULL) {
 633                         cprintf("%d %s\n", LISTING_FOLLOWS, confname);
 634                         client_write(confptr, strlen(confptr));
 635                         if (confptr[strlen(confptr) - 1] != 10)
 636                                 client_write("\n", 1);
 637                         cprintf("000\n");
 638                         free(confptr);
 639                 } else {
 640                         cprintf("%d No such configuration.\n",
 641                                 ERROR + ILLEGAL_VALUE);
 642                 }
 643         }
 644
 645         else if (!strcasecmp(cmd, "PUTSYS")) {
 646                 extract_token(confname, argbuf, 1, '|', sizeof confname);
 647                 unbuffer_output();
 648                 cprintf("%d %s\n", SEND_LISTING, confname);
 649                 confptr = CtdlReadMessageBody("000", config.c_maxmsglen, NULL, 0, 0);
 650                 CtdlPutSysConfig(confname, confptr);
 651                 free(confptr);
 652         }
 653
 654         else {
 655                 cprintf("%d Illegal option(s) specified.\n",
 656                         ERROR + ILLEGAL_VALUE);
 657         }
 658 }