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->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->strvalue,
 127                                                  vp->length, buf + 1, sizeof(buf) - 2);
 128                                 strcat(buf, "\"");
 129
 130                         } else if (delimitst < 0) {
 131                                 strNcpy(out, vp->strvalue, outlen);
 132                                 return strlen(out);
 133
 134                         } else {
 135                                 /* Non-tagged attribute: no delimiter */
 136                                 librad_safeprint((char *)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                         if (vp->strvalue[0])
 175                                 a = (char *)vp->strvalue;
 176                         else
 177                                 a = inet_ntop(AF_INET, &(vp->lvalue),
 178                                               buf, sizeof(buf));
 179                         break;
 180                 case PW_TYPE_ABINARY:
 181 #ifdef ASCEND_BINARY
 182                         a = buf;
 183                         print_abinary(vp, (unsigned char *)buf, sizeof(buf));
 184                         break;
 185 #else
 186                   /* FALL THROUGH */
 187 #endif
 188                 case PW_TYPE_OCTETS:
 189                         if (outlen <= (2 * (vp->length + 1))) return 0;
 190
 191                         strcpy(buf, "0x");
 192
 193                         lrad_bin2hex(vp->strvalue, buf + 2, vp->length);
 194                         a = buf;
 195                   break;
 196
 197                 case PW_TYPE_IFID:
 198                         a = ifid_ntoa(buf, sizeof(buf), vp->strvalue);
 199                         break;
 200
 201                 case PW_TYPE_IPV6ADDR:
 202                         a = inet_ntop(AF_INET6,
 203                                       (const struct in6_addr *) vp->strvalue,
 204                                       buf, sizeof(buf));
 205                         break;
 206
 207                 case PW_TYPE_IPV6PREFIX:
 208                 {
 209                         struct in6_addr addr;
 210
 211                         /*
 212                          *      Alignment issues.
 213                          */
 214                         memcpy(&addr, vp->strvalue + 2, sizeof(addr));
 215
 216                         a = inet_ntop(AF_INET6, &addr, buf, sizeof(buf));
 217                         if (a) {
 218                                 char *p = buf + strlen(buf);
 219
 220                                 sprintf(p, "/%u", (unsigned int) vp->strvalue[1]);
 221                         }
 222                 }
 223                         break;
 224
 225                 default:
 226                         a = 0;
 227                         break;
 228         }
 229         strNcpy(out, a?a:"UNKNOWN-TYPE", outlen);
 230
 231         return strlen(out);
 232 }
 233
 234 /*
 235  *  This is a hack, and has to be kept in sync with tokens.h
 236  */
 237 static const char *vp_tokens[] = {
 238   "?",                          /* T_OP_INVALID */
 239   "EOL",                        /* T_EOL */
 240   "{",
 241   "}",
 242   "(",
 243   ")",
 244   ",",
 245   ";",
 246   "+=",
 247   "-=",
 248   ":=",
 249   "=",
 250   "!=",
 251   ">=",
 252   ">",
 253   "<=",
 254   "<",
 255   "=~",
 256   "!~",
 257   "=*",
 258   "!*",
 259   "==",
 260   "#",
 261   "<BARE-WORD>",
 262   "<\"STRING\">",
 263   "<'STRING'>",
 264   "<`STRING`>"
 265 };
 266
 267
 268 /*
 269  *      Print one attribute and value into a string.
 270  */
 271 int vp_prints(char *out, int outlen, VALUE_PAIR *vp)
 272 {
 273         int             len;
 274         const char      *token = NULL;
 275
 276         out[0] = 0;
 277         if (!vp) return 0;
 278
 279         if (strlen(vp->name) + 3 > (size_t)outlen) {
 280                 return 0;
 281         }
 282
 283         if ((vp->operator > T_OP_INVALID) &&
 284             (vp->operator < T_TOKEN_LAST)) {
 285                 token = vp_tokens[vp->operator];
 286         } else {
 287                 token = "<INVALID-TOKEN>";
 288         }
 289
 290         if( vp->flags.has_tag ) {
 291
 292                 snprintf(out, outlen, "%s:%d %s ", vp->name, vp->flags.tag,
 293                          token);
 294
 295                 len = strlen(out);
 296                 vp_prints_value(out + len, outlen - len, vp, 1);
 297
 298         } else {
 299
 300                 snprintf(out, outlen, "%s %s ", vp->name, token);
 301                 len = strlen(out);
 302                 vp_prints_value(out + len, outlen - len, vp, 1);
 303
 304         }
 305
 306         return strlen(out);
 307 }
 308
 309
 310 /*
 311  *      Print one attribute and value.
 312  */
 313 void vp_print(FILE *fp, VALUE_PAIR *vp)
 314 {
 315         char    buf[1024];
 316
 317         vp_prints(buf, sizeof(buf), vp);
 318         fputs(buf, fp);
 319 }
 320
 321
 322 /*
 323  *      Print a whole list of attributes, indented by a TAB
 324  *      and with a newline at the end.
 325  */
 326 void vp_printlist(FILE *fp, VALUE_PAIR *vp)
 327 {
 328         for (; vp; vp = vp->next) {
 329                 fprintf(fp, "\t");
 330                 vp_print(fp, vp);
 331                 fprintf(fp, "\n");
 332         }
 333 }
 334