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        "libradius.h"
  34
  35 /*
  36  *      Convert a string to something printable.
  37  *      The output string has to be _at least_ 4x the size
  38  *      of the input string!
  39  */
  40 void librad_safeprint(char *in, int inlen, char *out, int outlen)
  41 {
  42         unsigned char   *str = (unsigned char *)in;
  43         int             done = 0;
  44         int             sp = 0;
  45
  46         if (inlen < 0) inlen = strlen(in);
  47
  48         while (inlen-- > 0 && (done + 3) < outlen) {
  49                 /*
  50                  *      Hack: never print trailing zero.
  51                  *      Some clients send strings with an off-by-one
  52                  *      length (confused with strings in C).
  53                  */
  54                 if (inlen == 0 && *str == 0)
  55                         break;
  56
  57                 sp = 0;
  58
  59                 switch (*str) {
  60                         case '\\':
  61                                 sp = '\\';
  62                                 break;
  63                         case '\r':
  64                                 sp = 'r';
  65                                 break;
  66                         case '\n':
  67                                 sp = 'n';
  68                                 break;
  69                         case '\t':
  70                                 sp = 't';
  71                                 break;
  72                         default:
  73                                 if (*str < 32 || (*str >= 128)){
  74                                         snprintf(out, outlen, "\\%03o", *str);
  75                                         done += 4;
  76                                         out  += 4;
  77                                         outlen -= 4;
  78                                 } else {
  79                                         *out++ = *str;
  80                                         outlen--;
  81                                         done++;
  82                                 }
  83                 }
  84                 if (sp) {
  85                         *out++ = '\\';
  86                         *out++ = sp;
  87                         outlen -= 2;
  88                         done += 2;
  89                 }
  90                 str++;
  91         }
  92         *out = 0;
  93 }
  94
  95
  96 /*
  97  *  Print one value into a string.
  98  *  delimitst will define if strings and dates will be delimited by '"'
  99  */
 100 int vp_prints_value(char * out, int outlen, VALUE_PAIR *vp, int delimitst)
 101 {
 102         DICT_VALUE  *v;
 103         char        buf[1024];
 104         char        *a;
 105         time_t      t;
 106         struct tm   s_tm;
 107
 108         out[0] = 0;
 109         if (!vp) return 0;
 110
 111         switch (vp->type) {
 112                 case PW_TYPE_STRING:
 113                         /*
 114                          *  NAS-Port may have multiple integer values?
 115                          *  This is an internal server extension...
 116                          */
 117                         if (vp->attribute == PW_NAS_PORT)
 118                                 a = (char *)vp->strvalue;
 119                         else {
 120                                 if (delimitst && vp->flags.has_tag) {
 121                                         /* Tagged attribute: print delimter and ignore tag */
 122                                         buf[0] = '"';
 123                                         librad_safeprint((char *)(vp->strvalue),
 124                                                          vp->length, buf + 1, sizeof(buf) - 2);
 125                                         strcat(buf, "\"");
 126                                 } else if (delimitst) {
 127                                         /* Non-tagged attribute: print delimter */
 128                                         buf[0] = '"';
 129                                         librad_safeprint((char *)vp->strvalue,
 130                                                          vp->length, buf + 1, sizeof(buf) - 2);
 131                                         strcat(buf, "\"");
 132                                 } else {
 133                                         /* Non-tagged attribute: no delimiter */
 134                                         librad_safeprint((char *)vp->strvalue,
 135                                                          vp->length, buf, sizeof(buf));
 136                                 }
 137                                 a = buf;
 138                         }
 139                         break;
 140                 case PW_TYPE_INTEGER:
 141                         if ( vp->flags.has_tag ) {
 142                                 /* Attribute value has a tag, need to ignore it */
 143                                 if ((v = dict_valbyattr(vp->attribute, (vp->lvalue & 0xffffff)))
 144                                     != NULL)
 145                                         a = v->name;
 146                                 else {
 147                                         snprintf(buf, sizeof(buf), "%u", (vp->lvalue & 0xffffff));
 148                                         a = buf;
 149                                 }
 150                         } else {
 151                                 /* Normal, non-tagged attribute */
 152                                 if ((v = dict_valbyattr(vp->attribute, vp->lvalue))
 153                                     != NULL)
 154                                         a = v->name;
 155                                 else {
 156                                         snprintf(buf, sizeof(buf), "%u", vp->lvalue);
 157                                         a = buf;
 158                                 }
 159                         }
 160                         break;
 161                 case PW_TYPE_DATE:
 162                         t = vp->lvalue;
 163                         if (delimitst) {
 164                           strftime(buf, sizeof(buf), "\"%b %e %Y %H:%M:%S %Z\"",
 165                                    localtime_r(&t, &s_tm));
 166                         } else {
 167                           strftime(buf, sizeof(buf), "%b %e %Y %H:%M:%S %Z",
 168                                    localtime_r(&t, &s_tm));
 169                         }
 170                         a = buf;
 171                         break;
 172                 case PW_TYPE_IPADDR:
 173                         a = ip_ntoa(buf, vp->lvalue);
 174                         break;
 175                 case PW_TYPE_ABINARY:
 176 #ifdef ASCEND_BINARY
 177                   a = buf;
 178                   print_abinary(vp, (unsigned char *)buf, sizeof(buf));
 179                   break;
 180 #else
 181                   /* FALL THROUGH */
 182 #endif
 183                 case PW_TYPE_OCTETS:
 184                   strcpy(buf, "0x");
 185                   a = buf + 2;
 186                   for (t = 0; t < vp->length; t++) {
 187                         sprintf(a, "%02x", vp->strvalue[t]);
 188                         a += 2;
 189                   }
 190                   a = buf;
 191                   break;
 192
 193                 case PW_TYPE_IFID:
 194                         a = ifid_ntoa(buf, sizeof(buf), vp->strvalue);
 195                         break;
 196
 197                 case PW_TYPE_IPV6ADDR:
 198                         a = ipv6_ntoa(buf, sizeof(buf), vp->strvalue);
 199                         break;
 200
 201                 default:
 202                         a = 0;
 203                         break;
 204         }
 205         strNcpy(out, a?a:"UNKNOWN-TYPE", outlen);
 206
 207         return strlen(out);
 208 }
 209
 210 /*
 211  *  This is a hack, and has to be kept in sync with tokens.h
 212  */
 213 static const char *vp_tokens[] = {
 214   "?",                          /* T_INVALID */
 215   "EOL",                        /* T_EOL */
 216   "{",
 217   "}",
 218   "(",
 219   ")",
 220   ",",
 221   ";",
 222   "+=",
 223   "-=",
 224   ":=",
 225   "=",
 226   "!=",
 227   ">=",
 228   ">",
 229   "<=",
 230   "<",
 231   "=~",
 232   "!~",
 233   "=*",
 234   "!*",
 235   "==",
 236   "#",
 237   "<BARE-WORD>",
 238   "<\"STRING\">",
 239   "<'STRING'>",
 240   "<`STRING`>"
 241 };
 242
 243
 244 /*
 245  *      Print one attribute and value into a string.
 246  */
 247 int vp_prints(char *out, int outlen, VALUE_PAIR *vp)
 248 {
 249         int             len;
 250         const char      *token = NULL;
 251
 252         out[0] = 0;
 253         if (!vp) return 0;
 254
 255         if (strlen(vp->name) + 3 > (size_t)outlen) {
 256                 return 0;
 257         }
 258
 259         if ((vp->operator > T_INVALID) &&
 260             (vp->operator < T_TOKEN_LAST)) {
 261                 token = vp_tokens[vp->operator];
 262         } else {
 263                 token = "<INVALID-TOKEN>";
 264         }
 265
 266         if( vp->flags.has_tag ) {
 267
 268                 snprintf(out, outlen, "%s:%d %s ", vp->name, vp->flags.tag,
 269                          token);
 270
 271                 len = strlen(out);
 272                 vp_prints_value(out + len, outlen - len, vp, 1);
 273
 274         } else {
 275
 276                 snprintf(out, outlen, "%s %s ", vp->name, token);
 277                 len = strlen(out);
 278                 vp_prints_value(out + len, outlen - len, vp, 1);
 279
 280         }
 281
 282         return strlen(out);
 283 }
 284
 285
 286 /*
 287  *      Print one attribute and value.
 288  */
 289 void vp_print(FILE *fp, VALUE_PAIR *vp)
 290 {
 291         char    buf[1024];
 292
 293         vp_prints(buf, sizeof(buf), vp);
 294         fputs(buf, fp);
 295 }
 296
 297
 298 /*
 299  *      Print a whole list of attributes, indented by a TAB
 300  *      and with a newline at the end.
 301  */
 302 void vp_printlist(FILE *fp, VALUE_PAIR *vp)
 303 {
 304         for (; vp; vp = vp->next) {
 305                 fprintf(fp, "\t");
 306                 vp_print(fp, vp);
 307                 fprintf(fp, "\n");
 308         }
 309 }
 310