src/lib/print.c

   1 /*
   2  * print.c      Routines to print stuff.
   3  *
   4  * Version:     $Id$
   5  *
   6  *   This library is free software; you can redistribute it and/or
   7  *   modify it under the terms of the GNU Lesser General Public
   8  *   License as published by the Free Software Foundation; either
   9  *   version 2.1 of the License, or (at your option) any later version.
  10  *
  11  *   This library is distributed in the hope that it will be useful,
  12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14  *   Lesser General Public License for more details.
  15  *
  16  *   You should have received a copy of the GNU Lesser General Public
  17  *   License along with this library; if not, write to the Free Software
  18  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA
  19  *
  20  * Copyright 2000  The FreeRADIUS server project
  21  */
  22
  23 static const char rcsid[] = "$Id$";
  24
  25 #include        "autoconf.h"
  26
  27 #include        <stdio.h>
  28 #include        <stdlib.h>
  29 #include        <sys/types.h>
  30 #include        <ctype.h>
  31 #include        <string.h>
  32
  33 #include        "missing.h"
  34 #include        "libradius.h"
  35
  36 /*
  37  *      Convert a string to something printable.
  38  *      The output string has to be _at least_ 4x the size
  39  *      of the input string!
  40  */
  41 void librad_safeprint(char *in, int inlen, char *out, int outlen)
  42 {
  43         unsigned char   *str = (unsigned char *)in;
  44         int             done = 0;
  45         int             sp = 0;
  46
  47         if (inlen < 0) inlen = strlen(in);
  48
  49         while (inlen-- > 0 && (done + 3) < outlen) {
  50                 /*
  51                  *      Hack: never print trailing zero.
  52                  *      Some clients send strings with an off-by-one
  53                  *      length (confused with strings in C).
  54                  */
  55                 if (inlen == 0 && *str == 0)
  56                         break;
  57
  58                 sp = 0;
  59
  60                 switch (*str) {
  61                         case '\\':
  62                                 sp = '\\';
  63                                 break;
  64                         case '\r':
  65                                 sp = 'r';
  66                                 break;
  67                         case '\n':
  68                                 sp = 'n';
  69                                 break;
  70                         case '\t':
  71                                 sp = 't';
  72                                 break;
  73                         case '"':
  74                                 sp = '"';
  75                                 break;
  76                         default:
  77                           if (*str < 32 || (*str >= 128)){
  78                                         snprintf(out, outlen, "\\%03o", *str);
  79                                         done += 4;
  80                                         out  += 4;
  81                                         outlen -= 4;
  82                                 } else {
  83                                         *out++ = *str;
  84                                         outlen--;
  85                                         done++;
  86                                 }
  87                 }
  88                 if (sp) {
  89                         *out++ = '\\';
  90                         *out++ = sp;
  91                         outlen -= 2;
  92                         done += 2;
  93                 }
  94                 str++;
  95         }
  96         *out = 0;
  97 }
  98
  99
 100 /*
 101  *  Print one value into a string.
 102  *  delimitst will define if strings and dates will be delimited by '"'
 103  */
 104 int vp_prints_value(char * out, int outlen, VALUE_PAIR *vp, int delimitst)
 105 {
 106         DICT_VALUE  *v;
 107         char        buf[1024];
 108         const char  *a;
 109         time_t      t;
 110         struct tm   s_tm;
 111
 112         out[0] = 0;
 113         if (!vp) return 0;
 114
 115         switch (vp->type) {
 116                 case PW_TYPE_STRING:
 117                         if ((delimitst == 1) && vp->flags.has_tag) {
 118                                 /* Tagged attribute: print delimter and ignore tag */
 119                                 buf[0] = '"';
 120                                 librad_safeprint((char *)(vp->vp_strvalue),
 121                                                  vp->length, buf + 1, sizeof(buf) - 2);
 122                                 strcat(buf, "\"");
 123                         } else if (delimitst == 1) {
 124                                 /* Non-tagged attribute: print delimter */
 125                                 buf[0] = '"';
 126                                 librad_safeprint((char *)vp->vp_strvalue,
 127                                                  vp->length, buf + 1, sizeof(buf) - 2);
 128                                 strcat(buf, "\"");
 129
 130                         } else if (delimitst < 0) {
 131                                 strNcpy(out, vp->vp_strvalue, outlen);
 132                                 return strlen(out);
 133
 134                         } else {
 135                                 /* Non-tagged attribute: no delimiter */
 136                                 librad_safeprint((char *)vp->vp_strvalue,
 137                                                  vp->length, buf, sizeof(buf));
 138                         }
 139                         a = buf;
 140                         break;
 141                 case PW_TYPE_INTEGER:
 142                         if ( vp->flags.has_tag ) {
 143                                 /* Attribute value has a tag, need to ignore it */
 144                                 if ((v = dict_valbyattr(vp->attribute, (vp->lvalue & 0xffffff)))
 145                                     != NULL)
 146                                         a = v->name;
 147                                 else {
 148                                         snprintf(buf, sizeof(buf), "%u", (vp->lvalue & 0xffffff));
 149                                         a = buf;
 150                                 }
 151                         } else {
 152                                 /* Normal, non-tagged attribute */
 153                                 if ((v = dict_valbyattr(vp->attribute, vp->lvalue))
 154                                     != NULL)
 155                                         a = v->name;
 156                                 else {
 157                                         snprintf(buf, sizeof(buf), "%u", vp->lvalue);
 158                                         a = buf;
 159                                 }
 160                         }
 161                         break;
 162                 case PW_TYPE_DATE:
 163                         t = vp->lvalue;
 164                         if (delimitst) {
 165                           strftime(buf, sizeof(buf), "\"%b %e %Y %H:%M:%S %Z\"",
 166                                    localtime_r(&t, &s_tm));
 167                         } else {
 168                           strftime(buf, sizeof(buf), "%b %e %Y %H:%M:%S %Z",
 169                                    localtime_r(&t, &s_tm));
 170                         }
 171                         a = buf;
 172                         break;
 173                 case PW_TYPE_IPADDR:
 174                         a = inet_ntop(AF_INET, &(vp->lvalue),
 175                                       buf, sizeof(buf));
 176                         break;
 177                 case PW_TYPE_ABINARY:
 178 #ifdef ASCEND_BINARY
 179                         a = buf;
 180                         print_abinary(vp, (unsigned char *)buf, sizeof(buf));
 181                         break;
 182 #else
 183                   /* FALL THROUGH */
 184 #endif
 185                 case PW_TYPE_OCTETS:
 186                         if (outlen <= (2 * (vp->length + 1))) return 0;
 187
 188                         strcpy(buf, "0x");
 189
 190                         lrad_bin2hex(vp->vp_strvalue, buf + 2, vp->length);
 191                         a = buf;
 192                   break;
 193
 194                 case PW_TYPE_IFID:
 195                         a = ifid_ntoa(buf, sizeof(buf), vp->vp_strvalue);
 196                         break;
 197
 198                 case PW_TYPE_IPV6ADDR:
 199                         a = inet_ntop(AF_INET6,
 200                                       (const struct in6_addr *) vp->vp_strvalue,
 201                                       buf, sizeof(buf));
 202                         break;
 203
 204                 case PW_TYPE_IPV6PREFIX:
 205                 {
 206                         struct in6_addr addr;
 207
 208                         /*
 209                          *      Alignment issues.
 210                          */
 211                         memcpy(&addr, vp->vp_strvalue + 2, sizeof(addr));
 212
 213                         a = inet_ntop(AF_INET6, &addr, buf, sizeof(buf));
 214                         if (a) {
 215                                 char *p = buf + strlen(buf);
 216
 217                                 sprintf(p, "/%u", (unsigned int) vp->vp_strvalue[1]);
 218                         }
 219                 }
 220                         break;
 221
 222                 default:
 223                         a = 0;
 224                         break;
 225         }
 226         strNcpy(out, a?a:"UNKNOWN-TYPE", outlen);
 227
 228         return strlen(out);
 229 }
 230
 231 /*
 232  *  This is a hack, and has to be kept in sync with tokens.h
 233  */
 234 static const char *vp_tokens[] = {
 235   "?",                          /* T_OP_INVALID */
 236   "EOL",                        /* T_EOL */
 237   "{",
 238   "}",
 239   "(",
 240   ")",
 241   ",",
 242   ";",
 243   "+=",
 244   "-=",
 245   ":=",
 246   "=",
 247   "!=",
 248   ">=",
 249   ">",
 250   "<=",
 251   "<",
 252   "=~",
 253   "!~",
 254   "=*",
 255   "!*",
 256   "==",
 257   "#",
 258   "<BARE-WORD>",
 259   "<\"STRING\">",
 260   "<'STRING'>",
 261   "<`STRING`>"
 262 };
 263
 264
 265 /*
 266  *      Print one attribute and value into a string.
 267  */
 268 int vp_prints(char *out, int outlen, VALUE_PAIR *vp)
 269 {
 270         int             len;
 271         const char      *token = NULL;
 272
 273         out[0] = 0;
 274         if (!vp) return 0;
 275
 276         if (strlen(vp->name) + 3 > (size_t)outlen) {
 277                 return 0;
 278         }
 279
 280         if ((vp->operator > T_OP_INVALID) &&
 281             (vp->operator < T_TOKEN_LAST)) {
 282                 token = vp_tokens[vp->operator];
 283         } else {
 284                 token = "<INVALID-TOKEN>";
 285         }
 286
 287         if( vp->flags.has_tag ) {
 288
 289                 snprintf(out, outlen, "%s:%d %s ", vp->name, vp->flags.tag,
 290                          token);
 291
 292                 len = strlen(out);
 293                 vp_prints_value(out + len, outlen - len, vp, 1);
 294
 295         } else {
 296
 297                 snprintf(out, outlen, "%s %s ", vp->name, token);
 298                 len = strlen(out);
 299                 vp_prints_value(out + len, outlen - len, vp, 1);
 300
 301         }
 302
 303         return strlen(out);
 304 }
 305
 306
 307 /*
 308  *      Print one attribute and value.
 309  */
 310 void vp_print(FILE *fp, VALUE_PAIR *vp)
 311 {
 312         char    buf[1024];
 313
 314         vp_prints(buf, sizeof(buf), vp);
 315         fputs(buf, fp);
 316 }
 317
 318
 319 /*
 320  *      Print a whole list of attributes, indented by a TAB
 321  *      and with a newline at the end.
 322  */
 323 void vp_printlist(FILE *fp, VALUE_PAIR *vp)
 324 {
 325         for (; vp; vp = vp->next) {
 326                 fprintf(fp, "\t");
 327                 vp_print(fp, vp);
 328                 fprintf(fp, "\n");
 329         }
 330 }
 331