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                 /*
 151                  * UNIX compliance fix: printing filename length for soft links
 152                  * from arcn->ln_nlen instead of sbp->st_size, which is 0.
 153                  */
 154                 off_t nlen;
 155                 if (arcn->type == PAX_SLK) {
 156                         nlen = arcn->ln_nlen;
 157                 } else {
 158                         nlen = sbp->st_size;
 159                 }
 160 #               ifdef LONG_OFF_T
 161                 (void)fprintf(fp, "%9lu ", nlen);
 162 #               else
 163                 (void)fprintf(fp, "%9qu ", nlen);
 164 #               endif
 165         }
 166
 167         /*
 168          * print name and link info for hard and soft links
 169          */
 170         (void)fputs(f_date, fp);
 171         (void)putc(' ', fp);
 172         safe_print(arcn->name, fp);
 173         if ((arcn->type == PAX_HLK) || (arcn->type == PAX_HRG)) {
 174                 fputs(" == ", fp);
 175                 safe_print(arcn->ln_name, fp);
 176         } else if (arcn->type == PAX_SLK) {
 177                 fputs(" -> ", fp);
 178                 safe_print(arcn->ln_name, fp);
 179         }
 180         (void)putc(term, fp);
 181         (void)fflush(fp);
 182         return;
 183 }
 184
 185 /*
 186  * tty_ls()
 187  *      print a short summary of file to tty.
 188  */
 189
 190 void
 191 ls_tty(ARCHD *arcn)
 192 {
 193         char f_date[DATELEN];
 194         char f_mode[MODELEN];
 195         const char *timefrmt;
 196
 197         if (d_first < 0)
 198                 d_first = (*nl_langinfo(D_MD_ORDER) == 'd');
 199
 200         if ((arcn->sb.st_mtime + SIXMONTHS) <= time(NULL))
 201                 timefrmt = d_first ? OLDFRMTD : OLDFRMTM;
 202         else
 203                 timefrmt = d_first ? CURFRMTD : CURFRMTM;
 204
 205         /*
 206          * convert time to string, and print
 207          */
 208         if (strftime(f_date, DATELEN, timefrmt,
 209             localtime(&(arcn->sb.st_mtime))) == 0)
 210                 f_date[0] = '\0';
 211         strmode(arcn->sb.st_mode, f_mode);
 212         tty_prnt("%s%s %s\n", f_mode, f_date, arcn->name);
 213         return;
 214 }
 215
 216 void
 217 safe_print(const char *str, FILE *fp)
 218 {
 219         char visbuf[5];
 220         const char *cp;
 221
 222         /*
 223          * if printing to a tty, use vis(3) to print special characters.
 224          */
 225         if (isatty(fileno(fp))) {
 226                 for (cp = str; *cp; cp++) {
 227                         (void)vis(visbuf, cp[0], VIS_CSTYLE, cp[1]);
 228                         (void)fputs(visbuf, fp);
 229                 }
 230         } else {
 231                 (void)fputs(str, fp);
 232         }
 233 }
 234
 235 /*
 236  * asc_ul()
 237  *      convert hex/octal character string into a u_long. We do not have to
 238  *      check for overflow! (the headers in all supported formats are not large
 239  *      enough to create an overflow).
 240  *      NOTE: strings passed to us are NOT TERMINATED.
 241  * Return:
 242  *      unsigned long value
 243  */
 244
 245 u_long
 246 asc_ul(char *str, int len, int base)
 247 {
 248         char *stop;
 249         u_long tval = 0;
 250
 251         stop = str + len;
 252
 253         /*
 254          * skip over leading blanks and zeros
 255          */
 256         while ((str < stop) && ((*str == ' ') || (*str == '0')))
 257                 ++str;
 258
 259         /*
 260          * for each valid digit, shift running value (tval) over to next digit
 261          * and add next digit
 262          */
 263         if (base == HEX) {
 264                 while (str < stop) {
 265                         if ((*str >= '0') && (*str <= '9'))
 266                                 tval = (tval << 4) + (*str++ - '0');
 267                         else if ((*str >= 'A') && (*str <= 'F'))
 268                                 tval = (tval << 4) + 10 + (*str++ - 'A');
 269                         else if ((*str >= 'a') && (*str <= 'f'))
 270                                 tval = (tval << 4) + 10 + (*str++ - 'a');
 271                         else
 272                                 break;
 273                 }
 274         } else {
 275                 while ((str < stop) && (*str >= '0') && (*str <= '7'))
 276                         tval = (tval << 3) + (*str++ - '0');
 277         }
 278         return(tval);
 279 }
 280
 281 /*
 282  * ul_asc()
 283  *      convert an unsigned long into an hex/oct ascii string. pads with LEADING
 284  *      ascii 0's to fill string completely
 285  *      NOTE: the string created is NOT TERMINATED.
 286  */
 287
 288 int
 289 ul_asc(u_long val, char *str, int len, int base)
 290 {
 291         char *pt;
 292         u_long digit;
 293
 294         /*
 295          * WARNING str is not '\0' terminated by this routine
 296          */
 297         pt = str + len - 1;
 298
 299         /*
 300          * do a tailwise conversion (start at right most end of string to place
 301          * least significant digit). Keep shifting until conversion value goes
 302          * to zero (all digits were converted)
 303          */
 304         if (base == HEX) {
 305                 while (pt >= str) {
 306                         if ((digit = (val & 0xf)) < 10)
 307                                 *pt-- = '0' + (char)digit;
 308                         else
 309                                 *pt-- = 'a' + (char)(digit - 10);
 310                         if ((val = (val >> 4)) == (u_long)0)
 311                                 break;
 312                 }
 313         } else {
 314                 while (pt >= str) {
 315                         *pt-- = '0' + (char)(val & 0x7);
 316                         if ((val = (val >> 3)) == (u_long)0)
 317                                 break;
 318                 }
 319         }
 320
 321         /*
 322          * pad with leading ascii ZEROS. We return -1 if we ran out of space.
 323          */
 324         while (pt >= str)
 325                 *pt-- = '0';
 326         if (val != (u_long)0)
 327                 return(-1);
 328         return(0);
 329 }
 330
 331 #ifndef LONG_OFF_T
 332 /*
 333  * asc_uqd()
 334  *      convert hex/octal character string into a u_quad_t. We do not have to
 335  *      check for overflow! (the headers in all supported formats are not large
 336  *      enough to create an overflow).
 337  *      NOTE: strings passed to us are NOT TERMINATED.
 338  * Return:
 339  *      u_quad_t value
 340  */
 341
 342 u_quad_t
 343 asc_uqd(char *str, int len, int base)
 344 {
 345         char *stop;
 346         u_quad_t tval = 0;
 347
 348         stop = str + len;
 349
 350         /*
 351          * skip over leading blanks and zeros
 352          */
 353         while ((str < stop) && ((*str == ' ') || (*str == '0')))
 354                 ++str;
 355
 356         /*
 357          * for each valid digit, shift running value (tval) over to next digit
 358          * and add next digit
 359          */
 360         if (base == HEX) {
 361                 while (str < stop) {
 362                         if ((*str >= '0') && (*str <= '9'))
 363                                 tval = (tval << 4) + (*str++ - '0');
 364                         else if ((*str >= 'A') && (*str <= 'F'))
 365                                 tval = (tval << 4) + 10 + (*str++ - 'A');
 366                         else if ((*str >= 'a') && (*str <= 'f'))
 367                                 tval = (tval << 4) + 10 + (*str++ - 'a');
 368                         else
 369                                 break;
 370                 }
 371         } else {
 372                 while ((str < stop) && (*str >= '0') && (*str <= '7'))
 373                         tval = (tval << 3) + (*str++ - '0');
 374         }
 375         return(tval);
 376 }
 377
 378 /*
 379  * uqd_asc()
 380  *      convert an u_quad_t into a hex/oct ascii string. pads with LEADING
 381  *      ascii 0's to fill string completely
 382  *      NOTE: the string created is NOT TERMINATED.
 383  */
 384
 385 int
 386 uqd_asc(u_quad_t val, char *str, int len, int base)
 387 {
 388         char *pt;
 389         u_quad_t digit;
 390
 391         /*
 392          * WARNING str is not '\0' terminated by this routine
 393          */
 394         pt = str + len - 1;
 395
 396         /*
 397          * do a tailwise conversion (start at right most end of string to place
 398          * least significant digit). Keep shifting until conversion value goes
 399          * to zero (all digits were converted)
 400          */
 401         if (base == HEX) {
 402                 while (pt >= str) {
 403                         if ((digit = (val & 0xf)) < 10)
 404                                 *pt-- = '0' + (char)digit;
 405                         else
 406                                 *pt-- = 'a' + (char)(digit - 10);
 407                         if ((val = (val >> 4)) == (u_quad_t)0)
 408                                 break;
 409                 }
 410         } else {
 411                 while (pt >= str) {
 412                         *pt-- = '0' + (char)(val & 0x7);
 413                         if ((val = (val >> 3)) == (u_quad_t)0)
 414                                 break;
 415                 }
 416         }
 417
 418         /*
 419          * pad with leading ascii ZEROS. We return -1 if we ran out of space.
 420          */
 421         while (pt >= str)
 422                 *pt-- = '0';
 423         if (val != (u_quad_t)0)
 424                 return(-1);
 425         return(0);
 426 }
 427 #endif
 428
 429 /*
 430  * Copy at max min(bufz, fieldsz) chars from field to buf, stopping
 431  * at the first NUL char. NUL terminate buf if there is room left.
 432  */
 433 size_t
 434 fieldcpy(char *buf, size_t bufsz, const char *field, size_t fieldsz)
 435 {
 436         char *p = buf;
 437         const char *q = field;
 438         size_t i = 0;
 439
 440         if (fieldsz > bufsz)
 441                 fieldsz = bufsz;
 442         while (i < fieldsz && *q != '\0') {
 443                 *p++ = *q++;
 444                 i++;
 445         }
 446         if (i < bufsz)
 447                 *p = '\0';
 448         return(i);
 449 }