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