4 * Citadel/UX setup utility
14 #include <sys/types.h>
16 #include <sys/utsname.h>
35 #define MAXSETUP 3 /* How many setup questions to ask */
37 #define UI_TEXT 0 /* Default setup type -- text only */
38 #define UI_SILENT 3 /* Silent running, for use in scripts */
39 #define UI_NEWT 4 /* Use the "newt" window library */
41 #define SERVICE_NAME "citadel"
42 #define PROTO_NAME "tcp"
45 char setup_directory[SIZ];
48 char *setup_titles[] =
50 "Citadel Home Directory",
51 "System Administrator",
59 "Enter the full pathname of the directory in which the Citadel installation\n"
60 "you are creating or updating resides. If you specify a directory other\n"
61 "than the default, you will need to specify the -h flag to the server when\n"
64 "Enter the name of the system administrator (which is probably you).\n"
65 "When an account is created with this name, it will automatically be\n"
66 "assigned the highest access level.\n",
68 "Citadel needs to run under its own user ID. This would typically be\n"
69 "called \"citadel\", but if you are running Citadel as a public BBS, you\n"
70 "might also call it \"bbs\" or \"guest\". The server will run under this\n"
71 "user ID. Please specify that user ID here. You may specify either a\n"
72 "user name or a numeric UID.\n",
74 "Specify the TCP port number on which your server will run. Normally, this\n"
75 "will be port 504, which is the official port assigned by the IANA for\n"
76 "Citadel servers. You'll only need to specify a different port number if\n"
77 "you run multiple instances of Citadel on the same computer and there's\n"
78 "something else already using port 504.\n",
80 "Setup has detected that you currently have data files from a Citadel/UX\n"
81 "version 3.2x installation. The program 'conv_32_40' can upgrade your\n"
82 "files to version 4.0x format.\n"
83 " Setup will now exit. Please either run 'conv_32_40' or delete your data\n"
84 "files, and run setup again.\n"
92 * Set an entry in inittab to the desired state
94 void set_init_entry(char *which_entry, char *new_state) {
103 inittab = strdup("");
104 if (inittab == NULL) return;
106 fp = fopen("/etc/inittab", "r");
107 if (fp == NULL) return;
109 while(fgets(buf, sizeof buf, fp) != NULL) {
111 if (num_tokens(buf, ':') == 4) {
112 extract_token(entry, buf, 0, ':');
113 extract_token(levels, buf, 1, ':');
114 extract_token(state, buf, 2, ':');
115 extract_token(prog, buf, 3, ':'); /* includes 0x0a LF */
117 if (!strcmp(entry, which_entry)) {
118 strcpy(state, new_state);
119 sprintf(buf, "%s:%s:%s:%s",
120 entry, levels, state, prog);
124 inittab = realloc(inittab, strlen(inittab) + strlen(buf) + 2);
125 if (inittab == NULL) {
130 strcat(inittab, buf);
133 fp = fopen("/etc/inittab", "w");
135 fwrite(inittab, strlen(inittab), 1, fp);
137 kill(1, SIGHUP); /* Tell init to re-read /etc/inittab */
146 * Shut down the Citadel service if necessary, during setup.
148 void shutdown_service(void) {
151 char looking_for[SIZ];
156 strcpy(init_entry, "");
158 /* Determine the fully qualified path name of citserver */
159 snprintf(looking_for, sizeof looking_for, "%s/citserver ", BBSDIR);
161 /* Pound through /etc/inittab line by line. Set have_entry to 1 if
162 * an entry is found which we believe starts citserver.
164 infp = fopen("/etc/inittab", "r");
168 while (fgets(buf, sizeof buf, infp) != NULL) {
169 buf[strlen(buf) - 1] = 0;
170 extract_token(entry, buf, 0, ':');
171 extract_token(prog, buf, 3, ':');
172 if (!strncasecmp(prog, looking_for,
173 strlen(looking_for))) {
175 strcpy(init_entry, entry);
181 /* Bail out if there's nothing to do. */
182 if (!have_entry) return;
184 set_init_entry(init_entry, "off");
189 * Start the Citadel service.
191 void start_the_service(void) {
192 if (strlen(init_entry) > 0) {
193 set_init_entry(init_entry, "respawn");
199 void cleanup(int exitcode)
211 void title(char *text)
213 if (setup_type == UI_TEXT) {
214 printf("\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<%s>\n", text);
220 int yesno(char *question)
223 newtComponent form = NULL;
224 newtComponent yesbutton = NULL;
225 newtComponent nobutton = NULL;
231 switch (setup_type) {
235 printf("%s\nYes/No --> ", question);
236 fgets(buf, sizeof buf, stdin);
237 answer = tolower(buf[0]);
240 else if (answer == 'n')
242 } while ((answer < 0) || (answer > 1));
247 newtCenteredWindow(76, 10, "Question");
248 form = newtForm(NULL, NULL, 0);
249 for (i=0; i<num_tokens(question, '\n'); ++i) {
250 extract_token(buf, question, i, '\n');
251 newtFormAddComponent(form, newtLabel(1, 1+i, buf));
253 yesbutton = newtButton(10, 5, "Yes");
254 nobutton = newtButton(60, 5, "No");
255 newtFormAddComponent(form, yesbutton);
256 newtFormAddComponent(form, nobutton);
257 if (newtRunForm(form) == yesbutton) {
264 newtFormDestroy(form);
274 void important_message(char *title, char *msgtext)
277 newtComponent form = NULL;
282 switch (setup_type) {
285 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");
286 printf(" %s \n\n%s\n\n", title, msgtext);
287 printf("Press return to continue...");
288 fgets(buf, sizeof buf, stdin);
293 newtCenteredWindow(76, 10, title);
294 form = newtForm(NULL, NULL, 0);
295 for (i=0; i<num_tokens(msgtext, '\n'); ++i) {
296 extract_token(buf, msgtext, i, '\n');
297 newtFormAddComponent(form, newtLabel(1, 1+i, buf));
299 newtFormAddComponent(form, newtButton(35, 5, "OK"));
302 newtFormDestroy(form);
309 void important_msgnum(int msgnum)
311 important_message("Important Message", setup_text[msgnum]);
314 void display_error(char *error_message)
316 important_message("Error", error_message);
319 void progress(char *text, long int curr, long int cmax)
323 /* These variables are static because progress() gets called
324 * multiple times during the course of whatever operation is
325 * being performed. This makes setup non-threadsafe, but who
328 static newtComponent form = NULL;
329 static newtComponent scale = NULL;
331 static long dots_printed = 0L;
334 switch (setup_type) {
338 printf("%s\n", text);
339 printf("..........................");
340 printf("..........................");
341 printf("..........................\r");
344 } else if (curr == cmax) {
345 printf("\r%79s\n", "");
347 a = (curr * 100) / cmax;
350 while (dots_printed < a) {
361 newtCenteredWindow(76, 8, text);
362 form = newtForm(NULL, NULL, 0);
363 scale = newtScale(1, 3, 74, cmax);
364 newtFormAddComponent(form, scale);
368 if ((curr > 0) && (curr <= cmax)) {
369 newtScaleSet(scale, curr);
373 newtFormDestroy(form);
386 * check_services_entry() -- Make sure "citadel" is in /etc/services
389 void check_services_entry(void)
394 if (getservbyname(SERVICE_NAME, PROTO_NAME) == NULL) {
395 for (i=0; i<3; ++i) {
396 progress("Adding service entry...", i, 3);
398 sfp = fopen("/etc/services", "a");
400 display_error(strerror(errno));
402 fprintf(sfp, "%s 504/tcp\n",
414 * check_inittab_entry() -- Make sure "citadel" is in /etc/inittab
417 void check_inittab_entry(void)
421 char looking_for[SIZ];
425 /* Determine the fully qualified path name of citserver */
426 snprintf(looking_for, sizeof looking_for, "%s/citserver ", BBSDIR);
428 /* If there's already an entry, then we have nothing left to do. */
429 if (strlen(init_entry) > 0) {
433 /* Otherwise, prompt the user to create an entry. */
434 snprintf(question, sizeof question,
435 "There is no '%s' entry in /etc/inittab.\n"
436 "Would you like to add one?",
438 if (yesno(question) == 0)
441 /* Generate a unique entry name for /etc/inittab */
442 snprintf(entryname, sizeof entryname, "c0");
445 if (entryname[1] > '9') {
448 if (entryname[0] > 'z') {
450 "Can't generate a unique entry name");
454 snprintf(buf, sizeof buf,
455 "grep %s: /etc/inittab >/dev/null 2>&1", entryname);
456 } while (system(buf) == 0);
458 /* Now write it out to /etc/inittab */
459 infp = fopen("/etc/inittab", "a");
461 display_error(strerror(errno));
463 fprintf(infp, "# Start the Citadel/UX server...\n");
464 fprintf(infp, "%s:2345:respawn:%s -h%s\n",
465 entryname, looking_for, setup_directory);
467 strcpy(init_entry, entryname);
473 * On systems which use xinetd, see if we can offer to install Citadel as
474 * the default telnet target.
476 void check_xinetd_entry(void) {
477 char *filename = "/etc/xinetd.d/telnet";
480 int already_citadel = 0;
482 fp = fopen(filename, "r+");
483 if (fp == NULL) return; /* Not there. Oh well... */
485 while (fgets(buf, sizeof buf, fp) != NULL) {
486 if (strstr(buf, setup_directory) != NULL) already_citadel = 1;
489 if (already_citadel) return; /* Already set up this way. */
491 /* Otherwise, prompt the user to create an entry. */
492 snprintf(buf, sizeof buf,
493 "Setup can configure the 'xinetd' service to automatically\n"
494 "connect incoming telnet sessions to Citadel, bypassing the\n"
495 "host system's login prompt. Would you like to do this?"
500 fp = fopen(filename, "w");
502 "# description: telnet service for Citadel users\n"
507 " socket_type = stream\n"
510 " server = /usr/sbin/in.telnetd\n"
511 " server_args = -h -L %s/citadel\n"
512 " log_on_failure += USERID\n"
518 /* Now try to restart the service */
519 system("/etc/init.d/xinetd restart >/dev/null 2>&1");
527 void set_str_val(int msgpos, char str[])
535 char tempfile[PATH_MAX];
538 strcpy(tempfile, tmpnam(NULL));
539 strcpy(setupmsg, "");
541 switch (setup_type) {
543 title(setup_titles[msgpos]);
544 printf("\n%s\n", setup_text[msgpos]);
545 printf("This is currently set to:\n%s\n", str);
546 printf("Enter new value or press return to leave unchanged:\n");
547 fgets(buf, sizeof buf, stdin);
548 buf[strlen(buf) - 1] = 0;
549 if (strlen(buf) != 0)
555 newtCenteredWindow(76, 10, setup_titles[msgpos]);
556 form = newtForm(NULL, NULL, 0);
557 for (i=0; i<num_tokens(setup_text[msgpos], '\n'); ++i) {
558 extract_token(buf, setup_text[msgpos], i, '\n');
559 newtFormAddComponent(form, newtLabel(1, 1+i, buf));
561 newtFormAddComponent(form, newtEntry(1, 8, str, 74, &result,
562 NEWT_FLAG_RETURNEXIT));
567 newtFormDestroy(form);
573 void set_int_val(int msgpos, int *ip)
576 snprintf(buf, sizeof buf, "%d", (int) *ip);
577 set_str_val(msgpos, buf);
582 void set_char_val(int msgpos, char *ip)
585 snprintf(buf, sizeof buf, "%d", (int) *ip);
586 set_str_val(msgpos, buf);
587 *ip = (char) atoi(buf);
591 void set_long_val(int msgpos, long int *ip)
594 snprintf(buf, sizeof buf, "%ld", *ip);
595 set_str_val(msgpos, buf);
600 void edit_value(int curr)
604 char bbsuidname[SIZ];
609 set_str_val(curr, config.c_sysadm);
614 config.c_bbsuid = 0; /* XXX Windows hack, prob. insecure */
619 set_int_val(curr, &i);
623 strcpy(bbsuidname, pw->pw_name);
624 set_str_val(curr, bbsuidname);
625 pw = getpwnam(bbsuidname);
627 config.c_bbsuid = pw->pw_uid;
629 else if (atoi(bbsuidname) > 0) {
630 config.c_bbsuid = atoi(bbsuidname);
637 set_int_val(curr, &config.c_port_number);
645 * (re-)write the config data to disk
647 void write_config_to_disk(void)
652 if ((fd = creat("citadel.config", S_IRUSR | S_IWUSR)) == -1) {
653 display_error("setup: cannot open citadel.config");
656 fp = fdopen(fd, "wb");
658 display_error("setup: cannot open citadel.config");
661 fwrite((char *) &config, sizeof(struct config), 1, fp);
669 * Figure out what type of user interface we're going to use
671 int discover_ui(void)
677 newtDrawRootText(0, 0, "Citadel/UX Setup");
687 int main(int argc, char *argv[])
693 int old_setup_level = 0;
695 struct utsname my_utsname;
700 /* set an invalid setup type */
703 /* parse command line args */
704 for (a = 0; a < argc; ++a) {
705 if (!strncmp(argv[a], "-u", 2)) {
706 strcpy(aaa, argv[a]);
707 strcpy(aaa, &aaa[2]);
708 setup_type = atoi(aaa);
710 if (!strcmp(argv[a], "-i")) {
713 if (!strcmp(argv[a], "-q")) {
714 setup_type = UI_SILENT;
719 /* If a setup type was not specified, try to determine automatically
720 * the best one to use out of all available types.
722 if (setup_type < 0) {
723 setup_type = discover_ui();
725 if (info_only == 1) {
726 important_message("Citadel/UX Setup", CITADEL);
730 /* Get started in a valid setup directory. */
731 strcpy(setup_directory, BBSDIR);
732 set_str_val(0, setup_directory);
733 if (chdir(setup_directory) != 0) {
734 important_message("Citadel/UX Setup",
735 "The directory you specified does not exist.");
739 /* Determine our host name, in case we need to use it as a default */
742 /* See if we need to shut down the Citadel service. */
743 for (a=0; a<=3; ++a) {
744 progress("Shutting down the Citadel service...", a, 3);
745 if (a == 0) shutdown_service();
750 switch (setup_type) {
754 " *** Citadel/UX setup program ***\n\n");
760 * What we're going to try to do here is append a whole bunch of
761 * nulls to the citadel.config file, so we can keep the old config
762 * values if they exist, but if the file is missing or from an
763 * earlier version with a shorter config structure, when setup tries
764 * to read the old config parameters, they'll all come up zero.
765 * The length of the config file will be set to what it's supposed
766 * to be when we rewrite it, because we replace the old file with a
767 * completely new copy.
770 if ((a = open("citadel.config", O_WRONLY | O_CREAT | O_APPEND,
771 S_IRUSR | S_IWUSR)) == -1) {
772 display_error("setup: cannot append citadel.config");
775 fp = fdopen(a, "ab");
777 display_error("setup: cannot append citadel.config");
780 for (a = 0; a < sizeof(struct config); ++a)
784 /* now we re-open it, and read the old or blank configuration */
785 fp = fopen("citadel.config", "rb");
787 display_error("setup: cannot open citadel.config");
790 fread((char *) &config, sizeof(struct config), 1, fp);
793 /* set some sample/default values in place of blanks... */
794 if (strlen(config.c_nodename) == 0)
795 safestrncpy(config.c_nodename, my_utsname.nodename,
796 sizeof config.c_nodename);
797 strtok(config.c_nodename, ".");
798 if (strlen(config.c_fqdn) == 0) {
799 if ((he = gethostbyname(my_utsname.nodename)) != NULL)
800 safestrncpy(config.c_fqdn, he->h_name,
801 sizeof config.c_fqdn);
803 safestrncpy(config.c_fqdn, my_utsname.nodename,
804 sizeof config.c_fqdn);
806 if (strlen(config.c_humannode) == 0)
807 strcpy(config.c_humannode, "My System");
808 if (strlen(config.c_phonenum) == 0)
809 strcpy(config.c_phonenum, "US 800 555 1212");
810 if (config.c_initax == 0) {
813 if (strlen(config.c_moreprompt) == 0)
814 strcpy(config.c_moreprompt, "<more>");
815 if (strlen(config.c_twitroom) == 0)
816 strcpy(config.c_twitroom, "Trashcan");
817 if (strlen(config.c_net_password) == 0)
818 strcpy(config.c_net_password, "netpassword");
819 if (strlen(config.c_baseroom) == 0)
820 strcpy(config.c_baseroom, "Lobby");
821 if (strlen(config.c_aideroom) == 0)
822 strcpy(config.c_aideroom, "Aide");
823 if (config.c_port_number == 0) {
824 config.c_port_number = 504;
826 if (config.c_sleeping == 0) {
827 config.c_sleeping = 900;
829 if (config.c_bbsuid == 0) {
830 pw = getpwnam("citadel");
832 config.c_bbsuid = pw->pw_uid;
834 if (config.c_bbsuid == 0) {
835 pw = getpwnam("bbs");
837 config.c_bbsuid = pw->pw_uid;
839 if (config.c_bbsuid == 0) {
840 pw = getpwnam("guest");
842 config.c_bbsuid = pw->pw_uid;
844 if (config.c_createax == 0) {
845 config.c_createax = 3;
848 * Negative values for maxsessions are not allowed.
850 if (config.c_maxsessions < 0) {
851 config.c_maxsessions = 0;
853 /* We need a system default message expiry policy, because this is
854 * the top level and there's no 'higher' policy to fall back on.
856 if (config.c_ep.expire_mode == 0) {
857 config.c_ep.expire_mode = EXPIRE_NUMMSGS;
858 config.c_ep.expire_value = 150;
862 * Default port numbers for various services
864 if (config.c_smtp_port == 0) config.c_smtp_port = 25;
865 if (config.c_pop3_port == 0) config.c_pop3_port = 110;
866 if (config.c_imap_port == 0) config.c_imap_port = 143;
868 /* Go through a series of dialogs prompting for config info */
869 if (setup_type != UI_SILENT) {
870 for (curr = 1; curr <= MAXSETUP; ++curr) {
876 if (setuid(config.c_bbsuid) != 0) {
877 important_message("Citadel/UX Setup",
878 "Failed to change the user ID to your Citadel user.");
883 /***** begin version update section ***** */
884 /* take care of any updating that is necessary */
886 old_setup_level = config.c_setup_level;
888 if (old_setup_level == 0)
891 if (old_setup_level < 323) {
892 important_message("Citadel/UX Setup",
893 "This Citadel/UX installation is too old "
897 write_config_to_disk();
899 if ((config.c_setup_level / 10) == 32) {
900 important_msgnum(31);
903 if (config.c_setup_level < 400) {
904 config.c_setup_level = 400;
906 /* end of 3.23 -> 4.00 update section */
908 /* end of 4.00 -> 4.02 update section */
910 old_setup_level = config.c_setup_level;
912 /* end of version update section */
915 config.c_setup_level = REV_LEVEL;
917 /******************************************/
919 write_config_to_disk();
923 mkdir("userpics", 0700);
924 mkdir("messages", 0700);
926 mkdir("images", 0700);
927 mkdir("netconfigs", 0700);
929 /* Delete a bunch of old files from Citadel v4; don't need anymore */
930 system("rm -fr ./chatpipes ./expressmsgs ./sessions 2>/dev/null");
932 /* Delete the old citadel.log file; this facility has been removed */
933 unlink("citadel.log");
935 check_services_entry(); /* Check /etc/services */
937 check_inittab_entry(); /* Check /etc/inittab */
938 check_xinetd_entry(); /* Check /etc/xinetd.d/telnet */
941 if ((pw = getpwuid(config.c_bbsuid)) == NULL)
946 progress("Setting file permissions", 0, 4);
947 chown(".", config.c_bbsuid, gid);
948 progress("Setting file permissions", 1, 4);
949 chown("citadel.config", config.c_bbsuid, gid);
950 progress("Setting file permissions", 2, 4);
951 snprintf(aaa, sizeof aaa,
952 "find . | grep -v chkpwd | xargs chown %ld:%ld 2>/dev/null",
953 (long)config.c_bbsuid, (long)gid);
955 progress("Setting file permissions", 3, 4);
956 chmod("citadel.config", S_IRUSR | S_IWUSR);
957 progress("Setting file permissions", 4, 4);
959 /* See if we can start the Citadel service. */
960 if (strlen(init_entry) > 0) {
961 for (a=0; a<=3; ++a) {
962 progress("Starting the Citadel service...", a, 3);
963 if (a == 0) start_the_service();
966 important_message("Setup finished",
967 "Setup is finished. You may now log in.");
970 important_message("Setup finished",
971 "Setup is finished. You may now start the server.");