2 * Citadel setup utility
5 #define SHOW_ME_VAPPEND_PRINTF
6 #include "ctdl_module.h"
13 #include <sys/types.h>
15 #include <sys/utsname.h>
23 #include <libcitadel.h>
28 #include "citadel_dirs.h"
39 #define _(string) gettext(string)
41 #define _(string) (string)
45 #define MAXSETUP 11 /* How many setup questions to ask */
47 #define UI_TEXT 0 /* Default setup type -- text only */
48 #define UI_DIALOG 2 /* Use the 'dialog' program */
49 #define UI_SILENT 3 /* Silent running, for use in scripts */
51 #define SERVICE_NAME "citadel"
52 #define PROTO_NAME "tcp"
53 #define NSSCONF "/etc/nsswitch.conf"
56 typedef enum _SetupStep {
72 ///"CREATE_XINETD_ENTRY";
73 /* Environment variables, don't translate! */
74 const char *EnvNames [eMaxQuestions] = {
90 int using_web_installer = 0;
95 const char *setup_titles[eMaxQuestions];
96 const char *setup_text[eMaxQuestions];
98 /* calculate all our path on a central place */
99 /* where to keep our config */
113 locale = setlocale(LC_MESSAGES, getenv("LANG"));
115 bindtextdomain("citadel-setup", LOCALEDIR"/locale");
116 textdomain("citadel-setup");
117 bind_textdomain_codeset("citadel-setup","UTF8");
119 setup_titles[eCitadelHomeDir] = _("Citadel Home Directory");
121 setup_text[eCitadelHomeDir] = _(
122 "Enter the full pathname of the directory in which the Citadel\n"
123 "installation you are creating or updating resides. If you\n"
124 "specify a directory other than the default, you will need to\n"
125 "specify the -h flag to the server when you start it up.\n");
127 setup_text[eCitadelHomeDir] = _(
128 "Enter the subdirectory name for an alternate installation of "
129 "Citadel. To do a default installation just leave it blank."
130 "If you specify a directory other than the default, you will need to\n"
131 "specify the -h flag to the server when you start it up.\n"
132 "note that it may not have a leading /");
135 setup_titles[eSysAdminName] = _("Citadel administrator username:");
136 setup_text[eSysAdminName] = _(
137 "Please enter the name of the Citadel user account that should be granted "
138 "administrative privileges once created. If using internal authentication "
139 "this user account will be created if it does not exist. For external "
140 "authentication this user account has to exist.");
143 setup_titles[eSysAdminPW] = _("Administrator password:");
144 setup_text[eSysAdminPW] = _(
145 "Enter a password for the system administrator. When setup\n"
146 "completes it will attempt to create the administrator user\n"
147 "and set the password specified here.\n");
149 setup_titles[eUID] = _("Citadel User ID:");
150 setup_text[eUID] = _(
151 "Citadel needs to run under its own user ID. This would\n"
152 "typically be called \"citadel\", but if you are running Citadel\n"
153 "as a public BBS, you might also call it \"bbs\" or \"guest\".\n"
154 "The server will run under this user ID. Please specify that\n"
155 "user ID here. You may specify either a user name or a numeric\n"
158 setup_titles[eIP_ADDR] = _("Listening address for the Citadel server:");
159 setup_text[eIP_ADDR] = _(
160 "Please specify the IP address which the server should be listening to. "
161 "You can name a specific IPv4 or IPv6 address, or you can specify\n"
162 "\"*\" for \"any address\", \"::\" for \"any IPv6 address\", or \"0.0.0.0\"\n"
163 "for \"any IPv4 address\". If you leave this blank, Citadel will\n"
164 "listen on all addresses. "
165 "This can usually be left to the default unless multiple instances of Citadel "
166 "are running on the same computer.");
168 setup_titles[eCTDL_Port] = _("Server port number:");
169 setup_text[eCTDL_Port] = _(
170 "Specify the TCP port number on which your server will run.\n"
171 "Normally, this will be port 504, which is the official port\n"
172 "assigned by the IANA for Citadel servers. You will only need\n"
173 "to specify a different port number if you run multiple instances\n"
174 "of Citadel on the same computer and there is something else\n"
175 "already using port 504.\n");
177 setup_titles[eAuthType] = _("Authentication method to use:");
178 setup_text[eAuthType] = _(
179 "Please choose the user authentication mode. By default Citadel will use its "
180 "own internal user accounts database. If you choose Host, Citadel users will "
181 "have accounts on the host system, authenticated via /etc/passwd or a PAM "
182 "source. LDAP chooses an RFC 2307 compliant directory server, the last option "
183 "chooses the nonstandard MS Active Directory LDAP scheme."
185 "Do not change this option unless you are sure it is required, since changing "
186 "back requires a full reinstall of Citadel."
188 " 0. Self contained authentication\n"
189 " 1. Host system integrated authentication\n"
190 " 2. External LDAP - RFC 2307 compliant directory\n"
191 " 3. External LDAP - nonstandard MS Active Directory\n"
193 "For help: http://www.citadel.org/doku.php/faq:installation:authmodes\n"
195 "ANSWER \"0\" UNLESS YOU COMPLETELY UNDERSTAND THIS OPTION.\n");
197 setup_titles[eLDAP_Host] = _("LDAP host:");
198 setup_text[eLDAP_Host] = _(
199 "Please enter the host name or IP address of your LDAP server.\n");
201 setup_titles[eLDAP_Port] = _("LDAP port number:");
202 setup_text[eLDAP_Port] = _(
203 "Please enter the port number of the LDAP service (usually 389).\n");
205 setup_titles[eLDAP_Base_DN] = _("LDAP base DN:");
206 setup_text[eLDAP_Base_DN] = _(
207 "Please enter the Base DN to search for authentication\n"
208 "(for example: dc=example,dc=com)\n");
210 setup_titles[eLDAP_Bind_DN] = _("LDAP bind DN:");
211 setup_text[eLDAP_Bind_DN] = _(
212 "Please enter the DN of an account to use for binding to the LDAP server for "
213 "performing queries. The account does not require any other privileges. If "
214 "your LDAP server allows anonymous queries, you can leave this blank."
215 "Please enter the DN of an account to use for binding to the LDAP server\n"
216 "for performing queries. The account does not require any other\n"
217 "privileges. If your LDAP server allows anonymous queries, you can\n"
218 "leave this blank.\n");
220 setup_titles[eLDAP_Bind_PW] = _("LDAP bind password:");
221 setup_text[eLDAP_Bind_PW] = _(
222 "If you entered a Bind DN in the previous question, you must now enter\n"
223 "the password associated with that account. Otherwise, you can leave this\n"
227 // Debug loading of locales... Strace does a better job though.
228 printf("Message catalog directory: %s\n", bindtextdomain("citadel-setup", LOCALEDIR"/locale"));
229 printf("Text domain: %s\n", textdomain("citadel-setup"));
230 printf("Text domain Charset: %s\n", bind_textdomain_codeset("citadel-setup","UTF8"));
233 for (i = 0; i < eMaxQuestions; i++)
234 printf("%s - %s\n", setup_titles[i], _(setup_titles[i]));
241 * print the actual stack frame.
243 void cit_backtrace(void)
245 #ifdef HAVE_BACKTRACE
246 void *stack_frames[50];
250 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
251 strings = backtrace_symbols(stack_frames, size);
252 for (i = 0; i < size; i++) {
254 fprintf(stderr, "%s\n", strings[i]);
256 fprintf(stderr, "%p\n", stack_frames[i]);
262 struct config config;
267 void cleanup(int exitcode)
269 // printf("Exitcode: %d\n", exitcode);
276 void title(const char *text)
278 if (setup_type == UI_TEXT) {
279 printf("\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<%s>\n", text);
285 int yesno(const char *question, int default_value)
291 switch (setup_type) {
295 printf("%s\n%s [%s] --> ",
298 ( default_value ? _("Yes") : _("No") )
300 if (fgets(buf, sizeof buf, stdin))
302 answer = tolower(buf[0]);
303 if ((buf[0]==0) || (buf[0]==13) || (buf[0]==10))
304 answer = default_value;
305 else if (answer == 'y')
307 else if (answer == 'n')
310 } while ((answer < 0) || (answer > 1));
314 sprintf(buf, "exec %s %s --yesno '%s' 15 75",
315 getenv("CTDL_DIALOG"),
316 ( default_value ? "" : "--defaultno" ),
334 void important_message(const char *title, const char *msgtext)
339 switch (setup_type) {
342 printf("\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n");
343 printf(" %s \n\n%s\n\n", title, msgtext);
344 printf("%s", _("Press return to continue..."));
345 if (fgets(buf, sizeof buf, stdin));
349 sprintf(buf, "exec %s --msgbox '%s' 19 72",
350 getenv("CTDL_DIALOG"),
355 fprintf(stderr, "%s\n", msgtext);
360 void important_msgnum(int msgnum)
362 important_message(_("Important Message"), setup_text[msgnum]);
365 void display_error(char *error_message_format, ...)
371 va_start(arg_ptr, error_message_format);
372 StrBufVAppendPrintf(Msg,
373 error_message_format,
377 important_message(_("Error"), ChrPtr(Msg));
381 void progress(char *text, long int curr, long int cmax)
383 static long dots_printed = 0L;
385 static FILE *fp = NULL;
388 switch (setup_type) {
392 printf("%s\n", text);
393 printf("....................................................");
394 printf("..........................\r");
397 } else if (curr == cmax) {
398 printf("\r%79s\n", "");
400 a = (curr * 100) / cmax;
403 while (dots_printed < a) {
413 sprintf(buf, "exec %s --gauge '%s' 7 72 0",
414 getenv("CTDL_DIALOG"),
416 fp = popen(buf, "w");
422 else if (curr == cmax) {
424 fprintf(fp, "100\n");
430 a = (curr * 100) / cmax;
432 fprintf(fp, "%ld\n", a);
446 * check_services_entry() -- Make sure "citadel" is in /etc/services
449 void check_services_entry(void)
455 if (getservbyname(SERVICE_NAME, PROTO_NAME) == NULL) {
456 for (i=0; i<=2; ++i) {
457 progress(_("Adding service entry..."), i, 2);
459 sfp = fopen("/etc/services", "a");
461 sprintf(errmsg, "%s /etc/services: %s", _("Cannot open"), strerror(errno));
462 display_error(errmsg);
464 fprintf(sfp, "%s 504/tcp\n", SERVICE_NAME);
476 * delete_inittab_entry() -- Remove obsolete /etc/inittab entry for Citadel
478 void delete_inittab_entry(void)
482 char looking_for[256];
484 char outfilename[32];
485 int changes_made = 0;
488 /* Determine the fully qualified path name of citserver */
489 snprintf(looking_for,
495 /* Now tweak /etc/inittab */
496 infp = fopen("/etc/inittab", "r");
499 /* If /etc/inittab does not exist, return quietly.
500 * Not all host platforms have it.
502 if (errno == ENOENT) {
506 /* Other errors might mean something really did go wrong.
508 sprintf(buf, "%s /etc/inittab: %s", _("Cannot open"), strerror(errno));
513 strcpy(outfilename, "/tmp/ctdlsetup.XXXXXX");
514 outfp = fdopen(mkstemp(outfilename), "w+");
516 sprintf(buf, "%s %s: %s", _("Cannot open"), outfilename, strerror(errno));
522 while (fgets(buf, sizeof buf, infp) != NULL) {
523 if (strstr(buf, looking_for) != NULL) {
524 rv = fwrite("#", 1, 1, outfp);
527 rv = fwrite(buf, strlen(buf), 1, outfp);
534 sprintf(buf, "/bin/mv -f %s /etc/inittab 2>/dev/null", outfilename);
536 rv = system("/sbin/init q 2>/dev/null");
545 * install_init_scripts() -- Try to configure to start Citadel at boot
547 void install_init_scripts(void)
549 struct stat etcinitd;
551 char *initfile = "/etc/init.d/citadel";
555 if ((stat("/etc/init.d/", &etcinitd) == -1) &&
558 if ((stat("/etc/rc.d/init.d/", &etcinitd) == -1) &&
560 initfile = CTDLDIR"/citadel.init";
562 initfile = "/etc/rc.d/init.d/citadel";
565 fp = fopen(initfile, "r");
567 if (yesno(_("Citadel already appears to be configured to start at boot.\n"
568 "Would you like to keep your boot configuration as is?\n"), 1) == 1) {
575 if (yesno(_("Would you like to automatically start Citadel at boot?\n"), 1) == 0) {
579 fp = fopen(initfile, "w");
581 display_error("%s /etc/init.d/citadel", _("Cannot create"));
585 fprintf(fp, "#!/bin/sh\n"
587 "# Init file for Citadel\n"
589 "# chkconfig: - 79 30\n"
590 "# description: Citadel service\n"
591 "# processname: citserver\n"
592 "# pidfile: %s/citadel.pid\n\n"
593 "# uncomment this to create coredumps as described in\n"
594 "# http://www.citadel.org/doku.php/faq:mastering_your_os:gdb#how.do.i.make.my.system.produce.core-files\n"
595 "# ulimit -c unlimited\n"
603 "test -d /var/run || exit 0\n"
607 "start) echo -n \"Starting Citadel... \"\n"
608 " if $CITADEL_DIR/citserver -lmail -d\n"
615 "stop) echo -n \"Stopping Citadel... \"\n"
616 " if $CITADEL_DIR/sendcommand DOWN >/dev/null 2>&1 ; then\n"
621 " rm -f %s/citadel.pid 2>/dev/null\n"
626 "restart) if $CITADEL_DIR/sendcommand DOWN 1 >/dev/null 2>&1 ; then\n"
632 "*) echo \"Usage: $0 {start|stop|restart}\"\n"
639 chmod(initfile, 0755);
641 /* Set up the run levels. */
642 rv = system("/bin/rm -f /etc/rc?.d/[SK]??citadel 2>/dev/null");
643 snprintf(command, sizeof(command), "for x in 2 3 4 5 ; do [ -d /etc/rc$x.d ] && ln -s %s /etc/rc$x.d/S79citadel ; done 2>/dev/null", initfile);
644 rv = system(command);
645 snprintf(command, sizeof(command),"for x in 0 6 S; do [ -d /etc/rc$x.d ] && ln -s %s /etc/rc$x.d/K30citadel ; done 2>/dev/null", initfile);
646 rv = system(command);
653 * On systems which use xinetd, see if we can offer to install Citadel as
654 * the default telnet target.
656 void check_xinetd_entry(void) {
657 char *filename = "/etc/xinetd.d/telnet";
660 int already_citadel = 0;
663 fp = fopen(filename, "r+");
664 if (fp == NULL) return; /* Not there. Oh well... */
666 while (fgets(buf, sizeof buf, fp) != NULL) {
667 if (strstr(buf, "/citadel") != NULL) already_citadel = 1;
670 if (already_citadel) return; /* Already set up this way. */
672 /* Otherwise, prompt the user to create an entry. */
673 if (getenv("CREATE_XINETD_ENTRY") != NULL) {
674 if (strcasecmp(getenv("CREATE_XINETD_ENTRY"), "yes")) {
679 snprintf(buf, sizeof buf,
680 _("Setup can configure the \"xinetd\" service to automatically\n"
681 "connect incoming telnet sessions to Citadel, bypassing the\n"
682 "host system login: prompt. Would you like to do this?\n"
684 if (yesno(buf, 1) == 0) {
689 fp = fopen(filename, "w");
691 "# description: telnet service for Citadel users\n"
696 " socket_type = stream\n"
699 " server = /usr/sbin/in.telnetd\n"
700 " server_args = -h -L %s/citadel\n"
701 " log_on_failure += USERID\n"
706 /* Now try to restart the service */
707 rv = system("/etc/init.d/xinetd restart >/dev/null 2>&1");
713 * Offer to disable other MTA's
715 void disable_other_mta(const char *mta) {
721 sprintf(buf, "/bin/ls -l /etc/rc*.d/S*%s 2>/dev/null; "
722 "/bin/ls -l /etc/rc.d/rc*.d/S*%s 2>/dev/null",
724 fp = popen(buf, "r");
725 if (fp == NULL) return;
727 while (fgets(buf, sizeof buf, fp) != NULL) {
731 if (lines == 0) return; /* Nothing to do. */
734 /* Offer to replace other MTA with the vastly superior Citadel :) */
736 snprintf(buf, sizeof buf,
737 "%s \"%s\" %s%s%s%s%s%s%s",
738 _("You appear to have the "),
741 "running on your system. If you want Citadel mail\n"
744 _(" you will have to manually integrate\n"
745 "them. It is preferable to disable "),
747 _(", and use Citadel's\n"
748 "SMTP, POP3, and IMAP services.\n\n"
751 _("so that Citadel has access to ports\n"
752 "25, 110, and 143?\n")
754 if (yesno(buf, 1) == 0) {
759 sprintf(buf, "for x in /etc/rc*.d/S*%s; do mv $x `echo $x |sed s/S/K/g`; done >/dev/null 2>&1", mta);
761 sprintf(buf, "/etc/init.d/%s stop >/dev/null 2>&1", mta);
765 const char *other_mtas[] = {
766 "courier-authdaemon",
789 void disable_other_mtas(void)
792 if ((getenv("ACT_AS_MTA") == NULL) ||
793 (getenv("ACT_AS_MTA") &&
794 strcasecmp(getenv("ACT_AS_MTA"), "yes") == 0)) {
795 /* Offer to disable other MTA's on the system. */
796 while (!IsEmptyStr(other_mtas[i]))
798 disable_other_mta(other_mtas[i]);
805 * Check to see if our server really works. Returns 0 on success.
807 int test_server(char *relhomestr, int relhome) {
814 /* Generate a silly little cookie. We're going to write it out
815 * to the server and try to get it back. The cookie does not
816 * have to be secret ... just unique.
818 sprintf(cookie, "--test--%d--", getpid());
821 sprintf(cmd, "%s/sendcommand -h%s ECHO %s 2>&1",
826 sprintf(cmd, "%s/sendcommand ECHO %s 2>&1",
830 fp = popen(cmd, "r");
831 if (fp == NULL) return(errno);
833 while (fgets(buf, sizeof buf, fp) != NULL) {
835 && (strstr(buf, cookie) != NULL) ) {
847 void strprompt(const char *prompt_title, const char *prompt_text, char *Target, char *DefValue)
851 char dialog_result[PATH_MAX];
855 strcpy(setupmsg, "");
857 switch (setup_type) {
860 printf("\n%s\n", prompt_text);
861 printf("%s\n%s\n", _("This is currently set to:"), Target);
862 printf("%s\n", _("Enter new value or press return to leave unchanged:"));
863 if (fgets(buf, sizeof buf, stdin)){
864 buf[strlen(buf) - 1] = 0;
866 if (!IsEmptyStr(buf))
871 CtdlMakeTempFileName(dialog_result, sizeof dialog_result);
872 sprintf(buf, "exec %s --inputbox '%s' 19 72 '%s' 2>%s",
873 getenv("CTDL_DIALOG"),
878 fp = fopen(dialog_result, "r");
880 if (fgets(Target, sizeof buf, fp)) {
881 if (Target[strlen(Target)-1] == 10) {
882 Target[strlen(Target)-1] = 0;
886 unlink(dialog_result);
890 strcpy(Target, DefValue);
895 void set_bool_val(int msgpos, int *ip, char *DefValue)
897 title(setup_titles[msgpos]);
898 *ip = yesno(setup_text[msgpos], *ip);
901 void set_str_val(int msgpos, char *Target, char *DefValue)
903 strprompt(setup_titles[msgpos],
909 void set_int_val(int msgpos, int *ip, char *DefValue)
912 snprintf(buf, sizeof buf, "%d", (int) *ip);
913 set_str_val(msgpos, buf, DefValue);
918 void set_char_val(int msgpos, char *ip, char *DefValue)
921 snprintf(buf, sizeof buf, "%d", (int) *ip);
922 set_str_val(msgpos, buf, DefValue);
923 *ip = (char) atoi(buf);
927 void set_long_val(int msgpos, long int *ip, char *DefValue)
930 snprintf(buf, sizeof buf, "%ld", *ip);
931 set_str_val(msgpos, buf, DefValue);
936 void edit_value(int curr)
940 char ctdluidname[256];
943 if (setup_type == UI_SILENT)
945 Value = getenv(EnvNames[curr]);
954 set_str_val(curr, config.c_sysadm, Value);
958 set_str_val(curr, admin_pass, Value);
962 if (setup_type == UI_SILENT)
965 config.c_ctdluid = atoi(Value);
971 config.c_ctdluid = 0; /* XXX Windows hack, prob. insecure */
973 i = config.c_ctdluid;
976 set_int_val(curr, &i, Value);
977 config.c_ctdluid = i;
980 strcpy(ctdluidname, pw->pw_name);
981 set_str_val(curr, ctdluidname, Value);
982 pw = getpwnam(ctdluidname);
984 config.c_ctdluid = pw->pw_uid;
986 else if (atoi(ctdluidname) > 0) {
987 config.c_ctdluid = atoi(ctdluidname);
995 set_str_val(curr, config.c_ip_addr, Value);
999 set_int_val(curr, &config.c_port_number, Value);
1003 if (setup_type == UI_SILENT)
1006 config.c_auth_mode = AUTHMODE_NATIVE;
1010 if ((strcasecmp(auth, "yes") == 0) ||
1011 (strcasecmp(auth, "host") == 0))
1013 config.c_auth_mode = AUTHMODE_HOST;
1015 else if (strcasecmp(auth, "ldap") == 0){
1016 config.c_auth_mode = AUTHMODE_LDAP;
1018 else if ((strcasecmp(auth, "ldap_ad") == 0) ||
1019 (strcasecmp(auth, "active directory") == 0)){
1020 config.c_auth_mode = AUTHMODE_LDAP_AD;
1025 set_int_val(curr, &config.c_auth_mode, Value);
1030 set_str_val(curr, config.c_ldap_host, Value);
1034 if (config.c_ldap_port == 0) {
1035 config.c_ldap_port = 389;
1037 set_int_val(curr, &config.c_ldap_port, Value);
1041 set_str_val(curr, config.c_ldap_base_dn, Value);
1045 set_str_val(curr, config.c_ldap_bind_dn, Value);
1049 set_str_val(curr, config.c_ldap_bind_pw, Value);
1056 * (re-)write the config data to disk
1058 void write_config_to_disk(void)
1064 if ((fd = creat(file_citadel_config, S_IRUSR | S_IWUSR)) == -1) {
1065 display_error("%s citadel.config [%s][%s]\n", _("setup: cannot open"), file_citadel_config, strerror(errno));
1068 fp = fdopen(fd, "wb");
1070 display_error("%s citadel.config [%s][%s]\n", _("setup: cannot open"), file_citadel_config, strerror(errno));
1073 rv = fwrite((char *) &config, sizeof(struct config), 1, fp);
1081 * Figure out what type of user interface we're going to use
1083 int discover_ui(void)
1086 /* Use "dialog" if we have it */
1087 if (getenv("CTDL_DIALOG") != NULL) {
1096 void migrate_old_installs(void)
1099 rv = system("exec /bin/rm -fr ./rooms ./chatpipes ./expressmsgs ./sessions 2>/dev/null");
1100 unlink("citadel.log");
1106 * Strip "db" entries out of /etc/nsswitch.conf
1116 int file_changed = 0;
1117 char new_filename[64];
1120 fp_read = fopen(NSSCONF, "r");
1121 if (fp_read == NULL) {
1125 strcpy(new_filename, "/tmp/ctdl_fixnss_XXXXXX");
1126 fd_write = mkstemp(new_filename);
1132 while (fgets(buf, sizeof buf, fp_read) != NULL) {
1134 strcpy(buf_nc, buf);
1135 for (i=0; i<strlen(buf_nc); ++i) {
1136 if (buf_nc[i] == '#') {
1140 for (i=0; i<strlen(buf_nc); ++i) {
1141 if (!strncasecmp(&buf_nc[i], "db", 2)) {
1143 if ((isspace(buf_nc[i+2])) || (buf_nc[i+2]==0)) {
1146 strcpy(&buf_nc[i], &buf_nc[i+2]);
1147 strcpy(&buf[i], &buf[i+2]);
1149 strcpy(&buf_nc[i], &buf_nc[i+1]);
1150 strcpy(&buf[i], &buf[i+1]);
1156 if (write(fd_write, buf, strlen(buf)) != strlen(buf)) {
1159 unlink(new_filename);
1166 if (!file_changed) {
1167 unlink(new_filename);
1171 snprintf(question, sizeof question,
1174 "/etc/nsswitch.conf is configured to use the 'db' module for\n"
1175 "one or more services. This is not necessary on most systems,\n"
1176 "and it is known to crash the Citadel server when delivering\n"
1177 "mail to the Internet.\n"
1179 "Do you want this module to be automatically disabled?\n"
1184 if (yesno(question, 1)) {
1185 sprintf(buf, "/bin/mv -f %s %s", new_filename, NSSCONF);
1187 chmod(NSSCONF, 0644);
1189 unlink(new_filename);
1192 void check_init_script (char *relhome)
1198 * If we're running on SysV, install init scripts.
1200 if (!access("/var/run", W_OK)) {
1202 if (getenv("NO_INIT_SCRIPTS") == NULL) {
1203 install_init_scripts();
1206 if (!access("/etc/init.d/citadel", X_OK)) {
1207 rv = system("/etc/init.d/citadel start");
1211 if (test_server(relhome, enable_home) == 0) {
1215 if (config.c_auth_mode == AUTHMODE_NATIVE) {
1216 snprintf (admin_cmd, sizeof(admin_cmd), "%s/sendcommand \"CREU %s|%s\" 2>&1",
1217 ctdl_sbin_dir, config.c_sysadm, admin_pass);
1218 fp = popen(admin_cmd, "r");
1220 while (fgets(buf, sizeof buf, fp) != NULL)
1222 if ((atol(buf) == 574) || (atol(buf) == 200))
1228 if (found_it == 0) {
1229 important_message("Error","Setup failed to create your admin user");
1233 if (setup_type != UI_SILENT)
1234 important_message(_("Setup finished"),
1235 _("Setup of the Citadel server is complete.\n"
1236 "If you will be using WebCit, please run its\n"
1237 "setup program now; otherwise, run './citadel'\n"
1241 important_message(_("Setup failed"),
1242 _("Setup is finished, but the Citadel server failed to start.\n"
1243 "Go back and check your configuration.\n")
1250 important_message(_("Setup finished"),
1251 _("Setup is finished. You may now start the server."));
1257 #define GetDefaultVALINT(CFGNAME, DEFL) GetDefaultValInt(&config.CFGNAME, "CITADEL_"#CFGNAME, DEFL)
1258 void GetDefaultValInt(int *WhereTo, const char *VarName, int DefVal)
1261 if (*WhereTo == 0) *WhereTo = DefVal;
1263 if ((setup_type == UI_SILENT) &&
1264 (ch = getenv(VarName), ch != NULL))
1266 *WhereTo = atoi(ch);
1269 #define GetDefaultVALCHAR(CFGNAME, DEFL) GetDefaultValChar(&config.CFGNAME, "CITADEL_"#CFGNAME, DEFL)
1270 void GetDefaultValChar(char *WhereTo, const char *VarName, char DefVal)
1273 if (*WhereTo == 0) *WhereTo = DefVal;
1275 if ((setup_type == UI_SILENT) &&
1276 (ch = getenv(VarName), ch != NULL))
1278 *WhereTo = atoi(ch);
1281 #define GetDefaultVALSTR(CFGNAME, DEFL) GetDefaultValStr(&config.CFGNAME[0], sizeof(config.CFGNAME), "CITADEL_"#CFGNAME, DEFL)
1282 void GetDefaultValStr(char *WhereTo, size_t nMax, const char *VarName, const char *DefVal)
1285 if (*WhereTo == '\0')
1286 safestrncpy(WhereTo, DefVal, nMax);
1288 if ((setup_type == UI_SILENT) &&
1289 (ch = getenv(VarName), ch != NULL))
1291 safestrncpy(WhereTo, ch, nMax);
1296 void set_default_values(void)
1299 struct utsname my_utsname;
1302 /* Determine our host name, in case we need to use it as a default */
1305 /* set some sample/default values in place of blanks... */
1306 GetDefaultVALSTR(c_nodename, my_utsname.nodename);
1307 strtok(config.c_nodename, ".");
1308 if (IsEmptyStr(config.c_fqdn) ) {
1309 if ((he = gethostbyname(my_utsname.nodename)) != NULL) {
1310 safestrncpy(config.c_fqdn, he->h_name, sizeof config.c_fqdn);
1312 safestrncpy(config.c_fqdn, my_utsname.nodename, sizeof config.c_fqdn);
1315 GetDefaultVALSTR(c_humannode, _("My System"));
1316 GetDefaultVALSTR(c_phonenum, _("US 800 555 1212"));
1318 GetDefaultVALCHAR(c_initax, 4);
1320 GetDefaultVALSTR(c_moreprompt, "<more>");
1321 GetDefaultVALSTR(c_twitroom, "Trashcan");
1322 GetDefaultVALSTR(c_baseroom, BASEROOM);
1323 GetDefaultVALSTR(c_aideroom, "Aide");
1324 GetDefaultVALINT(c_port_number, 504);
1326 GetDefaultVALINT(c_sleeping, 900);
1328 if (config.c_ctdluid == 0) {
1329 pw = getpwnam("citadel");
1331 config.c_ctdluid = pw->pw_uid;
1334 if (config.c_ctdluid == 0) {
1335 pw = getpwnam("bbs");
1337 config.c_ctdluid = pw->pw_uid;
1340 if (config.c_ctdluid == 0) {
1341 pw = getpwnam("guest");
1343 config.c_ctdluid = pw->pw_uid;
1346 if (config.c_createax == 0) {
1347 config.c_createax = 3;
1350 * Negative values for maxsessions are not allowed.
1352 if (config.c_maxsessions < 0) {
1353 config.c_maxsessions = 0;
1355 /* We need a system default message expiry policy, because this is
1356 * the top level and there's no 'higher' policy to fall back on.
1357 * By default, do not expire messages at all.
1359 if (config.c_ep.expire_mode == 0) {
1360 config.c_ep.expire_mode = EXPIRE_MANUAL;
1361 config.c_ep.expire_value = 0;
1365 * Default port numbers for various services
1367 GetDefaultVALINT(c_smtp_port, 25);
1368 GetDefaultVALINT(c_pop3_port, 110);
1369 GetDefaultVALINT(c_imap_port, 143);
1370 GetDefaultVALINT(c_msa_port, 587);
1371 GetDefaultVALINT(c_smtps_port, 465);
1372 GetDefaultVALINT(c_pop3s_port, 995);
1373 GetDefaultVALINT(c_imaps_port, 993);
1374 GetDefaultVALINT(c_pftcpdict_port, -1);
1375 GetDefaultVALINT(c_managesieve_port, 2020);
1376 GetDefaultVALINT(c_xmpp_c2s_port, 5222);
1377 GetDefaultVALINT(c_xmpp_s2s_port, 5269);
1381 void get_config (void)
1388 * What we're going to try to do here is append a whole bunch of
1389 * nulls to the citadel.config file, so we can keep the old config
1390 * values if they exist, but if the file is missing or from an
1391 * earlier version with a shorter config structure, when setup tries
1392 * to read the old config parameters, they'll all come up zero.
1393 * The length of the config file will be set to what it's supposed
1394 * to be when we rewrite it, because we replace the old file with a
1395 * completely new copy.
1397 if ((a = open(file_citadel_config, O_WRONLY | O_CREAT | O_APPEND,
1398 S_IRUSR | S_IWUSR)) == -1) {
1399 display_error("%s citadel.config [%s][%s]\n", _("setup: cannot append"), file_citadel_config, strerror(errno));
1402 fp = fdopen(a, "ab");
1404 display_error("%s citadel.config [%s][%s]\n", _("setup: cannot append"), file_citadel_config, strerror(errno));
1407 for (a = 0; a < sizeof(struct config); ++a) {
1412 /* now we re-open it, and read the old or blank configuration */
1413 fp = fopen(file_citadel_config, "rb");
1415 display_error("%s citadel.config [%s][%s]\n", _("setup: cannot open"), file_citadel_config, strerror(errno));
1418 rv = fread((char *) &config, sizeof(struct config), 1, fp);
1423 int main(int argc, char *argv[])
1428 int old_setup_level = 0;
1432 char relhome[PATH_MAX]="";
1433 char ctdldir[PATH_MAX]=CTDLDIR;
1438 /* set an invalid setup type */
1441 /* Check to see if we're running the web installer */
1442 if (getenv("CITADEL_INSTALLER") != NULL) {
1443 using_web_installer = 1;
1446 /* parse command line args */
1447 for (a = 0; a < argc; ++a) {
1448 if (!strncmp(argv[a], "-u", 2)) {
1449 strcpy(aaa, argv[a]);
1450 strcpy(aaa, &aaa[2]);
1451 setup_type = atoi(aaa);
1453 else if (!strcmp(argv[a], "-i")) {
1456 else if (!strcmp(argv[a], "-q")) {
1457 setup_type = UI_SILENT;
1459 else if (!strncmp(argv[a], "-h", 2)) {
1460 relh=argv[a][2]!='/';
1462 safestrncpy(ctdl_home_directory, &argv[a][2], sizeof ctdl_home_directory);
1464 safestrncpy(relhome, &argv[a][2], sizeof relhome);
1471 calc_dirs_n_files(relh, home, relhome, ctdldir, 0);
1474 /* If a setup type was not specified, try to determine automatically
1475 * the best one to use out of all available types.
1477 if (setup_type < 0) {
1478 setup_type = discover_ui();
1480 if (info_only == 1) {
1481 important_message(_("Citadel Setup"), CITADEL);
1485 enable_home = ( relh | home );
1487 if (chdir(ctdl_run_dir) != 0) {
1488 display_error(_("Citadel Setup"),
1490 _("The directory you specified does not exist"),
1496 /* Try to stop Citadel if we can */
1497 if (!access("/etc/init.d/citadel", X_OK)) {
1498 rv = system("/etc/init.d/citadel stop");
1501 /* Make sure Citadel is not running. */
1502 if (test_server(relhome, enable_home) == 0) {
1503 important_message(_("Citadel Setup"),
1504 _("The Citadel service is still running.\n"
1505 "Please stop the service manually and run "
1511 switch (setup_type) {
1516 _("Citadel setup program"));
1523 set_default_values();
1525 /* Go through a series of dialogs prompting for config info */
1526 for (curr = 1; curr <= MAXSETUP; ++curr) {
1528 if ((curr == 6) && (config.c_auth_mode != AUTHMODE_LDAP) && (config.c_auth_mode != AUTHMODE_LDAP_AD)) {
1529 curr += 5; /* skip LDAP questions if we're not authenticating against LDAP */
1533 /***** begin version update section *****/
1535 old_setup_level = config.c_setup_level;
1537 if (old_setup_level == 0) {
1541 if (old_setup_level < 555) {
1544 _("This Citadel installation is too old to be upgraded.")
1548 write_config_to_disk();
1550 old_setup_level = config.c_setup_level;
1552 /***** end of version update section *****/
1555 config.c_setup_level = REV_LEVEL;
1557 if ((pw = getpwuid(config.c_ctdluid)) == NULL) {
1563 create_run_directories(config.c_ctdluid, gid);
1565 write_config_to_disk();
1567 migrate_old_installs(); /* Delete files and directories used by older Citadel versions */
1569 if ( ((setup_type == UI_SILENT)
1570 && (getenv("ALTER_ETC_SERVICES")!=NULL))
1571 || (setup_type != UI_SILENT)
1573 check_services_entry(); /* Check /etc/services */
1577 delete_inittab_entry(); /* Remove obsolete /etc/inittab entry */
1578 check_xinetd_entry(); /* Check /etc/xinetd.d/telnet */
1579 disable_other_mtas(); /* Offer to disable other MTAs */
1580 fixnss(); /* Check for the 'db' nss and offer to disable it */
1583 progress(_("Setting file permissions"), 1, 3);
1584 rv = chown(file_citadel_config, config.c_ctdluid, gid);
1585 progress(_("Setting file permissions"), 2, 3);
1586 rv = chmod(file_citadel_config, S_IRUSR | S_IWUSR);
1587 progress(_("Setting file permissions"), 3, 3);
1589 check_init_script(relhome);