2 Copyright (C) 2001-2011 Ben Kibbey <bjk@luxsci.net>
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.
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.
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
25 #include <sys/types.h>
42 static void *Realloc(void *p
, size_t size
)
46 if ((p2
= realloc(p
, size
)) == NULL
)
47 err(EXIT_FAILURE
, "%s", "realloc()");
52 /* This may be used in modules to keep a consistant time format with other
54 char *stamp(time_t epoch
, const char *format
)
56 static char buf
[TIMEBUFSIZE
];
59 t
= localtime(&epoch
);
60 strftime(buf
, sizeof(buf
), format
, t
);
65 * This may be used in modules to add a string to the buffer (ui_module_exec()).
67 void add_string(char ***buf
, const char *str
)
73 for (s
= *buf
; *s
; s
++)
78 s
= Realloc(s
, (i
+ 2) * sizeof(char *));
84 /* This is for the field separators (-F and -m). */
85 static int escapes(const char *str
)
125 /* Help text. Module help text is displayed after this. */
126 static void usage_header()
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
);
133 /* Help text. Module help text is displayed before this. */
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
);
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().
160 static int open_module(char *filename
, int *idx
)
164 char *p
, s
[FILENAME_MAX
];
168 strncpy(s
, filename
, sizeof(s
));
170 if ((p
= strrchr(s
, '/')) != NULL
)
173 strncpy(s
, filename
, sizeof(s
));
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
))
182 SET_FLAG(modules
[i
].flags
, MODULE_DUP
);
183 warnx("%s: a module by this name is already loaded", p
);
187 if ((m
= dlopen(filename
, RTLD_NOW
)) == NULL
) {
188 warnx("%s", dlerror());
194 modules
= Realloc(modules
, (module_index
+ 2) * sizeof(struct module
));
195 modules
[module_index
].m
= m
;
197 strncpy(modules
[module_index
].name
, p
, sizeof(modules
[module_index
].name
));
198 *idx
= module_index
++;
200 if ((init
= dlsym(modules
[*idx
].m
, "ui_module_init")) == NULL
)
201 warnx("%s", dlerror());
203 (*init
) (&chainable
);
206 SET_FLAG(modules
[*idx
].flags
, MODULE_CHAINABLE
);
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
);
214 /* Module chaining. See junction() for more info. */
216 SET_FLAG(modules
[*idx
].flags
, MODULE_CHAINED
);
219 SET_FLAG(modules
[*idx
].flags
, MODULE_OUTPUT
);
222 SET_FLAG(modules
[*idx
].flags
, MODULE_VERBOSE
);
226 verbose
= (verbose
< 2) ? 0 : 2;
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()
236 for (i
= 0; i
< module_index
; i
++) {
239 if ((e
= dlsym(modules
[i
].m
, "ui_module_exit")) == NULL
)
240 warnx("%s", dlerror());
244 dlclose(modules
[i
].m
);
250 static void output(char **s
, const int sep
, int which
)
255 for (i
= 0; s
[i
]; i
++) {
263 printf("%c", which
== OUTPUT_DONE
? '\n' : sep
);
266 /* Pass the argument to each loaded module. */
267 static int junction(const char *arg
)
272 int ret
= EXIT_SUCCESS
;
276 if ((STAT(arg
, &st
)) == -1) {
283 if ((pw
= getpwuid(st
.st_uid
)) == NULL
) {
285 warnx("%s: no such user", arg
);
287 if (errno
== 0 || errno
== ENOENT
|| errno
== EPERM
288 || errno
== EBADF
|| errno
== ESRCH
)
289 warnx("%s: no such uid %u", arg
, st
.st_uid
);
291 warn("%s", "getpwuid()");
300 if ((pw
= getpwnam(arg
)) == NULL
) {
302 warnx("%s: no such user", arg
);
304 if (errno
== 0 || errno
== ENOENT
|| errno
== EPERM
305 || errno
== EBADF
|| errno
== ESRCH
)
306 warnx("%s: no such user", arg
);
308 warn("%s", "getpwnam()");
315 for (i
= 0; i
< module_index
; i
++) {
319 if ((m_exec
= dlsym(modules
[i
].m
, "ui_module_exec")) == NULL
) {
320 warnx("%s", dlerror());
324 ret
|= (*m_exec
) (&s
, pw
, multichar
,
325 TEST_FLAG(modules
[i
].flags
, MODULE_VERBOSE
), tf
);
327 if (!TEST_FLAG(modules
[i
].flags
, MODULE_CHAINED
) || (TEST_FLAG(modules
[i
].flags
, MODULE_CHAINED
) && TEST_FLAG(modules
[i
].flags
, MODULE_OUTPUT
))) {
329 ((i
+ 1) < module_index
) ? OUTPUT_APPEND
: OUTPUT_DONE
);
331 if (!TEST_FLAG(modules
[i
].flags
, MODULE_CHAINED
)) {
332 for (p
= s
; *p
; p
++) {
345 /* Copy options for each module into it's own argc and argv variables stopping
346 * at -- (getopt(3)). */
347 static int init_module_options(int the_argc
, char **the_argv
, struct module mod
)
351 module_options_init
*o
;
352 int old_optind
= optind
;
356 int ret
= EXIT_SUCCESS
;
357 char *optstring
= NULL
;
358 char *defaults
= NULL
;
359 int have_an_argument
= 0;
361 if ((o
= dlsym(mod
.m
, "ui_module_options_init")) == NULL
) {
362 warnx("%s", dlerror());
366 if ((optstring
= (*o
) (&defaults
))) {
367 argv
= Realloc(argv
, (argc
+ 2) * sizeof(char *));
368 argv
[argc
++] = strdup(__progname
);
371 /* Probably a default module. */
372 if (the_argv
== NULL
)
375 while ((opt
= getopt(the_argc
, the_argv
, optstring
)) != -1) {
378 warnx("%s: invalid option -- %c\n", mod
.name
,
385 argv
= Realloc(argv
, (argc
+ 2) * sizeof(char *));
386 snprintf(tmp
, sizeof(tmp
), "-%c%s", opt
, (optarg
) ? optarg
: "");
387 argv
[argc
++] = strdup(tmp
);
389 have_an_argument
= 1;
393 goto skip_option_stuff
;
397 * No options were specified for this module. Set the modules default
398 * options (ui_module_options_init()) if any.
400 if (!have_an_argument
&& defaults
) {
401 argv
= Realloc(argv
, (argc
+ 2) * sizeof(char *));
402 snprintf(tmp
, sizeof(tmp
), "-%s", defaults
);
403 argv
[argc
++] = strdup(tmp
);
408 opterr
= optind
= optopt
= 1;
410 if ((m
= dlsym(mod
.m
, "ui_module_options")) == NULL
) {
411 warnx("%s", dlerror());
415 ret
|= (*m
) (argc
, argv
);
425 * This will parse a line used as an argument list for the exec() line of
426 * functions returning a dynamically allocated array of character pointers so
427 * you should free() it afterwards. Both ' and " quoting is supported (with
428 * escapes) for multi-word arguments.
430 * This is my second attempt at it. Works alot better than the first. :)
433 * Ben Kibbey <bjk@luxsci.net>
436 * Modified to handle argv[0] and argc. (Ben Kibbey <bjk@luxsci.net>)
438 static char **parseargv(char *str
, const char *progname
, int *me_argc
)
451 if (!(pptr
= malloc(sizeof(char *))))
454 pptr
= Realloc(pptr
, (idx
+ 2) * sizeof(char *));
455 pptr
[idx
++] = strdup(progname
);
458 for (i
= 0, s
= str
; *s
; lastchar
= *s
++) {
459 if ((*s
== '\"' || *s
== '\'') && lastchar
!= '\\') {
460 quote
= (quote
) ? 0 : 1;
464 if (*s
== ' ' && !quote
) {
466 pptr
= Realloc(pptr
, (idx
+ 2) * sizeof(char *));
467 pptr
[idx
++] = strdup(arg
);
473 if ((i
+ 1) == sizeof(arg
))
482 pptr
= Realloc(pptr
, (idx
+ 2) * sizeof(char *));
483 pptr
[idx
++] = strdup(arg
);
492 static char *get_home_directory()
495 static char dir
[FILENAME_MAX
];
499 if ((pw
= getpwuid(getuid())) == NULL
) {
503 warnx("getpwuid(): no such uid");
508 strncpy(dir
, pw
->pw_dir
, sizeof(dir
));
512 /* Read in a configuration file adding modules to the module array and
513 * checking any module options. */
514 static int parse_rc_file(const char *filename
)
516 char line
[LINE_MAX
], *p
;
519 int old_optind
= optind
;
521 if ((fp
= fopen(filename
, "r")) == NULL
) {
522 warn("%s", filename
);
526 while ((p
= fgets(line
, sizeof(line
), fp
)) != NULL
) {
527 char name
[FILENAME_MAX
], options
[LINE_MAX
], tmp
[LINE_MAX
], *s
;
532 while (*p
&& isspace((unsigned char) *p
))
540 if (*p
== '>' || *p
== '-') {
549 while (*p
&& *p
!= ' ' && *p
!= '\t') {
565 while (*p
&& isspace((unsigned char) *p
))
571 if (*p
== '\n' || (*p
== '#' && lastchar
!= '\\'))
574 if (*p
== '#' && lastchar
== '\\') {
575 lastchar
= *--s
= *p
++;
580 lastchar
= *s
++ = *p
++;
587 s
= get_home_directory();
588 strncpy(tmp
, s
, sizeof(tmp
));
590 strncat(tmp
, p
, sizeof(tmp
));
591 strncpy(name
, tmp
, sizeof(name
));
594 if (open_module(name
, &idx
))
597 if ((my_argv
= parseargv(options
, __progname
, &my_argc
)) == NULL
)
602 if (init_module_options(my_argc
, my_argv
, modules
[idx
])) {
614 int main(int argc
, char *argv
[])
617 int ret
= EXIT_SUCCESS
;
619 char line
[LINE_MAX
], *s
= NULL
;
622 #ifndef HAVE___PROGNAME
623 __progname
= argv
[0];
625 delimchar
= DEFAULT_DELIMINATING_CHAR
;
626 multichar
= DEFAULT_MULTI_CHAR
;
627 strncpy(tf
, DEFAULT_TIMEFORMAT
, sizeof(tf
));
630 while ((opt
= getopt(argc
, argv
, "+x:X:dm:c:hO:F:t:vVLf")) != -1) {
640 if (open_module("passwd.so", &i
) == 0) {
641 if (init_module_options(1, NULL
, modules
[i
]))
649 if (open_module("mail.so", &i
) == 0) {
650 if (init_module_options(1, NULL
, modules
[i
]))
658 if (open_module("login.so", &i
) == 0) {
659 if (init_module_options(1, NULL
, modules
[i
]))
669 if ((optarg
[0] != '\\' && strlen(optarg
) > 1) ||
670 (optarg
[0] == '\\' && strlen(optarg
) != 2)) {
675 if ((multichar
= escapes(optarg
)) == 0)
680 if ((ret
= parse_rc_file(optarg
)) != 0) {
688 if ((optarg
[0] != '\\' && strlen(optarg
) > 1) ||
689 (optarg
[0] == '\\' && strlen(optarg
) != 2)) {
694 if ((delimchar
= escapes(optarg
)) == 0)
699 strncpy(tf
, optarg
, sizeof(tf
));
702 printf("%s\n%s\n", PACKAGE_STRING
, COPYRIGHT
);
719 if (open_module(optarg
, &i
)) {
724 if (init_module_options(argc
, argv
, modules
[i
]))
728 * For modules which have no options at all (to keep getopt
729 * from interpreting the rest as arguments.
732 if (strcmp(argv
[optind
], "--") == 0)
744 /* The last module cannot be chained (syntax). */
745 if (!module_index
|| TEST_FLAG(modules
[module_index
- 1].flags
, MODULE_CHAINED
))
748 /* Cycle through the modules and output their help text. */
752 for (i
= 0; i
< module_index
; i
++) {
755 if (TEST_FLAG(modules
[i
].flags
, MODULE_DUP
))
758 if ((m_help
= dlsym(modules
[i
].m
, "ui_module_help")) == NULL
) {
759 warnx("%s", dlerror());
763 fprintf(stderr
, "%s\n", modules
[i
].name
);
772 if (argc
== optind
|| strcmp(argv
[optind
], "-") == 0) {
773 while ((s
= fgets(line
, sizeof(line
), stdin
)) != NULL
) {
774 if (s
[strlen(s
) - 1] == '\n')
775 s
[strlen(s
) - 1] = '\0';
781 for (; optind
< argc
; optind
++)
782 ret
|= junction(argv
[optind
]);