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 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
30 #include <sys/types.h>
33 #include "canon-host.h"
36 #include "hard-locale.h"
40 /* The official name of this program (e.g., no `g' prefix). */
41 #define PROGRAM_NAME "who"
43 #define AUTHORS "Joseph Arceneaux", "David MacKenzie", "Michael Stone"
45 #ifndef MAXHOSTNAMELEN
46 # define MAXHOSTNAMELEN 64
50 # define UT_TYPE_RUN_LVL(U) UT_TYPE_EQ (U, RUN_LVL)
52 # define UT_TYPE_RUN_LVL(U) false
56 # define UT_TYPE_INIT_PROCESS(U) UT_TYPE_EQ (U, INIT_PROCESS)
58 # define UT_TYPE_INIT_PROCESS(U) false
62 # define UT_TYPE_LOGIN_PROCESS(U) UT_TYPE_EQ (U, LOGIN_PROCESS)
64 # define UT_TYPE_LOGIN_PROCESS(U) false
68 # define UT_TYPE_DEAD_PROCESS(U) UT_TYPE_EQ (U, DEAD_PROCESS)
70 # define UT_TYPE_DEAD_PROCESS(U) false
74 # define UT_TYPE_NEW_TIME(U) UT_TYPE_EQ (U, NEW_TIME)
76 # define UT_TYPE_NEW_TIME(U) false
81 #if HAVE_STRUCT_XTMP_UT_PID
82 # define PIDSTR_DECL_AND_INIT(Var, Utmp_ent) \
83 char Var[INT_STRLEN_BOUND (Utmp_ent->ut_pid) + 1]; \
84 sprintf (Var, "%ld", (long int) (Utmp_ent->ut_pid))
86 # define PIDSTR_DECL_AND_INIT(Var, Utmp_ent) \
90 #if HAVE_STRUCT_XTMP_UT_ID
91 # define UT_ID(U) ((U)->ut_id)
93 # define UT_ID(U) "??"
98 /* The name this program was run with. */
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[] = {
163 {"all", no_argument, NULL, 'a'},
164 {"boot", no_argument, NULL, 'b'},
165 {"count", no_argument, NULL, 'q'},
166 {"dead", no_argument, NULL, 'd'},
167 {"heading", no_argument, NULL, 'H'},
168 {"login", no_argument, NULL, 'l'},
169 {"lookup", no_argument, NULL, LOOKUP_OPTION},
170 {"message", no_argument, NULL, 'T'},
171 {"mesg", no_argument, NULL, 'T'},
172 {"process", no_argument, NULL, 'p'},
173 {"runlevel", no_argument, NULL, 'r'},
174 {"short", no_argument, NULL, 's'},
175 {"time", no_argument, NULL, 't'},
176 {"users", no_argument, NULL, 'u'},
177 {"writable", no_argument, NULL, 'T'},
178 {GETOPT_HELP_OPTION_DECL},
179 {GETOPT_VERSION_OPTION_DECL},
183 /* Return a string representing the time between WHEN and now.
184 BOOTTIME is the time of last reboot.
187 idle_string (time_t when, time_t boottime)
189 static time_t now = TYPE_MINIMUM (time_t);
191 if (now == TYPE_MINIMUM (time_t))
194 if (boottime < when && now - 24 * 60 * 60 < when && when <= now)
196 int seconds_idle = now - when;
197 if (seconds_idle < 60)
201 static char idle_hhmm[IDLESTR_LEN];
202 sprintf (idle_hhmm, "%02d:%02d",
203 seconds_idle / (60 * 60),
204 (seconds_idle % (60 * 60)) / 60);
212 /* Return a time string. */
214 time_string (const STRUCT_UTMP *utmp_ent)
216 static char buf[INT_STRLEN_BOUND (intmax_t) + sizeof "-%m-%d %H:%M"];
218 /* Don't take the address of UT_TIME_MEMBER directly.
219 Ulrich Drepper wrote:
220 ``... GNU libc (and perhaps other libcs as well) have extended
221 utmp file formats which do not use a simple time_t ut_time field.
222 In glibc, ut_time is a macro which selects for backward compatibility
223 the tv_sec member of a struct timeval value.'' */
224 time_t t = UT_TIME_MEMBER (utmp_ent);
225 struct tm *tmp = localtime (&t);
229 strftime (buf, sizeof buf, time_format, tmp);
233 return TYPE_SIGNED (time_t) ? imaxtostr (t, buf) : umaxtostr (t, buf);
236 /* Print formatted output line. Uses mostly arbitrary field sizes, probably
237 will need tweaking if any of the localization stuff is done, or for 64 bit
240 print_line (int userlen, const char *user, const char state,
241 int linelen, const char *line,
242 const char *time_str, const char *idle, const char *pid,
243 const char *comment, const char *exitstr)
245 static char mesg[3] = { ' ', 'x', '\0' };
247 char x_idle[1 + IDLESTR_LEN + 1];
248 char x_pid[1 + INT_STRLEN_BOUND (pid_t) + 1];
254 if (include_idle && !short_output && strlen (idle) < sizeof x_idle - 1)
255 sprintf (x_idle, " %-6s", idle);
259 if (!short_output && strlen (pid) < sizeof x_pid - 1)
260 sprintf (x_pid, " %10s", pid);
264 x_exitstr = xmalloc (include_exit ? 1 + MAX (12, strlen (exitstr)) + 1 : 1);
266 sprintf (x_exitstr, " %-12s", exitstr);
270 err = asprintf (&buf,
280 userlen, user ? user : " .",
281 include_mesg ? mesg : "",
287 /* FIXME: it's not really clear whether the following
288 field should be in the short_output. A strict reading
289 of SUSv2 would suggest not, but I haven't seen any
290 implementations that actually work that way... */
298 /* Remove any trailing spaces. */
299 char *p = buf + strlen (buf);
310 /* Send properly parsed USER_PROCESS info to print_line. The most
311 recent boot time is BOOTTIME. */
313 print_user (const STRUCT_UTMP *utmp_ent, time_t boottime)
318 char idlestr[IDLESTR_LEN + 1];
319 static char *hoststr;
321 static size_t hostlen;
324 #define DEV_DIR_WITH_TRAILING_SLASH "/dev/"
325 #define DEV_DIR_LEN (sizeof (DEV_DIR_WITH_TRAILING_SLASH) - 1)
327 char line[sizeof (utmp_ent->ut_line) + DEV_DIR_LEN + 1];
328 PIDSTR_DECL_AND_INIT (pidstr, utmp_ent);
330 /* Copy ut_line into LINE, prepending `/dev/' if ut_line is not
331 already an absolute file name. Some systems may put the full,
332 absolute file name in ut_line. */
333 if (utmp_ent->ut_line[0] == '/')
335 strncpy (line, utmp_ent->ut_line, sizeof (utmp_ent->ut_line));
336 line[sizeof (utmp_ent->ut_line)] = '\0';
340 strcpy (line, DEV_DIR_WITH_TRAILING_SLASH);
341 strncpy (line + DEV_DIR_LEN, utmp_ent->ut_line,
342 sizeof (utmp_ent->ut_line));
343 line[DEV_DIR_LEN + sizeof (utmp_ent->ut_line)] = '\0';
346 if (stat (line, &stats) == 0)
348 mesg = (stats.st_mode & S_IWGRP) ? '+' : '-';
349 last_change = stats.st_atime;
358 sprintf (idlestr, "%.*s", IDLESTR_LEN, idle_string (last_change, boottime));
360 sprintf (idlestr, " ?");
363 if (utmp_ent->ut_host[0])
365 char ut_host[sizeof (utmp_ent->ut_host) + 1];
367 char *display = NULL;
369 /* Copy the host name into UT_HOST, and ensure it's nul terminated. */
370 strncpy (ut_host, utmp_ent->ut_host, sizeof (utmp_ent->ut_host));
371 ut_host[sizeof (utmp_ent->ut_host)] = '\0';
373 /* Look for an X display. */
374 display = strchr (ut_host, ':');
378 if (*ut_host && do_lookup)
380 /* See if we can canonicalize it. */
381 host = canon_host (ut_host);
389 if (hostlen < strlen (host) + strlen (display) + 4)
391 hostlen = strlen (host) + strlen (display) + 4;
392 hoststr = xrealloc (hoststr, hostlen);
394 sprintf (hoststr, "(%s:%s)", host, display);
398 if (hostlen < strlen (host) + 3)
400 hostlen = strlen (host) + 3;
401 hoststr = xrealloc (hoststr, hostlen);
403 sprintf (hoststr, "(%s)", host);
414 hoststr = xrealloc (hoststr, hostlen);
420 print_line (sizeof UT_USER (utmp_ent), UT_USER (utmp_ent), mesg,
421 sizeof utmp_ent->ut_line, utmp_ent->ut_line,
422 time_string (utmp_ent), idlestr, pidstr,
423 hoststr ? hoststr : "", "");
427 print_boottime (const STRUCT_UTMP *utmp_ent)
429 print_line (-1, "", ' ', -1, "system boot",
430 time_string (utmp_ent), "", "", "", "");
434 make_id_equals_comment (STRUCT_UTMP const *utmp_ent)
436 char *comment = xmalloc (strlen (_("id=")) + sizeof UT_ID (utmp_ent) + 1);
438 strcpy (comment, _("id="));
439 strncat (comment, UT_ID (utmp_ent), sizeof UT_ID (utmp_ent));
444 print_deadprocs (const STRUCT_UTMP *utmp_ent)
446 static char *exitstr;
447 char *comment = make_id_equals_comment (utmp_ent);
448 PIDSTR_DECL_AND_INIT (pidstr, utmp_ent);
451 exitstr = xmalloc (strlen (_("term="))
452 + INT_STRLEN_BOUND (UT_EXIT_E_TERMINATION (utmp_ent)) + 1
453 + strlen (_("exit="))
454 + INT_STRLEN_BOUND (UT_EXIT_E_EXIT (utmp_ent))
456 sprintf (exitstr, "%s%d %s%d", _("term="), UT_EXIT_E_TERMINATION (utmp_ent),
457 _("exit="), UT_EXIT_E_EXIT (utmp_ent));
459 /* FIXME: add idle time? */
461 print_line (-1, "", ' ', sizeof utmp_ent->ut_line, utmp_ent->ut_line,
462 time_string (utmp_ent), "", pidstr, comment, exitstr);
467 print_login (const STRUCT_UTMP *utmp_ent)
469 char *comment = make_id_equals_comment (utmp_ent);
470 PIDSTR_DECL_AND_INIT (pidstr, utmp_ent);
472 /* FIXME: add idle time? */
474 print_line (-1, "LOGIN", ' ', sizeof utmp_ent->ut_line, utmp_ent->ut_line,
475 time_string (utmp_ent), "", pidstr, comment, "");
480 print_initspawn (const STRUCT_UTMP *utmp_ent)
482 char *comment = make_id_equals_comment (utmp_ent);
483 PIDSTR_DECL_AND_INIT (pidstr, utmp_ent);
485 print_line (-1, "", ' ', sizeof utmp_ent->ut_line, utmp_ent->ut_line,
486 time_string (utmp_ent), "", pidstr, comment, "");
491 print_clockchange (const STRUCT_UTMP *utmp_ent)
493 /* FIXME: handle NEW_TIME & OLD_TIME both */
494 print_line (-1, "", ' ', -1, _("clock change"),
495 time_string (utmp_ent), "", "", "", "");
499 print_runlevel (const STRUCT_UTMP *utmp_ent)
501 static char *runlevline, *comment;
502 unsigned char last = UT_PID (utmp_ent) / 256;
503 unsigned char curr = UT_PID (utmp_ent) % 256;
506 runlevline = xmalloc (strlen (_("run-level")) + 3);
507 sprintf (runlevline, "%s %c", _("run-level"), curr);
510 comment = xmalloc (strlen (_("last=")) + 2);
511 sprintf (comment, "%s%c", _("last="), (last == 'N') ? 'S' : last);
513 print_line (-1, "", ' ', -1, runlevline, time_string (utmp_ent),
514 "", "", comment, "");
519 /* Print the username of each valid entry and the number of valid entries
520 in UTMP_BUF, which should have N elements. */
522 list_entries_who (size_t n, const STRUCT_UTMP *utmp_buf)
524 unsigned long int entries = 0;
525 char const *separator = "";
529 if (IS_USER_PROCESS (utmp_buf))
533 trimmed_name = extract_trimmed_name (utmp_buf);
535 printf ("%s%s", separator, trimmed_name);
542 printf (_("\n# users=%lu\n"), entries);
548 print_line (-1, _("NAME"), ' ', -1, _("LINE"), _("TIME"), _("IDLE"),
549 _("PID"), _("COMMENT"), _("EXIT"));
552 /* Display UTMP_BUF, which should have N entries. */
554 scan_entries (size_t n, const STRUCT_UTMP *utmp_buf)
556 char *ttyname_b IF_LINT ( = NULL);
557 time_t boottime = TYPE_MINIMUM (time_t);
564 ttyname_b = ttyname (STDIN_FILENO);
567 if (strncmp (ttyname_b, DEV_DIR_WITH_TRAILING_SLASH, DEV_DIR_LEN) == 0)
568 ttyname_b += DEV_DIR_LEN; /* Discard /dev/ prefix. */
574 strncmp (ttyname_b, utmp_buf->ut_line,
575 sizeof (utmp_buf->ut_line)) == 0)
577 if (need_users && IS_USER_PROCESS (utmp_buf))
578 print_user (utmp_buf, boottime);
579 else if (need_runlevel && UT_TYPE_RUN_LVL (utmp_buf))
580 print_runlevel (utmp_buf);
581 else if (need_boottime && UT_TYPE_BOOT_TIME (utmp_buf))
582 print_boottime (utmp_buf);
583 /* I've never seen one of these, so I don't know what it should
585 FIXME: handle OLD_TIME also, perhaps show the delta? */
586 else if (need_clockchange && UT_TYPE_NEW_TIME (utmp_buf))
587 print_clockchange (utmp_buf);
588 else if (need_initspawn && UT_TYPE_INIT_PROCESS (utmp_buf))
589 print_initspawn (utmp_buf);
590 else if (need_login && UT_TYPE_LOGIN_PROCESS (utmp_buf))
591 print_login (utmp_buf);
592 else if (need_deadprocs && UT_TYPE_DEAD_PROCESS (utmp_buf))
593 print_deadprocs (utmp_buf);
596 if (UT_TYPE_BOOT_TIME (utmp_buf))
597 boottime = UT_TIME_MEMBER (utmp_buf);
603 /* Display a list of who is on the system, according to utmp file FILENAME.
604 Use read_utmp OPTIONS to read the file. */
606 who (const char *filename, int options)
609 STRUCT_UTMP *utmp_buf;
611 if (read_utmp (filename, &n_users, &utmp_buf, options) != 0)
612 error (EXIT_FAILURE, errno, "%s", filename);
615 list_entries_who (n_users, utmp_buf);
617 scan_entries (n_users, utmp_buf);
625 if (status != EXIT_SUCCESS)
626 fprintf (stderr, _("Try `%s --help' for more information.\n"),
630 printf (_("Usage: %s [OPTION]... [ FILE | ARG1 ARG2 ]\n"), program_name);
633 -a, --all same as -b -d --login -p -r -t -T -u\n\
634 -b, --boot time of last system boot\n\
635 -d, --dead print dead processes\n\
636 -H, --heading print line of column headings\n\
639 -l, --login print system login processes\n\
642 --lookup attempt to canonicalize hostnames via DNS\n\
643 -m only hostname and user associated with stdin\n\
644 -p, --process print active processes spawned by init\n\
647 -q, --count all login names and number of users logged on\n\
648 -r, --runlevel print current runlevel\n\
649 -s, --short print only name, line, and time (default)\n\
650 -t, --time print last system clock change\n\
653 -T, -w, --mesg add user's message status as +, - or ?\n\
654 -u, --users list users logged in\n\
655 --message same as -T\n\
656 --writable same as -T\n\
658 fputs (HELP_OPTION_DESCRIPTION, stdout);
659 fputs (VERSION_OPTION_DESCRIPTION, stdout);
662 If FILE is not specified, use %s. %s as FILE is common.\n\
663 If ARG1 ARG2 given, -m presumed: `am i' or `mom likes' are usual.\n\
664 "), UTMP_FILE, WTMP_FILE);
665 emit_bug_reporting_address ();
671 main (int argc, char **argv)
674 bool assumptions = true;
676 initialize_main (&argc, &argv);
677 program_name = argv[0];
678 setlocale (LC_ALL, "");
679 bindtextdomain (PACKAGE, LOCALEDIR);
680 textdomain (PACKAGE);
682 atexit (close_stdout);
684 while ((optc = getopt_long (argc, argv, "abdlmpqrstuwHT", longopts, NULL))
690 need_boottime = true;
691 need_deadprocs = true;
693 need_initspawn = true;
694 need_runlevel = true;
695 need_clockchange = true;
704 need_boottime = true;
709 need_deadprocs = true;
716 include_heading = true;
730 need_initspawn = true;
739 need_runlevel = true;
749 need_clockchange = true;
768 case_GETOPT_HELP_CHAR;
770 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
773 usage (EXIT_FAILURE);
785 short_output = false;
788 if (hard_locale (LC_TIME))
790 time_format = "%Y-%m-%d %H:%M";
791 time_format_width = 4 + 1 + 2 + 1 + 2 + 1 + 2 + 1 + 2;
795 time_format = "%b %e %H:%M";
796 time_format_width = 3 + 1 + 2 + 1 + 2 + 1 + 2;
799 switch (argc - optind)
801 case 2: /* who <blurf> <glop> */
806 who (UTMP_FILE, READ_UTMP_CHECK_PIDS);
809 case 1: /* who <utmp file> */
810 who (argv[optind], 0);
814 error (0, 0, _("extra operand %s"), quote (argv[optind + 2]));
815 usage (EXIT_FAILURE);