2 Copyright (C) 1992-2017 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 3 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, see <http://www.gnu.org/licenses/>. */
17 /* Written by jla; revised by djm; revised again by mstone */
20 name [state] line time [activity] [pid] [comment] [exit]
22 name, line, time: not -q
31 #include <sys/types.h>
35 #include "canon-host.h"
39 #include "hard-locale.h"
46 /* The official name of this program (e.g., no 'g' prefix). */
47 #define PROGRAM_NAME "who"
50 proper_name ("Joseph Arceneaux"), \
51 proper_name ("David MacKenzie"), \
52 proper_name ("Michael Stone")
55 # define UT_TYPE_RUN_LVL(U) UT_TYPE_EQ (U, RUN_LVL)
57 # define UT_TYPE_RUN_LVL(U) false
61 # define UT_TYPE_INIT_PROCESS(U) UT_TYPE_EQ (U, INIT_PROCESS)
63 # define UT_TYPE_INIT_PROCESS(U) false
67 # define UT_TYPE_LOGIN_PROCESS(U) UT_TYPE_EQ (U, LOGIN_PROCESS)
69 # define UT_TYPE_LOGIN_PROCESS(U) false
73 # define UT_TYPE_DEAD_PROCESS(U) UT_TYPE_EQ (U, DEAD_PROCESS)
75 # define UT_TYPE_DEAD_PROCESS(U) false
79 # define UT_TYPE_NEW_TIME(U) UT_TYPE_EQ (U, NEW_TIME)
81 # define UT_TYPE_NEW_TIME(U) false
86 #if HAVE_STRUCT_XTMP_UT_PID
87 # define PIDSTR_DECL_AND_INIT(Var, Utmp_ent) \
88 char Var[INT_STRLEN_BOUND (Utmp_ent->ut_pid) + 1]; \
89 sprintf (Var, "%ld", (long int) (Utmp_ent->ut_pid))
91 # define PIDSTR_DECL_AND_INIT(Var, Utmp_ent) \
95 #if HAVE_STRUCT_XTMP_UT_ID
96 # define UT_ID(U) ((U)->ut_id)
98 # define UT_ID(U) "??"
101 /* If true, attempt to canonicalize hostnames via a DNS lookup. */
102 static bool do_lookup
;
104 /* If true, display only a list of usernames and count of
106 Ignored for 'who am i'. */
107 static bool short_list
;
109 /* If true, display only name, line, and time fields. */
110 static bool short_output
;
112 /* If true, display the hours:minutes since each user has touched
113 the keyboard, or "." if within the last minute, or "old" if
114 not within the last day. */
115 static bool include_idle
;
117 /* If true, display a line at the top describing each field. */
118 static bool include_heading
;
120 /* If true, display a '+' for each user if mesg y, a '-' if mesg n,
121 or a '?' if their tty cannot be statted. */
122 static bool include_mesg
;
124 /* If true, display process termination & exit status. */
125 static bool include_exit
;
127 /* If true, display the last boot time. */
128 static bool need_boottime
;
130 /* If true, display dead processes. */
131 static bool need_deadprocs
;
133 /* If true, display processes waiting for user login. */
134 static bool need_login
;
136 /* If true, display processes started by init. */
137 static bool need_initspawn
;
139 /* If true, display the last clock change. */
140 static bool need_clockchange
;
142 /* If true, display the current runlevel. */
143 static bool need_runlevel
;
145 /* If true, display user processes. */
146 static bool need_users
;
148 /* If true, display info only for the controlling tty. */
149 static bool my_line_only
;
151 /* The strftime format to use for login times, and its expected
153 static char const *time_format
;
154 static int time_format_width
;
156 /* for long options with no corresponding short option, use enum */
159 LOOKUP_OPTION
= CHAR_MAX
+ 1
162 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 {"login", no_argument
, NULL
, 'l'},
170 {"lookup", no_argument
, NULL
, LOOKUP_OPTION
},
171 {"message", no_argument
, NULL
, 'T'},
172 {"mesg", no_argument
, NULL
, 'T'},
173 {"process", no_argument
, NULL
, 'p'},
174 {"runlevel", no_argument
, NULL
, 'r'},
175 {"short", no_argument
, NULL
, 's'},
176 {"time", no_argument
, NULL
, 't'},
177 {"users", no_argument
, NULL
, 'u'},
178 {"writable", no_argument
, NULL
, 'T'},
179 {GETOPT_HELP_OPTION_DECL
},
180 {GETOPT_VERSION_OPTION_DECL
},
184 /* Return a string representing the time between WHEN and now.
185 BOOTTIME is the time of last reboot.
188 idle_string (time_t when
, time_t boottime
)
190 static time_t now
= TYPE_MINIMUM (time_t);
192 if (now
== TYPE_MINIMUM (time_t))
195 if (boottime
< when
&& now
- 24 * 60 * 60 < when
&& when
<= now
)
197 int seconds_idle
= now
- when
;
198 if (seconds_idle
< 60)
202 static char idle_hhmm
[IDLESTR_LEN
];
203 /* FIXME-in-2018: see if this assert is still required in order
204 to suppress gcc's unwarranted -Wformat-length= warning. */
205 assert (seconds_idle
/ (60 * 60) < 24);
206 sprintf (idle_hhmm
, "%02d:%02d",
207 seconds_idle
/ (60 * 60),
208 (seconds_idle
% (60 * 60)) / 60);
216 /* Return a time string. */
218 time_string (const STRUCT_UTMP
*utmp_ent
)
220 static char buf
[INT_STRLEN_BOUND (intmax_t) + sizeof "-%m-%d %H:%M"];
222 /* Don't take the address of UT_TIME_MEMBER directly.
223 Ulrich Drepper wrote:
224 "... GNU libc (and perhaps other libcs as well) have extended
225 utmp file formats which do not use a simple time_t ut_time field.
226 In glibc, ut_time is a macro which selects for backward compatibility
227 the tv_sec member of a struct timeval value." */
228 time_t t
= UT_TIME_MEMBER (utmp_ent
);
229 struct tm
*tmp
= localtime (&t
);
233 strftime (buf
, sizeof buf
, time_format
, tmp
);
237 return timetostr (t
, buf
);
240 /* Print formatted output line. Uses mostly arbitrary field sizes, probably
241 will need tweaking if any of the localization stuff is done, or for 64 bit
244 print_line (int userlen
, const char *user
, const char state
,
245 int linelen
, const char *line
,
246 const char *time_str
, const char *idle
, const char *pid
,
247 const char *comment
, const char *exitstr
)
249 static char mesg
[3] = { ' ', 'x', '\0' };
251 char x_idle
[1 + IDLESTR_LEN
+ 1];
252 char x_pid
[1 + INT_STRLEN_BOUND (pid_t
) + 1];
258 if (include_idle
&& !short_output
&& strlen (idle
) < sizeof x_idle
- 1)
259 sprintf (x_idle
, " %-6s", idle
);
263 if (!short_output
&& strlen (pid
) < sizeof x_pid
- 1)
264 sprintf (x_pid
, " %10s", pid
);
268 x_exitstr
= xmalloc (include_exit
? 1 + MAX (12, strlen (exitstr
)) + 1 : 1);
270 sprintf (x_exitstr
, " %-12s", exitstr
);
274 err
= asprintf (&buf
,
284 userlen
, user
? user
: " .",
285 include_mesg
? mesg
: "",
291 /* FIXME: it's not really clear whether the following
292 field should be in the short_output. A strict reading
293 of SUSv2 would suggest not, but I haven't seen any
294 implementations that actually work that way... */
302 /* Remove any trailing spaces. */
303 char *p
= buf
+ strlen (buf
);
314 /* Return true if a terminal device given as PSTAT allows other users
315 to send messages to; false otherwise */
317 is_tty_writable (struct stat
const *pstat
)
319 #ifdef TTY_GROUP_NAME
320 /* Ensure the group of the TTY device matches TTY_GROUP_NAME, more info at
321 https://bugzilla.redhat.com/454261 */
322 struct group
*ttygr
= getgrnam (TTY_GROUP_NAME
);
323 if (!ttygr
|| (pstat
->st_gid
!= ttygr
->gr_gid
))
327 return pstat
->st_mode
& S_IWGRP
;
330 /* Send properly parsed USER_PROCESS info to print_line. The most
331 recent boot time is BOOTTIME. */
333 print_user (const STRUCT_UTMP
*utmp_ent
, time_t boottime
)
338 char idlestr
[IDLESTR_LEN
+ 1];
339 static char *hoststr
;
341 static size_t hostlen
;
344 #define DEV_DIR_WITH_TRAILING_SLASH "/dev/"
345 #define DEV_DIR_LEN (sizeof (DEV_DIR_WITH_TRAILING_SLASH) - 1)
347 char line
[sizeof (utmp_ent
->ut_line
) + DEV_DIR_LEN
+ 1];
349 PIDSTR_DECL_AND_INIT (pidstr
, utmp_ent
);
351 /* Copy ut_line into LINE, prepending '/dev/' if ut_line is not
352 already an absolute file name. Some systems may put the full,
353 absolute file name in ut_line. */
354 if ( ! IS_ABSOLUTE_FILE_NAME (utmp_ent
->ut_line
))
355 p
= stpcpy (p
, DEV_DIR_WITH_TRAILING_SLASH
);
356 stzncpy (p
, utmp_ent
->ut_line
, sizeof (utmp_ent
->ut_line
));
358 if (stat (line
, &stats
) == 0)
360 mesg
= is_tty_writable (&stats
) ? '+' : '-';
361 last_change
= stats
.st_atime
;
370 sprintf (idlestr
, "%.*s", IDLESTR_LEN
, idle_string (last_change
, boottime
));
372 sprintf (idlestr
, " ?");
375 if (utmp_ent
->ut_host
[0])
377 char ut_host
[sizeof (utmp_ent
->ut_host
) + 1];
379 char *display
= NULL
;
381 /* Copy the host name into UT_HOST, and ensure it's nul terminated. */
382 stzncpy (ut_host
, utmp_ent
->ut_host
, sizeof (utmp_ent
->ut_host
));
384 /* Look for an X display. */
385 display
= strchr (ut_host
, ':');
389 if (*ut_host
&& do_lookup
)
391 /* See if we can canonicalize it. */
392 host
= canon_host (ut_host
);
400 if (hostlen
< strlen (host
) + strlen (display
) + 4)
402 hostlen
= strlen (host
) + strlen (display
) + 4;
404 hoststr
= xmalloc (hostlen
);
406 sprintf (hoststr
, "(%s:%s)", host
, display
);
410 if (hostlen
< strlen (host
) + 3)
412 hostlen
= strlen (host
) + 3;
414 hoststr
= xmalloc (hostlen
);
416 sprintf (hoststr
, "(%s)", host
);
428 hoststr
= xmalloc (hostlen
);
434 print_line (sizeof UT_USER (utmp_ent
), UT_USER (utmp_ent
), mesg
,
435 sizeof utmp_ent
->ut_line
, utmp_ent
->ut_line
,
436 time_string (utmp_ent
), idlestr
, pidstr
,
437 hoststr
? hoststr
: "", "");
441 print_boottime (const STRUCT_UTMP
*utmp_ent
)
443 print_line (-1, "", ' ', -1, _("system boot"),
444 time_string (utmp_ent
), "", "", "", "");
448 make_id_equals_comment (STRUCT_UTMP
const *utmp_ent
)
450 char *comment
= xmalloc (strlen (_("id=")) + sizeof UT_ID (utmp_ent
) + 1);
452 strcpy (comment
, _("id="));
453 strncat (comment
, UT_ID (utmp_ent
), sizeof UT_ID (utmp_ent
));
458 print_deadprocs (const STRUCT_UTMP
*utmp_ent
)
460 static char *exitstr
;
461 char *comment
= make_id_equals_comment (utmp_ent
);
462 PIDSTR_DECL_AND_INIT (pidstr
, utmp_ent
);
465 exitstr
= xmalloc (strlen (_("term="))
466 + INT_STRLEN_BOUND (UT_EXIT_E_TERMINATION (utmp_ent
)) + 1
467 + strlen (_("exit="))
468 + INT_STRLEN_BOUND (UT_EXIT_E_EXIT (utmp_ent
))
470 sprintf (exitstr
, "%s%d %s%d", _("term="), UT_EXIT_E_TERMINATION (utmp_ent
),
471 _("exit="), UT_EXIT_E_EXIT (utmp_ent
));
473 /* FIXME: add idle time? */
475 print_line (-1, "", ' ', sizeof utmp_ent
->ut_line
, utmp_ent
->ut_line
,
476 time_string (utmp_ent
), "", pidstr
, comment
, exitstr
);
481 print_login (const STRUCT_UTMP
*utmp_ent
)
483 char *comment
= make_id_equals_comment (utmp_ent
);
484 PIDSTR_DECL_AND_INIT (pidstr
, utmp_ent
);
486 /* FIXME: add idle time? */
488 print_line (-1, _("LOGIN"), ' ', sizeof utmp_ent
->ut_line
, utmp_ent
->ut_line
,
489 time_string (utmp_ent
), "", pidstr
, comment
, "");
494 print_initspawn (const STRUCT_UTMP
*utmp_ent
)
496 char *comment
= make_id_equals_comment (utmp_ent
);
497 PIDSTR_DECL_AND_INIT (pidstr
, utmp_ent
);
499 print_line (-1, "", ' ', sizeof utmp_ent
->ut_line
, utmp_ent
->ut_line
,
500 time_string (utmp_ent
), "", pidstr
, comment
, "");
505 print_clockchange (const STRUCT_UTMP
*utmp_ent
)
507 /* FIXME: handle NEW_TIME & OLD_TIME both */
508 print_line (-1, "", ' ', -1, _("clock change"),
509 time_string (utmp_ent
), "", "", "", "");
513 print_runlevel (const STRUCT_UTMP
*utmp_ent
)
515 static char *runlevline
, *comment
;
516 unsigned char last
= UT_PID (utmp_ent
) / 256;
517 unsigned char curr
= UT_PID (utmp_ent
) % 256;
520 runlevline
= xmalloc (strlen (_("run-level")) + 3);
521 sprintf (runlevline
, "%s %c", _("run-level"), curr
);
524 comment
= xmalloc (strlen (_("last=")) + 2);
525 sprintf (comment
, "%s%c", _("last="), (last
== 'N') ? 'S' : last
);
527 print_line (-1, "", ' ', -1, runlevline
, time_string (utmp_ent
),
528 "", "", c_isprint (last
) ? comment
: "", "");
533 /* Print the username of each valid entry and the number of valid entries
534 in UTMP_BUF, which should have N elements. */
536 list_entries_who (size_t n
, const STRUCT_UTMP
*utmp_buf
)
538 unsigned long int entries
= 0;
539 char const *separator
= "";
543 if (IS_USER_PROCESS (utmp_buf
))
547 trimmed_name
= extract_trimmed_name (utmp_buf
);
549 printf ("%s%s", separator
, trimmed_name
);
556 printf (_("\n# users=%lu\n"), entries
);
562 print_line (-1, _("NAME"), ' ', -1, _("LINE"), _("TIME"), _("IDLE"),
563 _("PID"), _("COMMENT"), _("EXIT"));
566 /* Display UTMP_BUF, which should have N entries. */
568 scan_entries (size_t n
, const STRUCT_UTMP
*utmp_buf
)
570 char *ttyname_b
IF_LINT ( = NULL
);
571 time_t boottime
= TYPE_MINIMUM (time_t);
578 ttyname_b
= ttyname (STDIN_FILENO
);
581 if (STRNCMP_LIT (ttyname_b
, DEV_DIR_WITH_TRAILING_SLASH
) == 0)
582 ttyname_b
+= DEV_DIR_LEN
; /* Discard /dev/ prefix. */
588 || STREQ_LEN (ttyname_b
, utmp_buf
->ut_line
,
589 sizeof (utmp_buf
->ut_line
)))
591 if (need_users
&& IS_USER_PROCESS (utmp_buf
))
592 print_user (utmp_buf
, boottime
);
593 else if (need_runlevel
&& UT_TYPE_RUN_LVL (utmp_buf
))
594 print_runlevel (utmp_buf
);
595 else if (need_boottime
&& UT_TYPE_BOOT_TIME (utmp_buf
))
596 print_boottime (utmp_buf
);
597 /* I've never seen one of these, so I don't know what it should
599 FIXME: handle OLD_TIME also, perhaps show the delta? */
600 else if (need_clockchange
&& UT_TYPE_NEW_TIME (utmp_buf
))
601 print_clockchange (utmp_buf
);
602 else if (need_initspawn
&& UT_TYPE_INIT_PROCESS (utmp_buf
))
603 print_initspawn (utmp_buf
);
604 else if (need_login
&& UT_TYPE_LOGIN_PROCESS (utmp_buf
))
605 print_login (utmp_buf
);
606 else if (need_deadprocs
&& UT_TYPE_DEAD_PROCESS (utmp_buf
))
607 print_deadprocs (utmp_buf
);
610 if (UT_TYPE_BOOT_TIME (utmp_buf
))
611 boottime
= UT_TIME_MEMBER (utmp_buf
);
617 /* Display a list of who is on the system, according to utmp file FILENAME.
618 Use read_utmp OPTIONS to read the file. */
620 who (const char *filename
, int options
)
623 STRUCT_UTMP
*utmp_buf
;
625 if (read_utmp (filename
, &n_users
, &utmp_buf
, options
) != 0)
626 die (EXIT_FAILURE
, errno
, "%s", quotef (filename
));
629 list_entries_who (n_users
, utmp_buf
);
631 scan_entries (n_users
, utmp_buf
);
639 if (status
!= EXIT_SUCCESS
)
643 printf (_("Usage: %s [OPTION]... [ FILE | ARG1 ARG2 ]\n"), program_name
);
645 Print information about users who are currently logged in.\n\
649 -a, --all same as -b -d --login -p -r -t -T -u\n\
650 -b, --boot time of last system boot\n\
651 -d, --dead print dead processes\n\
652 -H, --heading print line of column headings\n\
655 -l, --login print system login processes\n\
658 --lookup attempt to canonicalize hostnames via DNS\n\
659 -m only hostname and user associated with stdin\n\
660 -p, --process print active processes spawned by init\n\
663 -q, --count all login names and number of users logged on\n\
664 -r, --runlevel print current runlevel\n\
665 -s, --short print only name, line, and time (default)\n\
666 -t, --time print last system clock change\n\
669 -T, -w, --mesg add user's message status as +, - or ?\n\
670 -u, --users list users logged in\n\
671 --message same as -T\n\
672 --writable same as -T\n\
674 fputs (HELP_OPTION_DESCRIPTION
, stdout
);
675 fputs (VERSION_OPTION_DESCRIPTION
, stdout
);
678 If FILE is not specified, use %s. %s as FILE is common.\n\
679 If ARG1 ARG2 given, -m presumed: 'am i' or 'mom likes' are usual.\n\
680 "), UTMP_FILE
, WTMP_FILE
);
681 emit_ancillary_info (PROGRAM_NAME
);
687 main (int argc
, char **argv
)
690 bool assumptions
= true;
692 initialize_main (&argc
, &argv
);
693 set_program_name (argv
[0]);
694 setlocale (LC_ALL
, "");
695 bindtextdomain (PACKAGE
, LOCALEDIR
);
696 textdomain (PACKAGE
);
698 atexit (close_stdout
);
700 while ((optc
= getopt_long (argc
, argv
, "abdlmpqrstuwHT", longopts
, NULL
))
706 need_boottime
= true;
707 need_deadprocs
= true;
709 need_initspawn
= true;
710 need_runlevel
= true;
711 need_clockchange
= true;
720 need_boottime
= true;
725 need_deadprocs
= true;
732 include_heading
= true;
746 need_initspawn
= true;
755 need_runlevel
= true;
765 need_clockchange
= true;
784 case_GETOPT_HELP_CHAR
;
786 case_GETOPT_VERSION_CHAR (PROGRAM_NAME
, AUTHORS
);
789 usage (EXIT_FAILURE
);
801 short_output
= false;
804 if (hard_locale (LC_TIME
))
806 time_format
= "%Y-%m-%d %H:%M";
807 time_format_width
= 4 + 1 + 2 + 1 + 2 + 1 + 2 + 1 + 2;
811 time_format
= "%b %e %H:%M";
812 time_format_width
= 3 + 1 + 2 + 1 + 2 + 1 + 2;
815 switch (argc
- optind
)
817 case 2: /* who <blurf> <glop> */
822 who (UTMP_FILE
, READ_UTMP_CHECK_PIDS
);
825 case 1: /* who <utmp file> */
826 who (argv
[optind
], 0);
830 error (0, 0, _("extra operand %s"), quote (argv
[optind
+ 2]));
831 usage (EXIT_FAILURE
);