pax/gen_subs.c

   1 /*      $OpenBSD: gen_subs.c,v 1.19 2007/04/04 21:55:10 millert Exp $   */
   2 /*      $NetBSD: gen_subs.c,v 1.5 1995/03/21 09:07:26 cgd Exp $ */
   3
   4 /*-
   5  * Copyright (c) 1992 Keith Muller.
   6  * Copyright (c) 1992, 1993
   7  *      The Regents of the University of California.  All rights reserved.
   8  *
   9  * This code is derived from software contributed to Berkeley by
  10  * Keith Muller of the University of California, San Diego.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  */
  36
  37 #include <sys/cdefs.h>
  38 #ifndef lint
  39 #if 0
  40 static const char sccsid[] = "@(#)gen_subs.c    8.1 (Berkeley) 5/31/93";
  41 #else
  42 __used static const char rcsid[] = "$OpenBSD: gen_subs.c,v 1.19 2007/04/04 21:55:10 millert Exp $";
  43 #endif
  44 #endif /* not lint */
  45
  46 #include <sys/types.h>
  47 #include <sys/time.h>
  48 #include <sys/stat.h>
  49 #include <sys/param.h>
  50 #include <stdio.h>
  51 #include <tzfile.h>
  52 #include <unistd.h>
  53 #include <stdlib.h>
  54 #include <string.h>
  55 #include <vis.h>
  56 #include <langinfo.h>
  57 #include "pax.h"
  58 #include "extern.h"
  59
  60 /*
  61  * a collection of general purpose subroutines used by pax
  62  */
  63
  64 /*
  65  * constants used by ls_list() when printing out archive members
  66  */
  67 #define MODELEN 20
  68 #define DATELEN 64
  69 #define SIXMONTHS        ((DAYSPERNYEAR / 2) * SECSPERDAY)
  70 #define CURFRMTM        "%b %e %H:%M"
  71 #define OLDFRMTM        "%b %e  %Y"
  72 #define CURFRMTD        "%e %b %H:%M"
  73 #define OLDFRMTD        "%e %b  %Y"
  74 #define NAME_WIDTH      8
  75
  76 static int d_first = -1;
  77
  78 /*
  79  * ls_list()
  80  *      list the members of an archive in ls format
  81  */
  82
  83 void
  84 ls_list(ARCHD *arcn, time_t now, FILE *fp)
  85 {
  86         struct stat *sbp;
  87         char f_mode[MODELEN];
  88         char f_date[DATELEN];
  89         const char *timefrmt;
  90         int term;
  91
  92         term = zeroflag ? '\0' : '\n';  /* path termination character */
  93
  94         /*
  95          * if not verbose, just print the file name
  96          */
  97         if (!vflag) {
  98                 if (zeroflag)
  99                         (void)fputs(arcn->name, fp);
 100                 else
 101                         safe_print(arcn->name, fp);
 102                 (void)putc(term, fp);
 103                 (void)fflush(fp);
 104                 return;
 105         }
 106
 107         if (pax_list_opt_format) {
 108                 pax_format_list_output(arcn, now, fp, term);
 109                 return;
 110         }
 111
 112         if (d_first < 0)
 113                 d_first = (*nl_langinfo(D_MD_ORDER) == 'd');
 114         /*
 115          * user wants long mode
 116          */
 117         sbp = &(arcn->sb);
 118         strmode(sbp->st_mode, f_mode);
 119
 120         /*
 121          * time format based on age compared to the time pax was started.
 122          */
 123         if ((sbp->st_mtime + SIXMONTHS) <= now ||
 124                 sbp->st_mtime > now)
 125                 timefrmt = d_first ? OLDFRMTD : OLDFRMTM;
 126         else
 127                 timefrmt = d_first ? CURFRMTD : CURFRMTM;
 128
 129         /*
 130          * print file mode, link count, uid, gid and time
 131          */
 132         if (strftime(f_date,DATELEN,timefrmt,localtime(&(sbp->st_mtime))) == 0)
 133                 f_date[0] = '\0';
 134 #define UT_NAMESIZE 8
 135         (void)fprintf(fp, "%s%2u %-*.*s %-*.*s ", f_mode, sbp->st_nlink,
 136                 NAME_WIDTH, UT_NAMESIZE, name_uid(sbp->st_uid, 1),
 137                 NAME_WIDTH, UT_NAMESIZE, name_gid(sbp->st_gid, 1));
 138
 139         /*
 140          * print device id's for devices, or sizes for other nodes
 141          */
 142         if ((arcn->type == PAX_CHR) || (arcn->type == PAX_BLK))
 143 #               ifdef LONG_OFF_T
 144                 (void)fprintf(fp, "%4u,%4u ", MAJOR(sbp->st_rdev),
 145 #               else
 146                 (void)fprintf(fp, "%4lu,%4lu ", (unsigned long)MAJOR(sbp->st_rdev),
 147 #               endif
 148                     (unsigned long)MINOR(sbp->st_rdev));
 149         else {
 150 #               ifdef LONG_OFF_T
 151                 (void)fprintf(fp, "%9lu ", sbp->st_size);
 152 #               else
 153                 (void)fprintf(fp, "%9qu ", sbp->st_size);
 154 #               endif
 155         }
 156
 157         /*
 158          * print name and link info for hard and soft links
 159          */
 160         (void)fputs(f_date, fp);
 161         (void)putc(' ', fp);
 162         safe_print(arcn->name, fp);
 163         if ((arcn->type == PAX_HLK) || (arcn->type == PAX_HRG)) {
 164                 fputs(" == ", fp);
 165                 safe_print(arcn->ln_name, fp);
 166         } else if (arcn->type == PAX_SLK) {
 167                 fputs(" -> ", fp);
 168                 safe_print(arcn->ln_name, fp);
 169         }
 170         (void)putc(term, fp);
 171         (void)fflush(fp);
 172         return;
 173 }
 174
 175 /*
 176  * tty_ls()
 177  *      print a short summary of file to tty.
 178  */
 179
 180 void
 181 ls_tty(ARCHD *arcn)
 182 {
 183         char f_date[DATELEN];
 184         char f_mode[MODELEN];
 185         const char *timefrmt;
 186
 187         if (d_first < 0)
 188                 d_first = (*nl_langinfo(D_MD_ORDER) == 'd');
 189
 190         if ((arcn->sb.st_mtime + SIXMONTHS) <= time(NULL))
 191                 timefrmt = d_first ? OLDFRMTD : OLDFRMTM;
 192         else
 193                 timefrmt = d_first ? CURFRMTD : CURFRMTM;
 194
 195         /*
 196          * convert time to string, and print
 197          */
 198         if (strftime(f_date, DATELEN, timefrmt,
 199             localtime(&(arcn->sb.st_mtime))) == 0)
 200                 f_date[0] = '\0';
 201         strmode(arcn->sb.st_mode, f_mode);
 202         tty_prnt("%s%s %s\n", f_mode, f_date, arcn->name);
 203         return;
 204 }
 205
 206 void
 207 safe_print(const char *str, FILE *fp)
 208 {
 209         char visbuf[5];
 210         const char *cp;
 211
 212         /*
 213          * if printing to a tty, use vis(3) to print special characters.
 214          */
 215         if (isatty(fileno(fp))) {
 216                 for (cp = str; *cp; cp++) {
 217                         (void)vis(visbuf, cp[0], VIS_CSTYLE, cp[1]);
 218                         (void)fputs(visbuf, fp);
 219                 }
 220         } else {
 221                 (void)fputs(str, fp);
 222         }
 223 }
 224
 225 /*
 226  * asc_ul()
 227  *      convert hex/octal character string into a u_long. We do not have to
 228  *      check for overflow! (the headers in all supported formats are not large
 229  *      enough to create an overflow).
 230  *      NOTE: strings passed to us are NOT TERMINATED.
 231  * Return:
 232  *      unsigned long value
 233  */
 234
 235 u_long
 236 asc_ul(char *str, int len, int base)
 237 {
 238         char *stop;
 239         u_long tval = 0;
 240
 241         stop = str + len;
 242
 243         /*
 244          * skip over leading blanks and zeros
 245          */
 246         while ((str < stop) && ((*str == ' ') || (*str == '0')))
 247                 ++str;
 248
 249         /*
 250          * for each valid digit, shift running value (tval) over to next digit
 251          * and add next digit
 252          */
 253         if (base == HEX) {
 254                 while (str < stop) {
 255                         if ((*str >= '0') && (*str <= '9'))
 256                                 tval = (tval << 4) + (*str++ - '0');
 257                         else if ((*str >= 'A') && (*str <= 'F'))
 258                                 tval = (tval << 4) + 10 + (*str++ - 'A');
 259                         else if ((*str >= 'a') && (*str <= 'f'))
 260                                 tval = (tval << 4) + 10 + (*str++ - 'a');
 261                         else
 262                                 break;
 263                 }
 264         } else {
 265                 while ((str < stop) && (*str >= '0') && (*str <= '7'))
 266                         tval = (tval << 3) + (*str++ - '0');
 267         }
 268         return(tval);
 269 }
 270
 271 /*
 272  * ul_asc()
 273  *      convert an unsigned long into an hex/oct ascii string. pads with LEADING
 274  *      ascii 0's to fill string completely
 275  *      NOTE: the string created is NOT TERMINATED.
 276  */
 277
 278 int
 279 ul_asc(u_long val, char *str, int len, int base)
 280 {
 281         char *pt;
 282         u_long digit;
 283
 284         /*
 285          * WARNING str is not '\0' terminated by this routine
 286          */
 287         pt = str + len - 1;
 288
 289         /*
 290          * do a tailwise conversion (start at right most end of string to place
 291          * least significant digit). Keep shifting until conversion value goes
 292          * to zero (all digits were converted)
 293          */
 294         if (base == HEX) {
 295                 while (pt >= str) {
 296                         if ((digit = (val & 0xf)) < 10)
 297                                 *pt-- = '0' + (char)digit;
 298                         else
 299                                 *pt-- = 'a' + (char)(digit - 10);
 300                         if ((val = (val >> 4)) == (u_long)0)
 301                                 break;
 302                 }
 303         } else {
 304                 while (pt >= str) {
 305                         *pt-- = '0' + (char)(val & 0x7);
 306                         if ((val = (val >> 3)) == (u_long)0)
 307                                 break;
 308                 }
 309         }
 310
 311         /*
 312          * pad with leading ascii ZEROS. We return -1 if we ran out of space.
 313          */
 314         while (pt >= str)
 315                 *pt-- = '0';
 316         if (val != (u_long)0)
 317                 return(-1);
 318         return(0);
 319 }
 320
 321 #ifndef LONG_OFF_T
 322 /*
 323  * asc_uqd()
 324  *      convert hex/octal character string into a u_quad_t. We do not have to
 325  *      check for overflow! (the headers in all supported formats are not large
 326  *      enough to create an overflow).
 327  *      NOTE: strings passed to us are NOT TERMINATED.
 328  * Return:
 329  *      u_quad_t value
 330  */
 331
 332 u_quad_t
 333 asc_uqd(char *str, int len, int base)
 334 {
 335         char *stop;
 336         u_quad_t tval = 0;
 337
 338         stop = str + len;
 339
 340         /*
 341          * skip over leading blanks and zeros
 342          */
 343         while ((str < stop) && ((*str == ' ') || (*str == '0')))
 344                 ++str;
 345
 346         /*
 347          * for each valid digit, shift running value (tval) over to next digit
 348          * and add next digit
 349          */
 350         if (base == HEX) {
 351                 while (str < stop) {
 352                         if ((*str >= '0') && (*str <= '9'))
 353                                 tval = (tval << 4) + (*str++ - '0');
 354                         else if ((*str >= 'A') && (*str <= 'F'))
 355                                 tval = (tval << 4) + 10 + (*str++ - 'A');
 356                         else if ((*str >= 'a') && (*str <= 'f'))
 357                                 tval = (tval << 4) + 10 + (*str++ - 'a');
 358                         else
 359                                 break;
 360                 }
 361         } else {
 362                 while ((str < stop) && (*str >= '0') && (*str <= '7'))
 363                         tval = (tval << 3) + (*str++ - '0');
 364         }
 365         return(tval);
 366 }
 367
 368 /*
 369  * uqd_asc()
 370  *      convert an u_quad_t into a hex/oct ascii string. pads with LEADING
 371  *      ascii 0's to fill string completely
 372  *      NOTE: the string created is NOT TERMINATED.
 373  */
 374
 375 int
 376 uqd_asc(u_quad_t val, char *str, int len, int base)
 377 {
 378         char *pt;
 379         u_quad_t digit;
 380
 381         /*
 382          * WARNING str is not '\0' terminated by this routine
 383          */
 384         pt = str + len - 1;
 385
 386         /*
 387          * do a tailwise conversion (start at right most end of string to place
 388          * least significant digit). Keep shifting until conversion value goes
 389          * to zero (all digits were converted)
 390          */
 391         if (base == HEX) {
 392                 while (pt >= str) {
 393                         if ((digit = (val & 0xf)) < 10)
 394                                 *pt-- = '0' + (char)digit;
 395                         else
 396                                 *pt-- = 'a' + (char)(digit - 10);
 397                         if ((val = (val >> 4)) == (u_quad_t)0)
 398                                 break;
 399                 }
 400         } else {
 401                 while (pt >= str) {
 402                         *pt-- = '0' + (char)(val & 0x7);
 403                         if ((val = (val >> 3)) == (u_quad_t)0)
 404                                 break;
 405                 }
 406         }
 407
 408         /*
 409          * pad with leading ascii ZEROS. We return -1 if we ran out of space.
 410          */
 411         while (pt >= str)
 412                 *pt-- = '0';
 413         if (val != (u_quad_t)0)
 414                 return(-1);
 415         return(0);
 416 }
 417 #endif
 418
 419 /*
 420  * Copy at max min(bufz, fieldsz) chars from field to buf, stopping
 421  * at the first NUL char. NUL terminate buf if there is room left.
 422  */
 423 size_t
 424 fieldcpy(char *buf, size_t bufsz, const char *field, size_t fieldsz)
 425 {
 426         char *p = buf;
 427         const char *q = field;
 428         size_t i = 0;
 429
 430         if (fieldsz > bufsz)
 431                 fieldsz = bufsz;
 432         while (i < fieldsz && *q != '\0') {
 433                 *p++ = *q++;
 434                 i++;
 435         }
 436         if (i < bufsz)
 437                 *p = '\0';
 438         return(i);
 439 }