src/pinky.c

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