src/ui.c

   1 /*
   2     Copyright (C) 2001-2011 Ben Kibbey <bjk@luxsci.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02110-1301  USA
  17 */
  18 #ifdef HAVE_CONFIG_H
  19 #include <config.h>
  20 #endif
  21
  22 #include <stdio.h>
  23 #include <unistd.h>
  24 #include <stdlib.h>
  25 #include <sys/types.h>
  26 #include <sys/stat.h>
  27 #include <errno.h>
  28 #include <ctype.h>
  29 #include <pwd.h>
  30 #include <time.h>
  31
  32 #ifdef HAVE_GETOPT_H
  33 #include <getopt.h>
  34 #endif
  35
  36 #ifndef HAVE_ERR_H
  37 #include "err.c"
  38 #endif
  39
  40 #include "ui.h"
  41
  42 static void *Realloc(void *p, size_t size)
  43 {
  44     void *p2;
  45
  46     if ((p2 = realloc(p, size)) == NULL)
  47         err(EXIT_FAILURE, "%s", "realloc()");
  48
  49     return p2;
  50 }
  51
  52 /* This may be used in modules to keep a consistant time format with other
  53  * modules. */
  54 char *stamp(time_t epoch, const char *format)
  55 {
  56     static char buf[TIMEBUFSIZE];
  57     struct tm *t;
  58
  59     t = localtime(&epoch);
  60     strftime(buf, sizeof(buf), format, t);
  61     return buf;
  62 }
  63
  64 /*
  65  * This may be used in modules to add a string to the buffer (ui_module_exec()).
  66  */
  67 void add_string(char ***buf, const char *str)
  68 {
  69     char **s;
  70     int i = 0;
  71
  72     if (*buf) {
  73         for (s = *buf; *s; s++)
  74             i++;
  75     }
  76
  77     s = *buf;
  78     s = Realloc(s, (i + 2) * sizeof(char *));
  79     s[i++] = strdup(str);
  80     s[i] = NULL;
  81     *buf = s;
  82 }
  83
  84 /* This is for the field separators (-F and -m). */
  85 static int escapes(const char *str)
  86 {
  87     int c = 0;
  88
  89     if (str[0] != '\\')
  90         return str[0];
  91
  92     switch (*++str) {
  93         case 't':
  94             c = '\t';
  95             break;
  96         case 'n':
  97             c = '\n';
  98             break;
  99         case '\\':
 100             c = '\\';
 101             break;
 102         case 'v':
 103             c = '\v';
 104             break;
 105         case 'b':
 106             c = '\b';
 107             break;
 108         case 'f':
 109             c = '\f';
 110             break;
 111         case 'r':
 112             c = '\r';
 113             break;
 114         case '\'':
 115             c = '\'';
 116             break;
 117         default:
 118             c = 0;
 119             break;
 120     }
 121
 122     return c;
 123 }
 124
 125 /* Help text. Module help text is displayed after this. */
 126 static void usage_header()
 127 {
 128     printf("Usage: %s [-vhVL] [-c <filename>] [-t fmt] [-m c] [-F c] [-d]\n"
 129            "\t[[-xX] -O <module1> [options] [-- [-xX] -O <module2> [...]]]\n"
 130            "\t[- | username | -f filename] [...]\n\n", __progname);
 131 }
 132
 133 /* Help text. Module help text is displayed before this. */
 134 static void usage()
 135 {
 136     printf("  -d\tLoad the default modules (passwd.so, mail.so, and login.so).\n");
 137     printf("  -c\tRead a configuration file. Can be used more than once.\n");
 138     printf("  -O\tLoad a module. Can be used more than once.\n");
 139     printf("  -x\tChain module1's output to module2's input.\n");
 140     printf("  -X\tDon't output module1's info, only chain it.\n");
 141     printf("  -F c\tSeparate output with the specified character "
 142            "('%c').\n", delimchar);
 143     printf("  -m c\tSeparate multi-string values with the specified "
 144            "character ('%c').\n", multichar);
 145     printf("  -t tf\tstrftime(3) time format ('%s').\n", DEFAULT_TIMEFORMAT);
 146     printf("  -f\tUsers are the owners of the specified files.\n");
 147     printf("  -L\tFollow symbolic links.\n");
 148     printf("  -v\tVerbose output when possible (twice for all modules).\n");
 149     printf("  -h\tThis help text.\n");
 150     printf("  -V\tVersion information.\n\n");
 151     printf("Output key: %s=unknown/error, %s=none, %s=yes/on, "
 152            "%s=no/off\n", UNKNOWN, NONE, ON, OFF);
 153 }
 154
 155 /*
 156  * Add a module to the array of loaded modules. The index argument is the
 157  * current item number being added stored in an integer. The module is also
 158  * initialized here with ui_module_init().
 159  */
 160 static int open_module(char *filename, int *idx)
 161 {
 162     void *m;
 163     module_init *init;
 164     char *p, s[FILENAME_MAX];
 165     int i;
 166     int chainable = 0;
 167
 168     strncpy(s, filename, sizeof(s));
 169
 170     if ((p = strrchr(s, '/')) != NULL)
 171         p++;
 172     else {
 173         strncpy(s, filename, sizeof(s));
 174         p = s;
 175     }
 176
 177     for (i = 0; i < module_index; i++) {
 178         if (strcmp(p, modules[i].name) == 0) {
 179             if (TEST_FLAG(modules[i].flags, MODULE_DUP))
 180                 break;
 181
 182             SET_FLAG(modules[i].flags, MODULE_DUP);
 183             warnx("%s: a module by this name is already loaded", p);
 184         }
 185     }
 186
 187     if ((m = dlopen(filename, RTLD_NOW)) == NULL) {
 188         warnx("%s", dlerror());
 189         chaining = 0;
 190         chain_output = 1;
 191         return 1;
 192     }
 193
 194     modules = Realloc(modules, (module_index + 2) * sizeof(struct module));
 195     modules[module_index].m = m;
 196
 197     strncpy(modules[module_index].name, p, sizeof(modules[module_index].name));
 198     *idx = module_index++;
 199
 200     if ((init = dlsym(modules[*idx].m, "ui_module_init")) == NULL)
 201         warnx("%s", dlerror());
 202     else
 203         (*init) (&chainable);
 204
 205     if (chainable)
 206         SET_FLAG(modules[*idx].flags, MODULE_CHAINABLE);
 207
 208     if (*idx - 1 >= 0 && TEST_FLAG(modules[*idx - 1].flags, MODULE_CHAINED) &&
 209             !TEST_FLAG(modules[*idx].flags, MODULE_CHAINABLE)) {
 210         warnx("%s: this module is not chainable", modules[*idx].name);
 211         return 1;
 212     }
 213
 214     /* Module chaining. See junction() for more info. */
 215     if (chaining)
 216         SET_FLAG(modules[*idx].flags, MODULE_CHAINED);
 217
 218     if (chain_output)
 219         SET_FLAG(modules[*idx].flags, MODULE_OUTPUT);
 220
 221     if (verbose)
 222         SET_FLAG(modules[*idx].flags, MODULE_VERBOSE);
 223
 224     chaining = 0;
 225     chain_output = 1;
 226     verbose = (verbose < 2) ? 0 : 2;
 227     return 0;
 228 }
 229
 230 /* This just free's up the array of modules. The modules should clean up after
 231  * themselves via the ui_module_exit() function. */
 232 static void cleanup_modules()
 233 {
 234     int i;
 235
 236     for (i = 0; i < module_index; i++) {
 237         module_exit *e;
 238
 239         if ((e = dlsym(modules[i].m, "ui_module_exit")) == NULL)
 240             warnx("%s", dlerror());
 241         else
 242             (*e)();
 243
 244         dlclose(modules[i].m);
 245     }
 246
 247     free(modules);
 248 }
 249
 250 static void output(char **s, const int sep, int which)
 251 {
 252     char **p = s;
 253
 254     if (p) {
 255         for (; *p; p++) {
 256             printf("%s", *p);
 257
 258             if (*(p+1))
 259                 printf("%c", sep);
 260         }
 261     }
 262
 263     printf("%c", which == OUTPUT_DONE ? '\n' : sep);
 264 }
 265
 266 /* Pass the argument to each loaded module. */
 267 static int junction(const char *arg)
 268 {
 269     int i;
 270     struct passwd *pw;
 271     struct stat st;
 272     int ret = EXIT_SUCCESS;
 273     char **s = NULL;
 274
 275     if (usefile) {
 276         if ((STAT(arg, &st)) == -1) {
 277             warn("%s", arg);
 278             return EXIT_FAILURE;
 279         }
 280
 281         errno = 0;
 282
 283         if ((pw = getpwuid(st.st_uid)) == NULL) {
 284 #ifdef __NetBSD__
 285             warnx("%s: no such user", arg);
 286 #else
 287             if (errno == 0 || errno == ENOENT || errno == EPERM
 288                 || errno == EBADF || errno == ESRCH)
 289                 warnx("%s: no such uid %u", arg, st.st_uid);
 290             else
 291                 warn("%s", "getpwuid()");
 292 #endif
 293
 294             return EXIT_FAILURE;
 295         }
 296     }
 297     else {
 298         errno = 0;
 299
 300         if ((pw = getpwnam(arg)) == NULL) {
 301 #ifdef __NetBSD__
 302             warnx("%s: no such user", arg);
 303 #else
 304             if (errno == 0 || errno == ENOENT || errno == EPERM
 305                 || errno == EBADF || errno == ESRCH)
 306                 warnx("%s: no such user", arg);
 307             else
 308                 warn("%s", "getpwnam()");
 309 #endif
 310
 311             return EXIT_FAILURE;
 312         }
 313     }
 314
 315     for (i = 0; i < module_index; i++) {
 316         module_exec *m_exec;
 317
 318         if ((m_exec = dlsym(modules[i].m, "ui_module_exec")) == NULL) {
 319             warnx("%s", dlerror());
 320             continue;
 321         }
 322
 323         ret |= (*m_exec) (&s, pw, multichar,
 324                 TEST_FLAG(modules[i].flags, MODULE_VERBOSE), tf);
 325
 326         if (!TEST_FLAG(modules[i].flags, MODULE_CHAINED) ||
 327                 (TEST_FLAG(modules[i].flags, MODULE_CHAINED) &&
 328                  TEST_FLAG(modules[i].flags, MODULE_OUTPUT))) {
 329             output(s, delimchar,
 330                     ((i + 1) < module_index) ? OUTPUT_APPEND : OUTPUT_DONE);
 331
 332             if (!TEST_FLAG(modules[i].flags, MODULE_CHAINED)) {
 333                 char **p;
 334
 335                 for (p = s; *p; p++) {
 336                     free(*p);
 337                 }
 338
 339                 free(s);
 340                 s = NULL;
 341             }
 342         }
 343     }
 344
 345     return ret;
 346 }
 347
 348 /* Copy options for each module into it's own argc and argv variables stopping
 349  * at -- (getopt(3)). */
 350 static int init_module_options(int the_argc, char **the_argv, struct module mod)
 351 {
 352     char tmp[255];
 353     module_options *m;
 354     module_options_init *o;
 355     int old_optind = optind;
 356     int argc = 0;
 357     char **argv = NULL;
 358     int opt;
 359     int ret = EXIT_SUCCESS;
 360     char *optstring = NULL;
 361     char *defaults = NULL;
 362     int have_an_argument = 0;
 363
 364     if ((o = dlsym(mod.m, "ui_module_options_init")) == NULL) {
 365         warnx("%s", dlerror());
 366         return EXIT_FAILURE;
 367     }
 368
 369     if ((optstring = (*o) (&defaults))) {
 370         argv = Realloc(argv, (argc + 2) * sizeof(char *));
 371         argv[argc++] = strdup(__progname);
 372         argv[argc] = NULL;
 373
 374         /* Probably a default module. */
 375         if (the_argv == NULL)
 376             goto blah;
 377
 378         while ((opt = getopt(the_argc, the_argv, optstring)) != -1) {
 379             switch (opt) {
 380                 case '?':
 381                     warnx("%s: invalid option -- %c\n", mod.name,
 382                           optopt);
 383                     return EXIT_FAILURE;
 384                 default:
 385                     break;
 386             }
 387
 388             argv = Realloc(argv, (argc + 2) * sizeof(char *));
 389             snprintf(tmp, sizeof(tmp), "-%c%s", opt, (optarg) ? optarg : "");
 390             argv[argc++] = strdup(tmp);
 391             argv[argc] = NULL;
 392             have_an_argument = 1;
 393         }
 394     }
 395     else
 396         goto skip_option_stuff;
 397
 398 blah:
 399     /*
 400      * No options were specified for this module. Set the modules default
 401      * options (ui_module_options_init()) if any.
 402      */
 403     if (!have_an_argument && defaults) {
 404         argv = Realloc(argv, (argc + 2) * sizeof(char *));
 405         snprintf(tmp, sizeof(tmp), "-%s", defaults);
 406         argv[argc++] = strdup(tmp);
 407         argv[argc] = NULL;
 408     }
 409
 410     old_optind = optind;
 411     opterr = optind = optopt = 1;
 412
 413     if ((m = dlsym(mod.m, "ui_module_options")) == NULL) {
 414         warnx("%s", dlerror());
 415         return EXIT_FAILURE;
 416     }
 417
 418     ret |= (*m) (argc, argv);
 419     optind = old_optind;
 420
 421 skip_option_stuff:
 422     return ret;
 423 }
 424
 425 /*
 426  * parseargs.c
 427  *
 428  * This will parse a line used as an argument list for the exec() line of
 429  * functions returning a dynamically allocated array of character pointers so
 430  * you should free() it afterwards. Both ' and " quoting is supported (with
 431  * escapes) for multi-word arguments.
 432  *
 433  * This is my second attempt at it. Works alot better than the first. :)
 434  *
 435  * 2002/10/05
 436  * Ben Kibbey <bjk@luxsci.net>
 437  *
 438  * 2004/11/07
 439  *     Modified to handle argv[0] and argc. (Ben Kibbey <bjk@luxsci.net>)
 440  */
 441 static char **parseargv(char *str, const char *progname, int *me_argc)
 442 {
 443     char **pptr, *s;
 444     char arg[255];
 445     int idx = 0;
 446     int quote = 0;
 447     int lastchar = 0;
 448     int i;
 449     int my_argc = 0;
 450
 451     if (!str)
 452         return NULL;
 453
 454     if (!(pptr = malloc(sizeof(char *))))
 455         return NULL;
 456
 457     pptr = Realloc(pptr, (idx + 2) * sizeof(char *));
 458     pptr[idx++] = strdup(progname);
 459     my_argc++;
 460
 461     for (i = 0, s = str; *s; lastchar = *s++) {
 462         if ((*s == '\"' || *s == '\'') && lastchar != '\\') {
 463             quote = (quote) ? 0 : 1;
 464             continue;
 465         }
 466
 467         if (*s == ' ' && !quote) {
 468             arg[i] = 0;
 469             pptr = Realloc(pptr, (idx + 2) * sizeof(char *));
 470             pptr[idx++] = strdup(arg);
 471             my_argc++;
 472             arg[0] = i = 0;
 473             continue;
 474         }
 475
 476         if ((i + 1) == sizeof(arg))
 477             continue;
 478
 479         arg[i++] = *s;
 480     }
 481
 482     arg[i] = 0;
 483
 484     if (arg[0]) {
 485         pptr = Realloc(pptr, (idx + 2) * sizeof(char *));
 486         pptr[idx++] = strdup(arg);
 487         my_argc++;
 488     }
 489
 490     pptr[idx] = NULL;
 491     *me_argc = my_argc;
 492     return pptr;
 493 }
 494
 495 static char *get_home_directory()
 496 {
 497     struct passwd *pw;
 498     static char dir[FILENAME_MAX];
 499
 500     errno = 0;
 501
 502     if ((pw = getpwuid(getuid())) == NULL) {
 503         if (errno)
 504             warn("getpwuid()");
 505         else
 506             warnx("getpwuid(): no such uid");
 507
 508         return NULL;
 509     }
 510
 511     strncpy(dir, pw->pw_dir, sizeof(dir));
 512     return dir;
 513 }
 514
 515 /* Read in a configuration file adding modules to the module array and
 516  * checking any module options. */
 517 static int parse_rc_file(const char *filename)
 518 {
 519     char line[LINE_MAX], *p;
 520     FILE *fp;
 521     int idx;
 522     int old_optind = optind;
 523
 524     if ((fp = fopen(filename, "r")) == NULL) {
 525         warn("%s", filename);
 526         return 1;
 527     }
 528
 529     while ((p = fgets(line, sizeof(line), fp)) != NULL) {
 530         char name[FILENAME_MAX], options[LINE_MAX], tmp[LINE_MAX], *s;
 531         int my_argc;
 532         char **my_argv;
 533         int lastchar = '\0';
 534
 535         while (*p && isspace((unsigned char) *p))
 536             p++;
 537
 538         if (*p == '#')
 539             continue;
 540
 541         s = name;
 542
 543         if (*p == '>' || *p == '-') {
 544             chaining = 1;
 545
 546             if (*p == '-')
 547                 chain_output = 0;
 548
 549             p++;
 550         }
 551
 552         while (*p && *p != ' ' && *p != '\t') {
 553             if (*p == '\n') {
 554                 p++;
 555                 break;
 556             }
 557
 558             *s++ = *p++;
 559         }
 560
 561         *s = '\0';
 562
 563         if (!name[0])
 564             continue;
 565
 566         s = options;
 567
 568         while (*p && isspace((unsigned char) *p))
 569             p++;
 570
 571         lastchar = *p;
 572
 573         while (*p) {
 574             if (*p == '\n' || (*p == '#' && lastchar != '\\'))
 575                 break;
 576
 577             if (*p == '#' && lastchar == '\\') {
 578                 lastchar = *--s = *p++;
 579                 s++;
 580                 continue;
 581             }
 582
 583             lastchar = *s++ = *p++;
 584         }
 585
 586         *s = '\0';
 587         p = name;
 588
 589         if (*p == '~') {
 590             s = get_home_directory();
 591             strncpy(tmp, s, sizeof(tmp));
 592             p++;
 593             strncat(tmp, p, sizeof(tmp)-strlen(tmp)-1);
 594             strncpy(name, tmp, sizeof(name));
 595         }
 596
 597         if (open_module(name, &idx))
 598             continue;
 599
 600         if ((my_argv = parseargv(options, __progname, &my_argc)) == NULL)
 601             continue;
 602
 603         optind = 0;
 604
 605         if (init_module_options(my_argc, my_argv, modules[idx])) {
 606             fclose(fp);
 607             return 2;
 608         }
 609
 610         optind = old_optind;
 611     }
 612
 613     fclose(fp);
 614     return 0;
 615 }
 616
 617 int main(int argc, char *argv[])
 618 {
 619     int i = 0;
 620     int ret = EXIT_SUCCESS;
 621     int opt;
 622     char line[LINE_MAX], *s = NULL;
 623     int want_help = 0;
 624
 625 #ifndef HAVE___PROGNAME
 626     __progname = argv[0];
 627 #endif
 628     delimchar = DEFAULT_DELIMINATING_CHAR;
 629     multichar = DEFAULT_MULTI_CHAR;
 630     strncpy(tf, DEFAULT_TIMEFORMAT, sizeof(tf));
 631     chain_output = 1;
 632
 633     while ((opt = getopt(argc, argv, "+x:X:dm:c:hO:F:t:vVLf")) != -1) {
 634         /*
 635          * See getopt(3).
 636          */
 637         opterr = 0;
 638
 639         switch (opt) {
 640             case 'd':
 641                 i = module_index;
 642
 643                 if (open_module("passwd.so", &i) == 0) {
 644                     if (init_module_options(1, NULL, modules[i]))
 645                         want_help = 1;
 646                 }
 647                 else {
 648                     ret = EXIT_FAILURE;
 649                     goto cleanup;
 650                 }
 651
 652                 if (open_module("mail.so", &i) == 0) {
 653                     if (init_module_options(1, NULL, modules[i]))
 654                         want_help = 1;
 655                 }
 656                 else {
 657                     ret = EXIT_FAILURE;
 658                     goto cleanup;
 659                 }
 660
 661                 if (open_module("login.so", &i) == 0) {
 662                     if (init_module_options(1, NULL, modules[i]))
 663                         want_help = 1;
 664                 }
 665                 else {
 666                     ret = EXIT_FAILURE;
 667                     goto cleanup;
 668                 }
 669
 670                 break;
 671             case 'm':
 672                 if ((optarg[0] != '\\' && strlen(optarg) > 1) ||
 673                     (optarg[0] == '\\' && strlen(optarg) != 2)) {
 674                     want_help = 1;
 675                     break;
 676                 }
 677
 678                 if ((multichar = escapes(optarg)) == 0)
 679                     want_help = 1;
 680
 681                 break;
 682             case 'c':
 683                 if ((ret = parse_rc_file(optarg)) != 0) {
 684                     if (ret == 2)
 685                         want_help = 1;
 686                     else
 687                         exit(EXIT_FAILURE);
 688                 }
 689                 break;
 690             case 'F':
 691                 if ((optarg[0] != '\\' && strlen(optarg) > 1) ||
 692                     (optarg[0] == '\\' && strlen(optarg) != 2)) {
 693                     want_help = 1;
 694                     break;
 695                 }
 696
 697                 if ((delimchar = escapes(optarg)) == 0)
 698                     want_help = 1;
 699
 700                 break;
 701             case 't':
 702                 strncpy(tf, optarg, sizeof(tf));
 703                 break;
 704             case 'V':
 705                 printf("%s\n%s\n", PACKAGE_STRING, COPYRIGHT);
 706                 exit(EXIT_SUCCESS);
 707                 break;
 708             case 'L':
 709                 followsymlinks = 1;
 710                 break;
 711             case 'f':
 712                 usefile = 1;
 713                 break;
 714             case 'v':
 715                 verbose++;
 716                 break;
 717             case 'X':
 718                 chain_output = 0;
 719             case 'x':
 720                 chaining = 1;
 721             case 'O':
 722                 if (open_module(optarg, &i)) {
 723                     ret = EXIT_FAILURE;
 724                     goto cleanup;
 725                 }
 726
 727                 if (init_module_options(argc, argv, modules[i]))
 728                     want_help = 1;
 729
 730                 /*
 731                  * For modules which have no options at all (to keep getopt
 732                  * from interpreting the rest as arguments.
 733                  */
 734                 if (optind < argc) {
 735                     if (strcmp(argv[optind], "--") == 0)
 736                         optind++;
 737                 }
 738
 739                 break;
 740             case 'h':
 741             default:
 742                 want_help = 1;
 743                 break;
 744         }
 745     }
 746
 747     /* The last module cannot be chained (syntax). */
 748     if (!module_index || TEST_FLAG(modules[module_index - 1].flags, MODULE_CHAINED))
 749         want_help = 1;
 750
 751     /* Cycle through the modules and output their help text. */
 752     if (want_help) {
 753         usage_header();
 754
 755         for (i = 0; i < module_index; i++) {
 756             module_help *m_help;
 757
 758             if (TEST_FLAG(modules[i].flags, MODULE_DUP))
 759                 continue;
 760
 761             if ((m_help = dlsym(modules[i].m, "ui_module_help")) == NULL) {
 762                 warnx("%s", dlerror());
 763                 continue;
 764             }
 765
 766             fprintf(stderr, "%s\n", modules[i].name);
 767             (*m_help) ();
 768         }
 769
 770         usage();
 771         cleanup_modules();
 772         exit(EXIT_FAILURE);
 773     }
 774
 775     if (argc == optind || strcmp(argv[optind], "-") == 0) {
 776         while ((s = fgets(line, sizeof(line), stdin)) != NULL) {
 777             if (s[strlen(s) - 1] == '\n')
 778                 s[strlen(s) - 1] = '\0';
 779
 780             ret |= junction(s);
 781         }
 782     }
 783     else {
 784         for (; optind < argc; optind++)
 785             ret |= junction(argv[optind]);
 786     }
 787
 788 cleanup:
 789     cleanup_modules();
 790     exit(ret);
 791 }