lib/readutmp.c

   1 /* GNU's read utmp module.
   2    Copyright (C) 1992-2001, 2003, 2004, 2005 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 /* Written by jla; revised by djm */
  19
  20 #include <config.h>
  21
  22 #include "readutmp.h"
  23
  24 #include <errno.h>
  25 #include <stdio.h>
  26
  27 #include <sys/types.h>
  28 #include <sys/stat.h>
  29 #include <signal.h>
  30 #include <stdbool.h>
  31 #include <string.h>
  32 #include <stdlib.h>
  33
  34 #include "xalloc.h"
  35
  36 #if USE_UNLOCKED_IO
  37 # include "unlocked-io.h"
  38 #endif
  39
  40 #ifndef SIZE_MAX
  41 # define SIZE_MAX ((size_t) -1)
  42 #endif
  43
  44 /* Copy UT->ut_name into storage obtained from malloc.  Then remove any
  45    trailing spaces from the copy, NUL terminate it, and return the copy.  */
  46
  47 char *
  48 extract_trimmed_name (const STRUCT_UTMP *ut)
  49 {
  50   char *p, *trimmed_name;
  51
  52   trimmed_name = xmalloc (sizeof (UT_USER (ut)) + 1);
  53   strncpy (trimmed_name, UT_USER (ut), sizeof (UT_USER (ut)));
  54   /* Append a trailing NUL.  Some systems pad names shorter than the
  55      maximum with spaces, others pad with NULs.  Remove any trailing
  56      spaces.  */
  57   trimmed_name[sizeof (UT_USER (ut))] = '\0';
  58   for (p = trimmed_name + strlen (trimmed_name);
  59        trimmed_name < p && p[-1] == ' ';
  60        *--p = '\0')
  61     continue;
  62   return trimmed_name;
  63 }
  64
  65 /* Is the utmp entry U desired by the user who asked for OPTIONS?  */
  66
  67 static inline bool
  68 desirable_utmp_entry (STRUCT_UTMP const *u, int options)
  69 {
  70   return ! (options & READ_UTMP_CHECK_PIDS
  71             && IS_USER_PROCESS (u)
  72             && (UT_PID (u) <= 0
  73                 || (kill (UT_PID (u), 0) < 0 && errno == ESRCH)));
  74 }
  75
  76 /* Read the utmp entries corresponding to file FILE into freshly-
  77    malloc'd storage, set *UTMP_BUF to that pointer, set *N_ENTRIES to
  78    the number of entries, and return zero.  If there is any error,
  79    return -1, setting errno, and don't modify the parameters.
  80    If OPTIONS & READ_UTMP_CHECK_PIDS is nonzero, omit entries whose
  81    process-IDs do not currently exist.  */
  82
  83 #ifdef UTMP_NAME_FUNCTION
  84
  85 int
  86 read_utmp (char const *file, size_t *n_entries, STRUCT_UTMP **utmp_buf,
  87            int options)
  88 {
  89   size_t n_read = 0;
  90   size_t n_alloc = 0;
  91   STRUCT_UTMP *utmp = NULL;
  92   STRUCT_UTMP *u;
  93
  94   /* Ignore the return value for now.
  95      Solaris' utmpname returns 1 upon success -- which is contrary
  96      to what the GNU libc version does.  In addition, older GNU libc
  97      versions are actually void.   */
  98   UTMP_NAME_FUNCTION (file);
  99
 100   SET_UTMP_ENT ();
 101
 102   while ((u = GET_UTMP_ENT ()) != NULL)
 103     if (desirable_utmp_entry (u, options))
 104       {
 105         if (n_read == n_alloc)
 106           utmp = x2nrealloc (utmp, &n_alloc, sizeof *utmp);
 107
 108         utmp[n_read++] = *u;
 109       }
 110
 111   END_UTMP_ENT ();
 112
 113   *n_entries = n_read;
 114   *utmp_buf = utmp;
 115
 116   return 0;
 117 }
 118
 119 #else
 120
 121 int
 122 read_utmp (char const *file, size_t *n_entries, STRUCT_UTMP **utmp_buf,
 123            int options)
 124 {
 125   size_t n_read = 0;
 126   size_t n_alloc = 0;
 127   STRUCT_UTMP *utmp = NULL;
 128   int saved_errno;
 129   FILE *f = fopen (file, "r");
 130
 131   if (! f)
 132     return -1;
 133
 134   for (;;)
 135     {
 136       if (n_read == n_alloc)
 137         utmp = x2nrealloc (utmp, &n_alloc, sizeof *utmp);
 138       if (fread (&utmp[n_read], sizeof utmp[n_read], 1, f) == 0)
 139         break;
 140       n_read += desirable_utmp_entry (&utmp[n_read], options);
 141     }
 142
 143   saved_errno = ferror (f) ? errno : 0;
 144   if (fclose (f) != 0)
 145     saved_errno = errno;
 146   if (saved_errno != 0)
 147     {
 148       free (utmp);
 149       errno = saved_errno;
 150       return -1;
 151     }
 152
 153   *n_entries = n_read;
 154   *utmp_buf = utmp;
 155
 156   return 0;
 157 }
 158
 159 #endif