src/pinky.c

   1 /* GNU's pinky.
   2    Copyright (C) 1992-2023 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 3 of the License, or
   7    (at your option) 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, see <https://www.gnu.org/licenses/>.  */
  16
  17 /* Created by hacking who.c by Kaveh Ghazi ghazi@caip.rutgers.edu */
  18
  19 #include <config.h>
  20 #include <getopt.h>
  21 #include <pwd.h>
  22 #include <stdckdint.h>
  23 #include <stdio.h>
  24
  25 #include <sys/types.h>
  26 #include "system.h"
  27
  28 #include "canon-host.h"
  29 #include "hard-locale.h"
  30 #include "readutmp.h"
  31
  32 /* The official name of this program (e.g., no 'g' prefix).  */
  33 #define PROGRAM_NAME "pinky"
  34
  35 #define AUTHORS \
  36   proper_name ("Joseph Arceneaux"), \
  37   proper_name ("David MacKenzie"), \
  38   proper_name ("Kaveh Ghazi")
  39
  40 /* If true, display the hours:minutes since each user has touched
  41    the keyboard, or blank if within the last minute, or days followed
  42    by a 'd' if not within the last day. */
  43 static bool include_idle = true;
  44
  45 /* If true, display a line at the top describing each field. */
  46 static bool include_heading = true;
  47
  48 /* if true, display the user's full name from pw_gecos. */
  49 static bool include_fullname = true;
  50
  51 /* if true, display the user's ~/.project file when doing long format. */
  52 static bool include_project = true;
  53
  54 /* if true, display the user's ~/.plan file when doing long format. */
  55 static bool include_plan = true;
  56
  57 /* if true, display the user's home directory and shell
  58    when doing long format. */
  59 static bool include_home_and_shell = true;
  60
  61 /* if true, use the "short" output format. */
  62 static bool do_short_format = true;
  63
  64 /* if true, display the ut_host field. */
  65 #if HAVE_STRUCT_XTMP_UT_HOST
  66 static bool include_where = true;
  67 #endif
  68
  69 /* The strftime format to use for login times, and its expected
  70    output width.  */
  71 static char const *time_format;
  72 static int time_format_width;
  73
  74 static struct option const longopts[] =
  75 {
  76   {GETOPT_HELP_OPTION_DECL},
  77   {GETOPT_VERSION_OPTION_DECL},
  78   {nullptr, 0, nullptr, 0}
  79 };
  80
  81 /* Count and return the number of ampersands in STR.  */
  82
  83 ATTRIBUTE_PURE
  84 static size_t
  85 count_ampersands (char const *str)
  86 {
  87   size_t count = 0;
  88   do
  89     {
  90       if (*str == '&')
  91         count++;
  92     } while (*str++);
  93   return count;
  94 }
  95
  96 /* Create a string (via xmalloc) which contains a full name by substituting
  97    for each ampersand in GECOS_NAME the USER_NAME string with its first
  98    character capitalized.  The caller must ensure that GECOS_NAME contains
  99    no ','s.  The caller also is responsible for free'ing the return value of
 100    this function.  */
 101
 102 static char *
 103 create_fullname (char const *gecos_name, char const *user_name)
 104 {
 105   size_t rsize = strlen (gecos_name) + 1;
 106   char *result;
 107   char *r;
 108   size_t ampersands = count_ampersands (gecos_name);
 109
 110   if (ampersands != 0)
 111     {
 112       size_t ulen = strlen (user_name);
 113       size_t product;
 114       if (ckd_mul (&product, ulen, ampersands - 1)
 115           || ckd_add (&rsize, rsize, product))
 116         xalloc_die ();
 117     }
 118
 119   r = result = xmalloc (rsize);
 120
 121   while (*gecos_name)
 122     {
 123       if (*gecos_name == '&')
 124         {
 125           char const *uname = user_name;
 126           if (islower (to_uchar (*uname)))
 127             *r++ = toupper (to_uchar (*uname++));
 128           while (*uname)
 129             *r++ = *uname++;
 130         }
 131       else
 132         {
 133           *r++ = *gecos_name;
 134         }
 135
 136       gecos_name++;
 137     }
 138   *r = 0;
 139
 140   return result;
 141 }
 142
 143 /* Return a string representing the time between WHEN and the time
 144    that this function is first run. */
 145
 146 static char const *
 147 idle_string (time_t when)
 148 {
 149   static time_t now = 0;
 150   static char buf[INT_STRLEN_BOUND (intmax_t) + sizeof "d"];
 151   time_t seconds_idle;
 152
 153   if (now == 0)
 154     time (&now);
 155
 156   seconds_idle = now - when;
 157   if (seconds_idle < 60)        /* One minute. */
 158     return "     ";
 159   if (seconds_idle < (24 * 60 * 60))    /* One day. */
 160     {
 161       int hours = seconds_idle / (60 * 60);
 162       int minutes = (seconds_idle % (60 * 60)) / 60;
 163       sprintf (buf, "%02d:%02d", hours, minutes);
 164     }
 165   else
 166     {
 167       intmax_t days = seconds_idle / (24 * 60 * 60);
 168       sprintf (buf, "%"PRIdMAX"d", days);
 169     }
 170   return buf;
 171 }
 172
 173 /* Return a time string.  */
 174 static char const *
 175 time_string (const STRUCT_UTMP *utmp_ent)
 176 {
 177   static char buf[INT_STRLEN_BOUND (intmax_t) + sizeof "-%m-%d %H:%M"];
 178
 179   /* Don't take the address of UT_TIME_MEMBER directly.
 180      Ulrich Drepper wrote:
 181      "... GNU libc (and perhaps other libcs as well) have extended
 182      utmp file formats which do not use a simple time_t ut_time field.
 183      In glibc, ut_time is a macro which selects for backward compatibility
 184      the tv_sec member of a struct timeval value."  */
 185   time_t t = UT_TIME_MEMBER (utmp_ent);
 186   struct tm *tmp = localtime (&t);
 187
 188   if (tmp)
 189     {
 190       strftime (buf, sizeof buf, time_format, tmp);
 191       return buf;
 192     }
 193   else
 194     return timetostr (t, buf);
 195 }
 196
 197 /* Display a line of information about UTMP_ENT. */
 198
 199 static void
 200 print_entry (const STRUCT_UTMP *utmp_ent)
 201 {
 202   struct stat stats;
 203   time_t last_change;
 204   char mesg;
 205
 206   /* If ut_line contains a space, the device name starts after the space.  */
 207   char *line = utmp_ent->ut_line;
 208   char *space = strchr (line, ' ');
 209   line = space ? space + 1 : line;
 210
 211   int dirfd;
 212   if (IS_ABSOLUTE_FILE_NAME (line))
 213     dirfd = AT_FDCWD;
 214   else
 215     {
 216       static int dev_dirfd;
 217       if (!dev_dirfd)
 218         {
 219           dev_dirfd = open ("/dev", O_PATHSEARCH | O_DIRECTORY);
 220           if (dev_dirfd < 0)
 221             dev_dirfd = AT_FDCWD - 1;
 222         }
 223       dirfd = dev_dirfd;
 224     }
 225
 226   if (AT_FDCWD <= dirfd && fstatat (dirfd, line, &stats, 0) == 0)
 227     {
 228       mesg = (stats.st_mode & S_IWGRP) ? ' ' : '*';
 229       last_change = stats.st_atime;
 230     }
 231   else
 232     {
 233       mesg = '?';
 234       last_change = 0;
 235     }
 236
 237   if (strnlen (UT_USER (utmp_ent), 8) < 8)
 238     printf ("%-8s", UT_USER (utmp_ent));
 239   else
 240     fputs (UT_USER (utmp_ent), stdout);
 241
 242   if (include_fullname)
 243     {
 244       char *name = UT_USER (utmp_ent);
 245       struct passwd *pw = getpwnam (name);
 246       if (pw == nullptr)
 247         /* TRANSLATORS: Real name is unknown; at most 19 characters. */
 248         printf (" %19s", _("        ???"));
 249       else
 250         {
 251           char *const comma = strchr (pw->pw_gecos, ',');
 252           char *result;
 253
 254           if (comma)
 255             *comma = '\0';
 256
 257           result = create_fullname (pw->pw_gecos, pw->pw_name);
 258           printf (" %-19.19s", result);
 259           free (result);
 260         }
 261     }
 262
 263   fputc (' ', stdout);
 264   fputc (mesg, stdout);
 265   if (strnlen (utmp_ent->ut_line, 8) < 8)
 266     printf ("%-8s", utmp_ent->ut_line);
 267   else
 268     fputs (utmp_ent->ut_line, stdout);
 269
 270   if (include_idle)
 271     {
 272       if (last_change)
 273         printf (" %-6s", idle_string (last_change));
 274       else
 275         /* TRANSLATORS: Idle time is unknown; at most 5 characters. */
 276         printf (" %-6s", _("?????"));
 277     }
 278
 279   printf (" %s", time_string (utmp_ent));
 280
 281 #ifdef HAVE_STRUCT_XTMP_UT_HOST
 282   if (include_where && utmp_ent->ut_host[0])
 283     {
 284       char *host = nullptr;
 285       char *display = nullptr;
 286       char *ut_host = utmp_ent->ut_host;
 287
 288       /* Look for an X display.  */
 289       display = strchr (ut_host, ':');
 290       if (display)
 291         *display++ = '\0';
 292
 293       if (*ut_host)
 294         /* See if we can canonicalize it.  */
 295         host = canon_host (ut_host);
 296       if ( ! host)
 297         host = ut_host;
 298
 299       fputc (' ', stdout);
 300       fputs (host, stdout);
 301       if (display)
 302         {
 303           fputc (':', stdout);
 304           fputs (display, stdout);
 305         }
 306
 307       if (host != ut_host)
 308         free (host);
 309     }
 310 #endif
 311
 312   putchar ('\n');
 313 }
 314
 315 /* Display a verbose line of information about UTMP_ENT. */
 316
 317 static void
 318 print_long_entry (const char name[])
 319 {
 320   struct passwd *pw;
 321
 322   pw = getpwnam (name);
 323
 324   printf (_("Login name: "));
 325   printf ("%-28s", name);
 326
 327   printf (_("In real life: "));
 328   if (pw == nullptr)
 329     {
 330       /* TRANSLATORS: Real name is unknown; no hard limit. */
 331       printf (" %s", _("???\n"));
 332       return;
 333     }
 334   else
 335     {
 336       char *const comma = strchr (pw->pw_gecos, ',');
 337       char *result;
 338
 339       if (comma)
 340         *comma = '\0';
 341
 342       result = create_fullname (pw->pw_gecos, pw->pw_name);
 343       printf (" %s", result);
 344       free (result);
 345     }
 346
 347   putchar ('\n');
 348
 349   if (include_home_and_shell)
 350     {
 351       printf (_("Directory: "));
 352       printf ("%-29s", pw->pw_dir);
 353       printf (_("Shell: "));
 354       printf (" %s", pw->pw_shell);
 355       putchar ('\n');
 356     }
 357
 358   if (include_project)
 359     {
 360       FILE *stream;
 361       char buf[1024];
 362       char const *const baseproject = "/.project";
 363       char *const project =
 364         xmalloc (strlen (pw->pw_dir) + strlen (baseproject) + 1);
 365       stpcpy (stpcpy (project, pw->pw_dir), baseproject);
 366
 367       stream = fopen (project, "r");
 368       if (stream)
 369         {
 370           size_t bytes;
 371
 372           printf (_("Project: "));
 373
 374           while ((bytes = fread (buf, 1, sizeof (buf), stream)) > 0)
 375             fwrite (buf, 1, bytes, stdout);
 376           fclose (stream);
 377         }
 378
 379       free (project);
 380     }
 381
 382   if (include_plan)
 383     {
 384       FILE *stream;
 385       char buf[1024];
 386       char const *const baseplan = "/.plan";
 387       char *const plan =
 388         xmalloc (strlen (pw->pw_dir) + strlen (baseplan) + 1);
 389       stpcpy (stpcpy (plan, pw->pw_dir), baseplan);
 390
 391       stream = fopen (plan, "r");
 392       if (stream)
 393         {
 394           size_t bytes;
 395
 396           printf (_("Plan:\n"));
 397
 398           while ((bytes = fread (buf, 1, sizeof (buf), stream)) > 0)
 399             fwrite (buf, 1, bytes, stdout);
 400           fclose (stream);
 401         }
 402
 403       free (plan);
 404     }
 405
 406   putchar ('\n');
 407 }
 408
 409 /* Print the username of each valid entry and the number of valid entries
 410    in UTMP_BUF, which should have N elements. */
 411
 412 static void
 413 print_heading (void)
 414 {
 415   printf ("%-8s", _("Login"));
 416   if (include_fullname)
 417     printf (" %-19s", _("Name"));
 418   printf (" %-9s", _(" TTY"));
 419   if (include_idle)
 420     printf (" %-6s", _("Idle"));
 421   printf (" %-*s", time_format_width, _("When"));
 422 #ifdef HAVE_STRUCT_XTMP_UT_HOST
 423   if (include_where)
 424     printf (" %s", _("Where"));
 425 #endif
 426   putchar ('\n');
 427 }
 428
 429 /* Display UTMP_BUF, which should have N entries. */
 430
 431 static void
 432 scan_entries (idx_t n, const STRUCT_UTMP *utmp_buf,
 433               const int argc_names, char *const argv_names[])
 434 {
 435   if (hard_locale (LC_TIME))
 436     {
 437       time_format = "%Y-%m-%d %H:%M";
 438       time_format_width = 4 + 1 + 2 + 1 + 2 + 1 + 2 + 1 + 2;
 439     }
 440   else
 441     {
 442       time_format = "%b %e %H:%M";
 443       time_format_width = 3 + 1 + 2 + 1 + 2 + 1 + 2;
 444     }
 445
 446   if (include_heading)
 447     print_heading ();
 448
 449   while (n--)
 450     {
 451       if (IS_USER_PROCESS (utmp_buf))
 452         {
 453           if (argc_names)
 454             {
 455               for (int i = 0; i < argc_names; i++)
 456                 if (STREQ (UT_USER (utmp_buf), argv_names[i]))
 457                   {
 458                     print_entry (utmp_buf);
 459                     break;
 460                   }
 461             }
 462           else
 463             print_entry (utmp_buf);
 464         }
 465       utmp_buf++;
 466     }
 467 }
 468
 469 /* Display a list of who is on the system, according to utmp file FILENAME. */
 470
 471 static void
 472 short_pinky (char const *filename,
 473              const int argc_names, char *const argv_names[])
 474 {
 475   idx_t n_users;
 476   STRUCT_UTMP *utmp_buf = nullptr;
 477
 478   if (read_utmp (filename, &n_users, &utmp_buf, 0) != 0)
 479     error (EXIT_FAILURE, errno, "%s", quotef (filename));
 480
 481   scan_entries (n_users, utmp_buf, argc_names, argv_names);
 482   exit (EXIT_SUCCESS);
 483 }
 484
 485 static void
 486 long_pinky (const int argc_names, char *const argv_names[])
 487 {
 488   for (int i = 0; i < argc_names; i++)
 489     print_long_entry (argv_names[i]);
 490 }
 491
 492 void
 493 usage (int status)
 494 {
 495   if (status != EXIT_SUCCESS)
 496     emit_try_help ();
 497   else
 498     {
 499       printf (_("Usage: %s [OPTION]... [USER]...\n"), program_name);
 500       fputs (_("\
 501 \n\
 502   -l              produce long format output for the specified USERs\n\
 503   -b              omit the user's home directory and shell in long format\n\
 504   -h              omit the user's project file in long format\n\
 505   -p              omit the user's plan file in long format\n\
 506   -s              do short format output, this is the default\n\
 507 "), stdout);
 508       fputs (_("\
 509   -f              omit the line of column headings in short format\n\
 510   -w              omit the user's full name in short format\n\
 511   -i              omit the user's full name and remote host in short format\n\
 512   -q              omit the user's full name, remote host and idle time\n\
 513                   in short format\n\
 514 "), stdout);
 515       fputs (HELP_OPTION_DESCRIPTION, stdout);
 516       fputs (VERSION_OPTION_DESCRIPTION, stdout);
 517       printf (_("\
 518 \n\
 519 A lightweight 'finger' program;  print user information.\n\
 520 The utmp file will be %s.\n\
 521 "), UTMP_FILE);
 522       emit_ancillary_info (PROGRAM_NAME);
 523     }
 524   exit (status);
 525 }
 526
 527 int
 528 main (int argc, char **argv)
 529 {
 530   int optc;
 531   int n_users;
 532
 533   initialize_main (&argc, &argv);
 534   set_program_name (argv[0]);
 535   setlocale (LC_ALL, "");
 536   bindtextdomain (PACKAGE, LOCALEDIR);
 537   textdomain (PACKAGE);
 538
 539   atexit (close_stdout);
 540
 541   while ((optc = getopt_long (argc, argv, "sfwiqbhlp", longopts, nullptr))
 542          != -1)
 543     {
 544       switch (optc)
 545         {
 546         case 's':
 547           do_short_format = true;
 548           break;
 549
 550         case 'l':
 551           do_short_format = false;
 552           break;
 553
 554         case 'f':
 555           include_heading = false;
 556           break;
 557
 558         case 'w':
 559           include_fullname = false;
 560           break;
 561
 562         case 'i':
 563           include_fullname = false;
 564 #ifdef HAVE_STRUCT_XTMP_UT_HOST
 565           include_where = false;
 566 #endif
 567           break;
 568
 569         case 'q':
 570           include_fullname = false;
 571 #ifdef HAVE_STRUCT_XTMP_UT_HOST
 572           include_where = false;
 573 #endif
 574           include_idle = false;
 575           break;
 576
 577         case 'h':
 578           include_project = false;
 579           break;
 580
 581         case 'p':
 582           include_plan = false;
 583           break;
 584
 585         case 'b':
 586           include_home_and_shell = false;
 587           break;
 588
 589         case_GETOPT_HELP_CHAR;
 590
 591         case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
 592
 593         default:
 594           usage (EXIT_FAILURE);
 595         }
 596     }
 597
 598   n_users = argc - optind;
 599
 600   if (!do_short_format && n_users == 0)
 601     {
 602       error (0, 0, _("no username specified; at least one must be\
 603  specified when using -l"));
 604       usage (EXIT_FAILURE);
 605     }
 606
 607   if (do_short_format)
 608     short_pinky (UTMP_FILE, n_users, argv + optind);
 609   else
 610     long_pinky (n_users, argv + optind);
 611
 612   return EXIT_SUCCESS;
 613 }