Include xalloc.h.
[platform/upstream/coreutils.git] / src / who.c
1 /* GNU's who.
2    Copyright (C) 1992-2002 Free Software Foundation, Inc.
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, or (at your option)
7    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 Foundation,
16    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
17
18 /* Written by jla; revised by djm; revised again by mstone */
19
20 /* Output format:
21    name [state] line time [activity] [pid] [comment] [exit]
22    state: -T
23    name, line, time: not -q
24    idle: -u
25 */
26
27 #include <config.h>
28 #include <getopt.h>
29 #include <stdio.h>
30
31 #include <sys/types.h>
32 #include "system.h"
33
34 #include "xalloc.h"
35 #include "readutmp.h"
36 #include "error.h"
37 #include "closeout.h"
38
39 /* The official name of this program (e.g., no `g' prefix).  */
40 #define PROGRAM_NAME "who"
41
42 #define AUTHORS N_ ("Joseph Arceneaux, David MacKenzie, and Michael Stone")
43
44 #ifndef MAXHOSTNAMELEN
45 # define MAXHOSTNAMELEN 64
46 #endif
47
48 #ifndef S_IWGRP
49 # define S_IWGRP 020
50 #endif
51
52 #ifndef USER_PROCESS
53 # define USER_PROCESS INT_MAX
54 #endif
55
56 #ifndef RUN_LVL
57 # define RUN_LVL INT_MAX
58 #endif
59
60 #ifndef INIT_PROCESS
61 # define INIT_PROCESS INT_MAX
62 #endif
63
64 #ifndef LOGIN_PROCESS
65 # define LOGIN_PROCESS INT_MAX
66 #endif
67
68 #ifndef DEAD_PROCESS
69 # define DEAD_PROCESS INT_MAX
70 #endif
71
72 #ifndef NEW_TIME
73 # define NEW_TIME INT_MAX
74 #endif
75
76 #define IDLESTR_LEN 6
77
78 int gethostname ();
79 char *ttyname ();
80 char *canon_host ();
81
82 /* The name this program was run with. */
83 char *program_name;
84
85 /* If nonzero, attempt to canonicalize hostnames via a DNS lookup. */
86 static int do_lookup;
87
88 /* If nonzero, display only a list of usernames and count of
89    the users logged on.
90    Ignored for `who am i'. */
91 static int short_list;
92
93 /* If nonzero, display only name, line, and time fields */
94 static int short_output;
95
96 /* If nonzero, display the hours:minutes since each user has touched
97    the keyboard, or "." if within the last minute, or "old" if
98    not within the last day. */
99 static int include_idle;
100
101 /* If nonzero, display a line at the top describing each field. */
102 static int include_heading;
103
104 /* If nonzero, display a `+' for each user if mesg y, a `-' if mesg n,
105    or a `?' if their tty cannot be statted. */
106 static int include_mesg;
107
108 /* If nonzero, display process termination & exit status */
109 static int include_exit;
110
111 /* If nonzero, display the last boot time */
112 static int need_boottime;
113
114 /* If nonzero, display dead processes */
115 static int need_deadprocs;
116
117 /* If nonzero, display processes waiting for user login */
118 static int need_login;
119
120 /* If nonzero, display processes started by init */
121 static int need_initspawn;
122
123 /* If nonzero, display the last clock change */
124 static int need_clockchange;
125
126 /* If nonzero, display the current runlevel */
127 static int need_runlevel;
128
129 /* If nonzero, display user processes */
130 static int need_users;
131
132 /* If nonzero, display info only for the controlling tty */
133 static int my_line_only;
134
135 /* for long options with no corresponding short option, use enum */
136 enum
137 {
138   LOOKUP_OPTION = CHAR_MAX + 1,
139   LOGIN_OPTION
140 };
141
142 static struct option const longopts[] = {
143   {"all", no_argument, NULL, 'a'},
144   {"boot", no_argument, NULL, 'b'},
145   {"count", no_argument, NULL, 'q'},
146   {"dead", no_argument, NULL, 'd'},
147   {"heading", no_argument, NULL, 'H'},
148   {"idle", no_argument, NULL, 'i'},
149   {"login", no_argument, NULL, LOGIN_OPTION},
150   {"lookup", no_argument, NULL, LOOKUP_OPTION},
151   {"message", no_argument, NULL, 'T'},
152   {"mesg", no_argument, NULL, 'T'},
153   {"process", no_argument, NULL, 'p'},
154   {"runlevel", no_argument, NULL, 'r'},
155   {"short", no_argument, NULL, 's'},
156   {"time", no_argument, NULL, 't'},
157   {"users", no_argument, NULL, 'u'},
158   {"writable", no_argument, NULL, 'T'},
159   {GETOPT_HELP_OPTION_DECL},
160   {GETOPT_VERSION_OPTION_DECL},
161   {NULL, 0, NULL, 0}
162 };
163
164 /* Return a string representing the time between WHEN and the time
165    that this function is first run.
166    FIXME: locale? */
167 static const char *
168 idle_string (time_t when)
169 {
170   static time_t now = 0;
171   static char idle_hhmm[IDLESTR_LEN];
172   time_t seconds_idle;
173
174   if (now == 0)
175     time (&now);
176
177   seconds_idle = now - when;
178   if (seconds_idle < 60)        /* One minute. */
179     return "  .  ";
180   if (seconds_idle < (24 * 60 * 60))    /* One day. */
181     {
182       sprintf (idle_hhmm, "%02d:%02d",
183                (int) (seconds_idle / (60 * 60)),
184                (int) ((seconds_idle % (60 * 60)) / 60));
185       return (const char *) idle_hhmm;
186     }
187   return _(" old ");
188 }
189
190 /* Return a standard time string, "mon dd hh:mm"
191    FIXME: handle localization */
192 static const char *
193 time_string (const STRUCT_UTMP *utmp_ent)
194 {
195   /* Don't take the address of UT_TIME_MEMBER directly.
196      Ulrich Drepper wrote:
197      ``... GNU libc (and perhaps other libcs as well) have extended
198      utmp file formats which do not use a simple time_t ut_time field.
199      In glibc, ut_time is a macro which selects for backward compatibility
200      the tv_sec member of a struct timeval value.''  */
201   time_t tm = UT_TIME_MEMBER (utmp_ent);
202
203   char *ptr = ctime (&tm) + 4;
204   ptr[12] = '\0';
205   return ptr;
206 }
207
208 /* Print formatted output line. Uses mostly arbitrary field sizes, probably
209    will need tweaking if any of the localization stuff is done, or for 64 bit
210    pids, etc. */
211 static void
212 print_line (const char *user, const char state, const char *line,
213             const char *time_str, const char *idle, const char *pid,
214             const char *comment, const char *exitstr)
215 {
216   printf ("%-8s", user ? user : "   .");
217   if (include_mesg)
218     printf (" %c", state);
219   printf (" %-12s", line);
220   printf (" %-12s", time_str);
221   if (include_idle && !short_output)
222     printf (" %-6s", idle);
223   if (!short_output)
224     printf (" %10s", pid);
225   /* FIXME: it's not really clear whether the following should be in short_output.
226      a strict reading of SUSv2 would suggest not, but I haven't seen any
227      implementations that actually work that way... */
228   printf (" %-8s", comment);
229   if (include_exit && exitstr && *exitstr)
230     printf (" %-12s", exitstr);
231   putchar ('\n');
232 }
233
234 #if HAVE_STRUCT_XTMP_UT_PID
235 # define PIDSTR_DECL_AND_INIT(Var) \
236   char Var[INT_STRLEN_BOUND (utmp_ent->ut_pid) + 1]; \
237   sprintf (Var, "%d", utmp_ent->ut_pid)
238 #else
239 # define PIDSTR_DECL_AND_INIT(Var) \
240   const char *Var = ""
241 #endif
242
243 /* Send properly parsed USER_PROCESS info to print_line */
244 static void
245 print_user (const STRUCT_UTMP *utmp_ent)
246 {
247   struct stat stats;
248   time_t last_change;
249   char mesg;
250   char idlestr[IDLESTR_LEN];
251   static char *hoststr;
252   static int hostlen;
253
254 #define DEV_DIR_WITH_TRAILING_SLASH "/dev/"
255 #define DEV_DIR_LEN (sizeof (DEV_DIR_WITH_TRAILING_SLASH) - 1)
256
257   char line[sizeof (utmp_ent->ut_line) + DEV_DIR_LEN + 1];
258   PIDSTR_DECL_AND_INIT (pidstr);
259
260   /* Copy ut_line into LINE, prepending `/dev/' if ut_line is not
261      already an absolute pathname.  Some system may put the full,
262      absolute pathname in ut_line.  */
263   if (utmp_ent->ut_line[0] == '/')
264     {
265       strncpy (line, utmp_ent->ut_line, sizeof (utmp_ent->ut_line));
266       line[sizeof (utmp_ent->ut_line)] = '\0';
267     }
268   else
269     {
270       strcpy (line, DEV_DIR_WITH_TRAILING_SLASH);
271       strncpy (line + DEV_DIR_LEN, utmp_ent->ut_line,
272                sizeof (utmp_ent->ut_line));
273       line[DEV_DIR_LEN + sizeof (utmp_ent->ut_line)] = '\0';
274     }
275
276   if (stat (line, &stats) == 0)
277     {
278       mesg = (stats.st_mode & S_IWGRP) ? '+' : '-';
279       last_change = stats.st_atime;
280     }
281   else
282     {
283       mesg = '?';
284       last_change = 0;
285     }
286
287   if (last_change)
288     sprintf (idlestr, "%.6s", idle_string (last_change));
289   else
290     sprintf (idlestr, "  ?");
291
292 #if HAVE_UT_HOST
293   if (utmp_ent->ut_host[0])
294     {
295       char ut_host[sizeof (utmp_ent->ut_host) + 1];
296       char *host = 0, *display = 0;
297
298       /* Copy the host name into UT_HOST, and ensure it's nul terminated. */
299       strncpy (ut_host, utmp_ent->ut_host, (int) sizeof (utmp_ent->ut_host));
300       ut_host[sizeof (utmp_ent->ut_host)] = '\0';
301
302       /* Look for an X display.  */
303       display = strrchr (ut_host, ':');
304       if (display)
305         *display++ = '\0';
306
307       if (*ut_host && do_lookup)
308         {
309           /* See if we can canonicalize it.  */
310           host = canon_host (ut_host);
311         }
312
313       if (! host)
314         host = ut_host;
315
316       if (display)
317         {
318           if (hostlen < strlen (host) + strlen (display) + 4)
319             {
320               hostlen = strlen (host) + strlen (display) + 4;
321               hoststr = (char *) realloc (hoststr, hostlen);
322             }
323           sprintf (hoststr, "(%s:%s)", host, display);
324         }
325       else
326         {
327           if (hostlen < strlen (host) + 3)
328             {
329               hostlen = strlen (host) + 3;
330               hoststr = (char *) realloc (hoststr, hostlen);
331             }
332           sprintf (hoststr, "(%s)", host);
333         }
334     }
335   else
336     {
337       if (hostlen < 1)
338         {
339           hostlen = 1;
340           hoststr = (char *) realloc (hoststr, hostlen);
341         }
342       stpcpy (hoststr, "");
343     }
344 #endif
345
346   print_line (UT_USER (utmp_ent), mesg, utmp_ent->ut_line,
347               time_string (utmp_ent), idlestr, pidstr,
348               hoststr ? hoststr : "", "");
349 }
350
351 static void
352 print_boottime (const STRUCT_UTMP *utmp_ent)
353 {
354   print_line ("", ' ', "system boot", time_string (utmp_ent), "", "", "", "");
355 }
356
357 static void
358 print_deadprocs (const STRUCT_UTMP *utmp_ent)
359 {
360   static char *comment, *exitstr;
361   PIDSTR_DECL_AND_INIT (pidstr);
362
363   if (!comment)
364     comment = xmalloc (sizeof (_("id=")) + sizeof (utmp_ent->ut_id) + 1);
365   sprintf (comment, "%s%.*s", _("id="), sizeof utmp_ent->ut_id,
366            utmp_ent->ut_id);
367
368   if (!exitstr)
369     exitstr = xmalloc (sizeof (_("term="))
370                        + INT_STRLEN_BOUND (utmp_ent->ut_exit.e_termination) + 1
371                        + sizeof (_("exit="))
372                        + INT_STRLEN_BOUND (utmp_ent->ut_exit.e_exit)
373                        + 1);
374   sprintf (exitstr, "%s%d %s%d", _("term="), utmp_ent->ut_exit.e_termination,
375            _("exit="), utmp_ent->ut_exit.e_exit);
376
377   /* FIXME: add idle time? */
378
379   print_line ("", ' ', utmp_ent->ut_line,
380               time_string (utmp_ent), "", pidstr, comment, exitstr);
381 }
382
383 static void
384 print_login (const STRUCT_UTMP *utmp_ent)
385 {
386   static char *comment;
387   PIDSTR_DECL_AND_INIT (pidstr);
388
389   if (!comment)
390     comment = xmalloc (sizeof (_("id=")) + sizeof (utmp_ent->ut_id) + 1);
391   sprintf (comment, "%s%s", _("id="), utmp_ent->ut_id);
392
393   /* FIXME: add idle time? */
394
395   print_line ("LOGIN", ' ', utmp_ent->ut_line,
396               time_string (utmp_ent), "", pidstr, comment, "");
397 }
398
399 static void
400 print_initspawn (const STRUCT_UTMP *utmp_ent)
401 {
402   static char *comment;
403   PIDSTR_DECL_AND_INIT (pidstr);
404
405   if (!comment)
406     comment = xmalloc (sizeof (_("id=")) + sizeof (utmp_ent->ut_id) + 1);
407   sprintf (comment, "%s%s", _("id="), utmp_ent->ut_id);
408
409   print_line ("", ' ', utmp_ent->ut_line,
410               time_string (utmp_ent), "", pidstr, comment, "");
411 }
412
413 static void
414 print_clockchange (const STRUCT_UTMP *utmp_ent)
415 {
416   /* FIXME: handle NEW_TIME & OLD_TIME both */
417   print_line ("", ' ', _("clock change"),
418               time_string (utmp_ent), "", "", "", "");
419 }
420
421 static void
422 print_runlevel (const STRUCT_UTMP *utmp_ent)
423 {
424   static char *runlevline, *comment;
425
426   /* FIXME: The following is correct for linux, may need help
427      on other platforms */
428 #if 1 || HAVE_STRUCT_XTMP_UT_PID
429   int last = utmp_ent->ut_pid / 256;
430   int curr = utmp_ent->ut_pid % 256;
431 #endif
432
433   if (!runlevline)
434     runlevline = xmalloc (sizeof (_("run-level")) + 3);
435   sprintf (runlevline, "%s %c", _("run-level"), curr);
436
437   if (!comment)
438     comment = xmalloc (sizeof (_("last=")) + 2);
439   sprintf (comment, "%s%c", _("last="), (last == 'N') ? 'S' : last);
440
441   print_line ("", ' ', runlevline, time_string (utmp_ent),
442               "", "", comment, "");
443
444   return;
445 }
446
447 /* Print the username of each valid entry and the number of valid entries
448    in UTMP_BUF, which should have N elements. */
449 static void
450 list_entries_who (int n, const STRUCT_UTMP *utmp_buf)
451 {
452   int entries = 0;
453
454   while (n--)
455     {
456       if (UT_USER (utmp_buf)[0] && UT_TYPE (utmp_buf) == USER_PROCESS)
457         {
458           char *trimmed_name;
459
460           trimmed_name = extract_trimmed_name (utmp_buf);
461
462           printf ("%s ", trimmed_name);
463           free (trimmed_name);
464           entries++;
465         }
466       utmp_buf++;
467     }
468   printf (_("\n# users=%u\n"), entries);
469 }
470
471 static void
472 print_heading (void)
473 {
474   print_line (_("NAME"), ' ', _("LINE"), _("TIME"), _("IDLE"), _("PID"),
475               _("COMMENT"), _("EXIT"));
476 }
477
478 /* Display UTMP_BUF, which should have N entries. */
479 static void
480 scan_entries (int n, const STRUCT_UTMP *utmp_buf)
481 {
482   char *ttyname_b IF_LINT ( = NULL);
483
484   if (include_heading)
485     print_heading ();
486
487   if (my_line_only)
488     {
489       ttyname_b = ttyname (0);
490       if (!ttyname_b)
491         return;
492       if (strncmp (ttyname_b, DEV_DIR_WITH_TRAILING_SLASH, DEV_DIR_LEN) == 0)
493         ttyname_b += DEV_DIR_LEN;       /* Discard /dev/ prefix.  */
494     }
495
496   while (n--)
497     {
498       if (!my_line_only ||
499           strncmp (ttyname_b, utmp_buf->ut_line,
500                    sizeof (utmp_buf->ut_line)) == 0)
501         {
502           if (need_users && UT_USER (utmp_buf)[0]
503               && UT_TYPE (utmp_buf) == USER_PROCESS)
504             print_user (utmp_buf);
505           else if (need_runlevel && UT_TYPE (utmp_buf) == RUN_LVL)
506             print_runlevel (utmp_buf);
507           else if (need_boottime && UT_TYPE (utmp_buf) == BOOT_TIME)
508             print_boottime (utmp_buf);
509           /* I've never seen one of these, so I don't know what it should
510              look like :^)
511              FIXME: handle OLD_TIME also, perhaps show the delta? */
512           else if (need_clockchange && UT_TYPE (utmp_buf) == NEW_TIME)
513             print_clockchange (utmp_buf);
514           else if (need_initspawn && UT_TYPE (utmp_buf) == INIT_PROCESS)
515             print_initspawn (utmp_buf);
516           else if (need_login && UT_TYPE (utmp_buf) == LOGIN_PROCESS)
517             print_login (utmp_buf);
518           else if (need_deadprocs && UT_TYPE (utmp_buf) == DEAD_PROCESS)
519             print_deadprocs (utmp_buf);
520         }
521
522       utmp_buf++;
523     }
524 }
525
526 /* Display a list of who is on the system, according to utmp file filename. */
527 static void
528 who (const char *filename)
529 {
530   int n_users;
531   STRUCT_UTMP *utmp_buf;
532   int fail = read_utmp (filename, &n_users, &utmp_buf);
533
534   if (fail)
535     error (1, errno, "%s", filename);
536
537   if (short_list)
538     list_entries_who (n_users, utmp_buf);
539   else
540     scan_entries (n_users, utmp_buf);
541 }
542
543 void
544 usage (int status)
545 {
546   if (status != 0)
547     fprintf (stderr, _("Try `%s --help' for more information.\n"),
548              program_name);
549   else
550     {
551       printf (_("Usage: %s [OPTION]... [ FILE | ARG1 ARG2 ]\n"), program_name);
552       fputs (_("\
553 \n\
554   -a, --all         same as -b -d --login -p -r -t -T -u\n\
555   -b, --boot        time of last system boot\n\
556   -d, --dead        print dead processes\n\
557   -H, --heading     print line of column headings\n\
558 "), stdout);
559       fputs (_("\
560   -i, --idle        add idle time as HOURS:MINUTES, . or old\n\
561                     (deprecated, use -u)\n\
562       --login       print system login processes\n\
563                     (equivalent to SUS -l)\n\
564 "), stdout);
565       fputs (_("\
566   -l, --lookup      attempt to canonicalize hostnames via DNS\n\
567                     (-l is deprecated, use --lookup)\n\
568   -m                only hostname and user associated with stdin\n\
569   -p, --process     print active processes spawned by init\n\
570 "), stdout);
571       fputs (_("\
572   -q, --count       all login names and number of users logged on\n\
573   -r, --runlevel    print current runlevel\n\
574   -s, --short       print only name, line, and time (default)\n\
575   -t, --time        print last system clock change\n\
576 "), stdout);
577       fputs (_("\
578   -T, -w, --mesg    add user's message status as +, - or ?\n\
579   -u, --users       lists users logged in\n\
580       --message     same as -T\n\
581       --writable    same as -T\n\
582 "), stdout);
583       fputs (HELP_OPTION_DESCRIPTION, stdout);
584       fputs (VERSION_OPTION_DESCRIPTION, stdout);
585       printf (_("\
586 \n\
587 If FILE is not specified, use %s.  %s as FILE is common.\n\
588 If ARG1 ARG2 given, -m presumed: `am i' or `mom likes' are usual.\n\
589 "), UTMP_FILE, WTMP_FILE);
590       puts (_("\nReport bugs to <bug-sh-utils@gnu.org>."));
591     }
592   exit (status);
593 }
594
595 int
596 main (int argc, char **argv)
597 {
598   int optc, longind;
599   int assumptions = 1;
600
601   program_name = argv[0];
602   setlocale (LC_ALL, "");
603   bindtextdomain (PACKAGE, LOCALEDIR);
604   textdomain (PACKAGE);
605
606   atexit (close_stdout);
607
608   while ((optc = getopt_long (argc, argv, "abdilmpqrstuwHT", longopts,
609                               &longind)) != -1)
610     {
611       switch (optc)
612         {
613         case 0:
614           break;
615
616         case 'a':
617           need_boottime = 1;
618           need_deadprocs = 1;
619           need_login = 1;
620           need_initspawn = 1;
621           need_runlevel = 1;
622           need_clockchange = 1;
623           need_users = 1;
624           include_mesg = 1;
625           include_idle = 1;
626           include_exit = 1;
627           assumptions = 0;
628           break;
629
630         case 'b':
631           need_boottime = 1;
632           assumptions = 0;
633           break;
634
635         case 'd':
636           need_deadprocs = 1;
637           include_idle = 1;
638           include_exit = 1;
639           assumptions = 0;
640           break;
641
642         case 'H':
643           include_heading = 1;
644           break;
645
646           /* FIXME: This should be -l in a future version */
647         case LOGIN_OPTION:
648           need_login = 1;
649           include_idle = 1;
650           assumptions = 0;
651           break;
652
653         case 'm':
654           my_line_only = 1;
655           break;
656
657         case 'p':
658           need_initspawn = 1;
659           assumptions = 0;
660           break;
661
662         case 'q':
663           short_list = 1;
664           break;
665
666         case 'r':
667           need_runlevel = 1;
668           include_idle = 1;
669           assumptions = 0;
670           break;
671
672         case 's':
673           short_output = 1;
674           break;
675
676         case 't':
677           need_clockchange = 1;
678           assumptions = 0;
679           break;
680
681         case 'T':
682         case 'w':
683           include_mesg = 1;
684           break;
685
686         case 'i':
687           error (0, 0,
688                  _("Warning: -i will be removed in a future release; \
689   use -u instead"));
690           /* Fall through.  */
691         case 'u':
692           need_users = 1;
693           include_idle = 1;
694           assumptions = 0;
695           break;
696
697         case 'l':
698           error (0, 0,
699                  _("Warning: the meaning of '-l' will change in a future\
700  release to conform to POSIX"));
701         case LOOKUP_OPTION:
702           do_lookup = 1;
703           break;
704
705           case_GETOPT_HELP_CHAR;
706
707           case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
708
709         default:
710           usage (1);
711         }
712     }
713
714   if (assumptions)
715     {
716       need_users = 1;
717       short_output = 1;
718     }
719
720   if (include_exit)
721     {
722       short_output = 0;
723     }
724
725   switch (argc - optind)
726     {
727     case 0:                     /* who */
728       who (UTMP_FILE);
729       break;
730
731     case 1:                     /* who <utmp file> */
732       who (argv[optind]);
733       break;
734
735     case 2:                     /* who <blurf> <glop> */
736       my_line_only = 1;
737       who (UTMP_FILE);
738       break;
739
740     default:                    /* lose */
741       error (0, 0, _("too many arguments"));
742       usage (1);
743     }
744
745   exit (0);
746 }