2 Copyright (C) 1992-2007 Free Software Foundation, Inc.
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)
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 Foundation,
16 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
18 /* Written by jla; revised by djm; revised again by mstone */
21 name [state] line time [activity] [pid] [comment] [exit]
23 name, line, time: not -q
31 #include <sys/types.h>
34 #include "canon-host.h"
37 #include "hard-locale.h"
41 /* The official name of this program (e.g., no `g' prefix). */
42 #define PROGRAM_NAME "who"
44 #define AUTHORS "Joseph Arceneaux", "David MacKenzie", "Michael Stone"
46 #ifndef MAXHOSTNAMELEN
47 # define MAXHOSTNAMELEN 64
51 # define UT_TYPE_RUN_LVL(U) UT_TYPE_EQ (U, RUN_LVL)
53 # define UT_TYPE_RUN_LVL(U) false
57 # define UT_TYPE_INIT_PROCESS(U) UT_TYPE_EQ (U, INIT_PROCESS)
59 # define UT_TYPE_INIT_PROCESS(U) false
63 # define UT_TYPE_LOGIN_PROCESS(U) UT_TYPE_EQ (U, LOGIN_PROCESS)
65 # define UT_TYPE_LOGIN_PROCESS(U) false
69 # define UT_TYPE_DEAD_PROCESS(U) UT_TYPE_EQ (U, DEAD_PROCESS)
71 # define UT_TYPE_DEAD_PROCESS(U) false
75 # define UT_TYPE_NEW_TIME(U) UT_TYPE_EQ (U, NEW_TIME)
77 # define UT_TYPE_NEW_TIME(U) false
82 #if HAVE_STRUCT_XTMP_UT_PID
83 # define PIDSTR_DECL_AND_INIT(Var, Utmp_ent) \
84 char Var[INT_STRLEN_BOUND (Utmp_ent->ut_pid) + 1]; \
85 sprintf (Var, "%ld", (long int) (Utmp_ent->ut_pid))
87 # define PIDSTR_DECL_AND_INIT(Var, Utmp_ent) \
91 #if HAVE_STRUCT_XTMP_UT_ID
92 # define UT_ID(U) ((U)->ut_id)
94 # define UT_ID(U) "??"
99 /* The name this program was run with. */
102 /* If true, attempt to canonicalize hostnames via a DNS lookup. */
103 static bool do_lookup;
105 /* If true, display only a list of usernames and count of
107 Ignored for `who am i'. */
108 static bool short_list;
110 /* If true, display only name, line, and time fields. */
111 static bool short_output;
113 /* If true, display the hours:minutes since each user has touched
114 the keyboard, or "." if within the last minute, or "old" if
115 not within the last day. */
116 static bool include_idle;
118 /* If true, display a line at the top describing each field. */
119 static bool include_heading;
121 /* If true, display a `+' for each user if mesg y, a `-' if mesg n,
122 or a `?' if their tty cannot be statted. */
123 static bool include_mesg;
125 /* If true, display process termination & exit status. */
126 static bool include_exit;
128 /* If true, display the last boot time. */
129 static bool need_boottime;
131 /* If true, display dead processes. */
132 static bool need_deadprocs;
134 /* If true, display processes waiting for user login. */
135 static bool need_login;
137 /* If true, display processes started by init. */
138 static bool need_initspawn;
140 /* If true, display the last clock change. */
141 static bool need_clockchange;
143 /* If true, display the current runlevel. */
144 static bool need_runlevel;
146 /* If true, display user processes. */
147 static bool need_users;
149 /* If true, display info only for the controlling tty. */
150 static bool my_line_only;
152 /* The strftime format to use for login times, and its expected
154 static char const *time_format;
155 static int time_format_width;
157 /* for long options with no corresponding short option, use enum */
160 LOOKUP_OPTION = CHAR_MAX + 1
163 static struct option const longopts[] = {
164 {"all", no_argument, NULL, 'a'},
165 {"boot", no_argument, NULL, 'b'},
166 {"count", no_argument, NULL, 'q'},
167 {"dead", no_argument, NULL, 'd'},
168 {"heading", no_argument, NULL, 'H'},
169 {"idle", no_argument, NULL, 'i'}, /* FIXME: deprecated: remove in late 2006 */
170 {"login", no_argument, NULL, 'l'},
171 {"lookup", no_argument, NULL, LOOKUP_OPTION},
172 {"message", no_argument, NULL, 'T'},
173 {"mesg", no_argument, NULL, 'T'},
174 {"process", no_argument, NULL, 'p'},
175 {"runlevel", no_argument, NULL, 'r'},
176 {"short", no_argument, NULL, 's'},
177 {"time", no_argument, NULL, 't'},
178 {"users", no_argument, NULL, 'u'},
179 {"writable", no_argument, NULL, 'T'},
180 {GETOPT_HELP_OPTION_DECL},
181 {GETOPT_VERSION_OPTION_DECL},
185 /* Return a string representing the time between WHEN and now.
186 BOOTTIME is the time of last reboot.
189 idle_string (time_t when, time_t boottime)
191 static time_t now = TYPE_MINIMUM (time_t);
193 if (now == TYPE_MINIMUM (time_t))
196 if (boottime < when && now - 24 * 60 * 60 < when && when <= now)
198 int seconds_idle = now - when;
199 if (seconds_idle < 60)
203 static char idle_hhmm[IDLESTR_LEN];
204 sprintf (idle_hhmm, "%02d:%02d",
205 seconds_idle / (60 * 60),
206 (seconds_idle % (60 * 60)) / 60);
214 /* Return a time string. */
216 time_string (const STRUCT_UTMP *utmp_ent)
218 static char buf[INT_STRLEN_BOUND (intmax_t) + sizeof "-%m-%d %H:%M"];
220 /* Don't take the address of UT_TIME_MEMBER directly.
221 Ulrich Drepper wrote:
222 ``... GNU libc (and perhaps other libcs as well) have extended
223 utmp file formats which do not use a simple time_t ut_time field.
224 In glibc, ut_time is a macro which selects for backward compatibility
225 the tv_sec member of a struct timeval value.'' */
226 time_t t = UT_TIME_MEMBER (utmp_ent);
227 struct tm *tmp = localtime (&t);
231 strftime (buf, sizeof buf, time_format, tmp);
235 return TYPE_SIGNED (time_t) ? imaxtostr (t, buf) : umaxtostr (t, buf);
238 /* Print formatted output line. Uses mostly arbitrary field sizes, probably
239 will need tweaking if any of the localization stuff is done, or for 64 bit
242 print_line (int userlen, const char *user, const char state,
243 int linelen, const char *line,
244 const char *time_str, const char *idle, const char *pid,
245 const char *comment, const char *exitstr)
247 static char mesg[3] = { ' ', 'x', '\0' };
249 char x_idle[1 + IDLESTR_LEN + 1];
250 char x_pid[1 + INT_STRLEN_BOUND (pid_t) + 1];
256 if (include_idle && !short_output && strlen (idle) < sizeof x_idle - 1)
257 sprintf (x_idle, " %-6s", idle);
261 if (!short_output && strlen (pid) < sizeof x_pid - 1)
262 sprintf (x_pid, " %10s", pid);
266 x_exitstr = xmalloc (include_exit ? 1 + MAX (12, strlen (exitstr)) + 1 : 1);
268 sprintf (x_exitstr, " %-12s", exitstr);
272 err = asprintf (&buf,
282 userlen, user ? user : " .",
283 include_mesg ? mesg : "",
289 /* FIXME: it's not really clear whether the following
290 field should be in the short_output. A strict reading
291 of SUSv2 would suggest not, but I haven't seen any
292 implementations that actually work that way... */
300 /* Remove any trailing spaces. */
301 char *p = buf + strlen (buf);
312 /* Send properly parsed USER_PROCESS info to print_line. The most
313 recent boot time is BOOTTIME. */
315 print_user (const STRUCT_UTMP *utmp_ent, time_t boottime)
320 char idlestr[IDLESTR_LEN + 1];
321 static char *hoststr;
323 static size_t hostlen;
326 #define DEV_DIR_WITH_TRAILING_SLASH "/dev/"
327 #define DEV_DIR_LEN (sizeof (DEV_DIR_WITH_TRAILING_SLASH) - 1)
329 char line[sizeof (utmp_ent->ut_line) + DEV_DIR_LEN + 1];
330 PIDSTR_DECL_AND_INIT (pidstr, utmp_ent);
332 /* Copy ut_line into LINE, prepending `/dev/' if ut_line is not
333 already an absolute file name. Some systems may put the full,
334 absolute file name in ut_line. */
335 if (utmp_ent->ut_line[0] == '/')
337 strncpy (line, utmp_ent->ut_line, sizeof (utmp_ent->ut_line));
338 line[sizeof (utmp_ent->ut_line)] = '\0';
342 strcpy (line, DEV_DIR_WITH_TRAILING_SLASH);
343 strncpy (line + DEV_DIR_LEN, utmp_ent->ut_line,
344 sizeof (utmp_ent->ut_line));
345 line[DEV_DIR_LEN + sizeof (utmp_ent->ut_line)] = '\0';
348 if (stat (line, &stats) == 0)
350 mesg = (stats.st_mode & S_IWGRP) ? '+' : '-';
351 last_change = stats.st_atime;
360 sprintf (idlestr, "%.*s", IDLESTR_LEN, idle_string (last_change, boottime));
362 sprintf (idlestr, " ?");
365 if (utmp_ent->ut_host[0])
367 char ut_host[sizeof (utmp_ent->ut_host) + 1];
369 char *display = NULL;
371 /* Copy the host name into UT_HOST, and ensure it's nul terminated. */
372 strncpy (ut_host, utmp_ent->ut_host, sizeof (utmp_ent->ut_host));
373 ut_host[sizeof (utmp_ent->ut_host)] = '\0';
375 /* Look for an X display. */
376 display = strchr (ut_host, ':');
380 if (*ut_host && do_lookup)
382 /* See if we can canonicalize it. */
383 host = canon_host (ut_host);
391 if (hostlen < strlen (host) + strlen (display) + 4)
393 hostlen = strlen (host) + strlen (display) + 4;
394 hoststr = xrealloc (hoststr, hostlen);
396 sprintf (hoststr, "(%s:%s)", host, display);
400 if (hostlen < strlen (host) + 3)
402 hostlen = strlen (host) + 3;
403 hoststr = xrealloc (hoststr, hostlen);
405 sprintf (hoststr, "(%s)", host);
416 hoststr = xrealloc (hoststr, hostlen);
422 print_line (sizeof UT_USER (utmp_ent), UT_USER (utmp_ent), mesg,
423 sizeof utmp_ent->ut_line, utmp_ent->ut_line,
424 time_string (utmp_ent), idlestr, pidstr,
425 hoststr ? hoststr : "", "");
429 print_boottime (const STRUCT_UTMP *utmp_ent)
431 print_line (-1, "", ' ', -1, "system boot",
432 time_string (utmp_ent), "", "", "", "");
436 make_id_equals_comment (STRUCT_UTMP const *utmp_ent)
438 char *comment = xmalloc (strlen (_("id=")) + sizeof UT_ID (utmp_ent) + 1);
440 strcpy (comment, _("id="));
441 strncat (comment, UT_ID (utmp_ent), sizeof UT_ID (utmp_ent));
446 print_deadprocs (const STRUCT_UTMP *utmp_ent)
448 static char *exitstr;
449 char *comment = make_id_equals_comment (utmp_ent);
450 PIDSTR_DECL_AND_INIT (pidstr, utmp_ent);
453 exitstr = xmalloc (strlen (_("term="))
454 + INT_STRLEN_BOUND (UT_EXIT_E_TERMINATION (utmp_ent)) + 1
455 + strlen (_("exit="))
456 + INT_STRLEN_BOUND (UT_EXIT_E_EXIT (utmp_ent))
458 sprintf (exitstr, "%s%d %s%d", _("term="), UT_EXIT_E_TERMINATION (utmp_ent),
459 _("exit="), UT_EXIT_E_EXIT (utmp_ent));
461 /* FIXME: add idle time? */
463 print_line (-1, "", ' ', sizeof utmp_ent->ut_line, utmp_ent->ut_line,
464 time_string (utmp_ent), "", pidstr, comment, exitstr);
469 print_login (const STRUCT_UTMP *utmp_ent)
471 char *comment = make_id_equals_comment (utmp_ent);
472 PIDSTR_DECL_AND_INIT (pidstr, utmp_ent);
474 /* FIXME: add idle time? */
476 print_line (-1, "LOGIN", ' ', sizeof utmp_ent->ut_line, utmp_ent->ut_line,
477 time_string (utmp_ent), "", pidstr, comment, "");
482 print_initspawn (const STRUCT_UTMP *utmp_ent)
484 char *comment = make_id_equals_comment (utmp_ent);
485 PIDSTR_DECL_AND_INIT (pidstr, utmp_ent);
487 print_line (-1, "", ' ', sizeof utmp_ent->ut_line, utmp_ent->ut_line,
488 time_string (utmp_ent), "", pidstr, comment, "");
493 print_clockchange (const STRUCT_UTMP *utmp_ent)
495 /* FIXME: handle NEW_TIME & OLD_TIME both */
496 print_line (-1, "", ' ', -1, _("clock change"),
497 time_string (utmp_ent), "", "", "", "");
501 print_runlevel (const STRUCT_UTMP *utmp_ent)
503 static char *runlevline, *comment;
504 unsigned char last = UT_PID (utmp_ent) / 256;
505 unsigned char curr = UT_PID (utmp_ent) % 256;
508 runlevline = xmalloc (strlen (_("run-level")) + 3);
509 sprintf (runlevline, "%s %c", _("run-level"), curr);
512 comment = xmalloc (strlen (_("last=")) + 2);
513 sprintf (comment, "%s%c", _("last="), (last == 'N') ? 'S' : last);
515 print_line (-1, "", ' ', -1, runlevline, time_string (utmp_ent),
516 "", "", comment, "");
521 /* Print the username of each valid entry and the number of valid entries
522 in UTMP_BUF, which should have N elements. */
524 list_entries_who (size_t n, const STRUCT_UTMP *utmp_buf)
526 unsigned long int entries = 0;
527 char const *separator = "";
531 if (IS_USER_PROCESS (utmp_buf))
535 trimmed_name = extract_trimmed_name (utmp_buf);
537 printf ("%s%s", separator, trimmed_name);
544 printf (_("\n# users=%lu\n"), entries);
550 print_line (-1, _("NAME"), ' ', -1, _("LINE"), _("TIME"), _("IDLE"),
551 _("PID"), _("COMMENT"), _("EXIT"));
554 /* Display UTMP_BUF, which should have N entries. */
556 scan_entries (size_t n, const STRUCT_UTMP *utmp_buf)
558 char *ttyname_b IF_LINT ( = NULL);
559 time_t boottime = TYPE_MINIMUM (time_t);
566 ttyname_b = ttyname (STDIN_FILENO);
569 if (strncmp (ttyname_b, DEV_DIR_WITH_TRAILING_SLASH, DEV_DIR_LEN) == 0)
570 ttyname_b += DEV_DIR_LEN; /* Discard /dev/ prefix. */
576 strncmp (ttyname_b, utmp_buf->ut_line,
577 sizeof (utmp_buf->ut_line)) == 0)
579 if (need_users && IS_USER_PROCESS (utmp_buf))
580 print_user (utmp_buf, boottime);
581 else if (need_runlevel && UT_TYPE_RUN_LVL (utmp_buf))
582 print_runlevel (utmp_buf);
583 else if (need_boottime && UT_TYPE_BOOT_TIME (utmp_buf))
584 print_boottime (utmp_buf);
585 /* I've never seen one of these, so I don't know what it should
587 FIXME: handle OLD_TIME also, perhaps show the delta? */
588 else if (need_clockchange && UT_TYPE_NEW_TIME (utmp_buf))
589 print_clockchange (utmp_buf);
590 else if (need_initspawn && UT_TYPE_INIT_PROCESS (utmp_buf))
591 print_initspawn (utmp_buf);
592 else if (need_login && UT_TYPE_LOGIN_PROCESS (utmp_buf))
593 print_login (utmp_buf);
594 else if (need_deadprocs && UT_TYPE_DEAD_PROCESS (utmp_buf))
595 print_deadprocs (utmp_buf);
598 if (UT_TYPE_BOOT_TIME (utmp_buf))
599 boottime = UT_TIME_MEMBER (utmp_buf);
605 /* Display a list of who is on the system, according to utmp file FILENAME.
606 Use read_utmp OPTIONS to read the file. */
608 who (const char *filename, int options)
611 STRUCT_UTMP *utmp_buf;
613 if (read_utmp (filename, &n_users, &utmp_buf, options) != 0)
614 error (EXIT_FAILURE, errno, "%s", filename);
617 list_entries_who (n_users, utmp_buf);
619 scan_entries (n_users, utmp_buf);
627 if (status != EXIT_SUCCESS)
628 fprintf (stderr, _("Try `%s --help' for more information.\n"),
632 printf (_("Usage: %s [OPTION]... [ FILE | ARG1 ARG2 ]\n"), program_name);
635 -a, --all same as -b -d --login -p -r -t -T -u\n\
636 -b, --boot time of last system boot\n\
637 -d, --dead print dead processes\n\
638 -H, --heading print line of column headings\n\
641 -l, --login print system login processes\n\
644 --lookup attempt to canonicalize hostnames via DNS\n\
645 -m only hostname and user associated with stdin\n\
646 -p, --process print active processes spawned by init\n\
649 -q, --count all login names and number of users logged on\n\
650 -r, --runlevel print current runlevel\n\
651 -s, --short print only name, line, and time (default)\n\
652 -t, --time print last system clock change\n\
655 -T, -w, --mesg add user's message status as +, - or ?\n\
656 -u, --users list users logged in\n\
657 --message same as -T\n\
658 --writable same as -T\n\
660 fputs (HELP_OPTION_DESCRIPTION, stdout);
661 fputs (VERSION_OPTION_DESCRIPTION, stdout);
664 If FILE is not specified, use %s. %s as FILE is common.\n\
665 If ARG1 ARG2 given, -m presumed: `am i' or `mom likes' are usual.\n\
666 "), UTMP_FILE, WTMP_FILE);
667 emit_bug_reporting_address ();
673 main (int argc, char **argv)
676 bool assumptions = true;
678 initialize_main (&argc, &argv);
679 program_name = argv[0];
680 setlocale (LC_ALL, "");
681 bindtextdomain (PACKAGE, LOCALEDIR);
682 textdomain (PACKAGE);
684 atexit (close_stdout);
686 while ((optc = getopt_long (argc, argv, "abdilmpqrstuwHT", longopts, NULL))
692 need_boottime = true;
693 need_deadprocs = true;
695 need_initspawn = true;
696 need_runlevel = true;
697 need_clockchange = true;
706 need_boottime = true;
711 need_deadprocs = true;
718 include_heading = true;
732 need_initspawn = true;
741 need_runlevel = true;
751 need_clockchange = true;
762 _("Warning: -i will be removed in a future release; \
775 case_GETOPT_HELP_CHAR;
777 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
780 usage (EXIT_FAILURE);
792 short_output = false;
795 if (hard_locale (LC_TIME))
797 time_format = "%Y-%m-%d %H:%M";
798 time_format_width = 4 + 1 + 2 + 1 + 2 + 1 + 2 + 1 + 2;
802 time_format = "%b %e %H:%M";
803 time_format_width = 3 + 1 + 2 + 1 + 2 + 1 + 2;
806 switch (argc - optind)
808 case 2: /* who <blurf> <glop> */
813 who (UTMP_FILE, READ_UTMP_CHECK_PIDS);
816 case 1: /* who <utmp file> */
817 who (argv[optind], 0);
821 error (0, 0, _("extra operand %s"), quote (argv[optind + 2]));
822 usage (EXIT_FAILURE);