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                         if (vp->attribute == PW_NAS_PORT_ID)
 114                                 a = (char *)vp->strvalue;
 115                         else {
 116                                 if (delimitst && vp->flags.has_tag) {
 117                                         /* Tagged attribute: print delimter and ignore tag */
 118                                         buf[0] = '"';
 119                                         librad_safeprint((char *)(vp->strvalue),
 120                                                          vp->length, buf + 1, sizeof(buf) - 2);
 121                                         strcat(buf, "\"");
 122                                 } else if (delimitst) {
 123                                         /* Non-tagged attribute: print delimter */
 124                                         buf[0] = '"';
 125                                         librad_safeprint((char *)vp->strvalue,
 126                                                          vp->length, buf + 1, sizeof(buf) - 2);
 127                                         strcat(buf, "\"");
 128                                 } else {
 129                                         /* Non-tagged attribute: no delimiter */
 130                                         librad_safeprint((char *)vp->strvalue,
 131                                                          vp->length, buf, sizeof(buf));
 132                                 }
 133                                 a = buf;
 134                         }
 135                         break;
 136                 case PW_TYPE_INTEGER:
 137                         if ( vp->flags.has_tag ) {
 138                                 /* Attribute value has a tag, need to ignore it */
 139                                 if ((v = dict_valbyattr(vp->attribute, (vp->lvalue & 0xffffff)))
 140                                     != NULL)
 141                                         a = v->name;
 142                                 else {
 143                                         snprintf(buf, sizeof(buf), "%u", (vp->lvalue & 0xffffff));
 144                                         a = buf;
 145                                 }
 146                         } else {
 147                                 /* Normal, non-tagged attribute */
 148                                 if ((v = dict_valbyattr(vp->attribute, vp->lvalue))
 149                                     != NULL)
 150                                         a = v->name;
 151                                 else {
 152                                         snprintf(buf, sizeof(buf), "%u", vp->lvalue);
 153                                         a = buf;
 154                                 }
 155                         }
 156                         break;
 157                 case PW_TYPE_DATE:
 158                         t = vp->lvalue;
 159                         if (delimitst) {
 160                           strftime(buf, sizeof(buf), "\"%b %e %Y\"", gmtime_r(&t, &s_tm));
 161                         } else {
 162                           strftime(buf, sizeof(buf), "%b %e %Y", gmtime_r(&t, &s_tm));
 163                         }
 164                         a = buf;
 165                         break;
 166                 case PW_TYPE_IPADDR:
 167                         if (vp->strvalue[0])
 168                                 a = (char *)vp->strvalue;
 169                         else
 170                                 a = ip_hostname((char *)vp->strvalue,
 171                                                 sizeof(vp->strvalue),
 172                                                 vp->lvalue);
 173                         break;
 174                 case PW_TYPE_ABINARY:
 175 #ifdef ASCEND_BINARY
 176                   a = buf;
 177                   print_abinary(vp, (unsigned char *)buf, sizeof(buf));
 178                   break;
 179 #else
 180                   /* FALL THROUGH */
 181 #endif
 182                 case PW_TYPE_OCTETS:
 183                   strcpy(buf, "0x");
 184                   a = buf + 2;
 185                   for (t = 0; t < vp->length; t++) {
 186                         sprintf(a, "%02x", vp->strvalue[t]);
 187                         a += 2;
 188                   }
 189                   a = buf;
 190                   break;
 191
 192                 case PW_TYPE_IFID:
 193                         a = ifid_ntoa(buf, sizeof(buf), vp->strvalue);
 194                         break;
 195
 196                 case PW_TYPE_IPV6ADDR:
 197                         a = ipv6_ntoa(buf, sizeof(buf), vp->strvalue);
 198                         break;
 199
 200                 default:
 201                         a = 0;
 202                         break;
 203         }
 204         strNcpy(out, a?a:"UNKNOWN-TYPE", outlen);
 205
 206         return strlen(out);
 207 }
 208
 209 /*
 210  *  This is a hack, and has to be kept in sync with tokens.h
 211  */
 212 static const char *vp_tokens[] = {
 213   "?",                          /* T_INVALID */
 214   "EOL",                        /* T_EOL */
 215   "{",
 216   "}",
 217   "(",
 218   ")",
 219   ",",
 220   ";",
 221   "+=",
 222   "-=",
 223   ":=",
 224   "=",
 225   "!=",
 226   ">=",
 227   ">",
 228   "<=",
 229   "<",
 230   "=~",
 231   "!~",
 232   "=*",
 233   "~*",
 234   "==",
 235   "#",
 236   "<BARE-WORD>",
 237   "<\"STRING\">",
 238   "<'STRING'>",
 239   "<`STRING`>"
 240 };
 241
 242
 243 /*
 244  *      Print one attribute and value into a string.
 245  */
 246 int vp_prints(char *out, int outlen, VALUE_PAIR *vp)
 247 {
 248         int             len;
 249         const char      *token = NULL;
 250
 251         out[0] = 0;
 252         if (!vp) return 0;
 253
 254         if (strlen(vp->name) + 3 > (size_t)outlen) {
 255                 return 0;
 256         }
 257
 258         if ((vp->operator > T_INVALID) &&
 259             (vp->operator < T_TOKEN_LAST)) {
 260                 token = vp_tokens[vp->operator];
 261         } else {
 262                 token = "<INVALID-TOKEN>";
 263         }
 264
 265         if( vp->flags.has_tag ) {
 266
 267                 snprintf(out, outlen, "%s:%d %s ", vp->name, vp->flags.tag,
 268                          token);
 269
 270                 len = strlen(out);
 271                 vp_prints_value(out + len, outlen - len, vp, 1);
 272
 273         } else {
 274
 275                 snprintf(out, outlen, "%s %s ", vp->name, token);
 276                 len = strlen(out);
 277                 vp_prints_value(out + len, outlen - len, vp, 1);
 278
 279         }
 280
 281         return strlen(out);
 282 }
 283
 284
 285 /*
 286  *      Print one attribute and value.
 287  */
 288 void vp_print(FILE *fp, VALUE_PAIR *vp)
 289 {
 290         char    buf[1024];
 291
 292         vp_prints(buf, sizeof(buf), vp);
 293         fputs(buf, fp);
 294 }
 295
 296
 297 /*
 298  *      Print a whole list of attributes, indented by a TAB
 299  *      and with a newline at the end.
 300  */
 301 void vp_printlist(FILE *fp, VALUE_PAIR *vp)
 302 {
 303         for (; vp; vp = vp->next) {
 304                 fprintf(fp, "\t");
 305                 vp_print(fp, vp);
 306                 fprintf(fp, "\n");
 307         }
 308 }
 309