src/tool_writeout.c

   1 /***************************************************************************
   2  *                                  _   _ ____  _
   3  *  Project                     ___| | | |  _ \| |
   4  *                             / __| | | | |_) | |
   5  *                            | (__| |_| |  _ <| |___
   6  *                             \___|\___/|_| \_\_____|
   7  *
   8  * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
   9  *
  10  * This software is licensed as described in the file COPYING, which
  11  * you should have received as part of this distribution. The terms
  12  * are also available at http://curl.haxx.se/docs/copyright.html.
  13  *
  14  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15  * copies of the Software, and permit persons to whom the Software is
  16  * furnished to do so, under the terms of the COPYING file.
  17  *
  18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19  * KIND, either express or implied.
  20  *
  21  ***************************************************************************/
  22 #include "tool_setup.h"
  23 #define ENABLE_CURLX_PRINTF
  24 /* use our own printf() functions */
  25 #include "curlx.h"
  26 #include "tool_cfgable.h"
  27 #include "tool_writeout.h"
  28
  29 #include "memdebug.h" /* keep this as LAST include */
  30
  31 typedef enum {
  32   VAR_NONE,       /* must be the first */
  33   VAR_TOTAL_TIME,
  34   VAR_NAMELOOKUP_TIME,
  35   VAR_CONNECT_TIME,
  36   VAR_APPCONNECT_TIME,
  37   VAR_PRETRANSFER_TIME,
  38   VAR_STARTTRANSFER_TIME,
  39   VAR_SIZE_DOWNLOAD,
  40   VAR_SIZE_UPLOAD,
  41   VAR_SPEED_DOWNLOAD,
  42   VAR_SPEED_UPLOAD,
  43   VAR_HTTP_CODE,
  44   VAR_HTTP_CODE_PROXY,
  45   VAR_HEADER_SIZE,
  46   VAR_REQUEST_SIZE,
  47   VAR_EFFECTIVE_URL,
  48   VAR_CONTENT_TYPE,
  49   VAR_NUM_CONNECTS,
  50   VAR_REDIRECT_TIME,
  51   VAR_REDIRECT_COUNT,
  52   VAR_FTP_ENTRY_PATH,
  53   VAR_REDIRECT_URL,
  54   VAR_SSL_VERIFY_RESULT,
  55   VAR_EFFECTIVE_FILENAME,
  56   VAR_PRIMARY_IP,
  57   VAR_PRIMARY_PORT,
  58   VAR_LOCAL_IP,
  59   VAR_LOCAL_PORT,
  60   VAR_NUM_OF_VARS /* must be the last */
  61 } replaceid;
  62
  63 struct variable {
  64   const char *name;
  65   replaceid id;
  66 };
  67
  68
  69 static const struct variable replacements[]={
  70   {"url_effective", VAR_EFFECTIVE_URL},
  71   {"http_code", VAR_HTTP_CODE},
  72   {"response_code", VAR_HTTP_CODE},
  73   {"http_connect", VAR_HTTP_CODE_PROXY},
  74   {"time_total", VAR_TOTAL_TIME},
  75   {"time_namelookup", VAR_NAMELOOKUP_TIME},
  76   {"time_connect", VAR_CONNECT_TIME},
  77   {"time_appconnect", VAR_APPCONNECT_TIME},
  78   {"time_pretransfer", VAR_PRETRANSFER_TIME},
  79   {"time_starttransfer", VAR_STARTTRANSFER_TIME},
  80   {"size_header", VAR_HEADER_SIZE},
  81   {"size_request", VAR_REQUEST_SIZE},
  82   {"size_download", VAR_SIZE_DOWNLOAD},
  83   {"size_upload", VAR_SIZE_UPLOAD},
  84   {"speed_download", VAR_SPEED_DOWNLOAD},
  85   {"speed_upload", VAR_SPEED_UPLOAD},
  86   {"content_type", VAR_CONTENT_TYPE},
  87   {"num_connects", VAR_NUM_CONNECTS},
  88   {"time_redirect", VAR_REDIRECT_TIME},
  89   {"num_redirects", VAR_REDIRECT_COUNT},
  90   {"ftp_entry_path", VAR_FTP_ENTRY_PATH},
  91   {"redirect_url", VAR_REDIRECT_URL},
  92   {"ssl_verify_result", VAR_SSL_VERIFY_RESULT},
  93   {"filename_effective", VAR_EFFECTIVE_FILENAME},
  94   {"remote_ip", VAR_PRIMARY_IP},
  95   {"remote_port", VAR_PRIMARY_PORT},
  96   {"local_ip", VAR_LOCAL_IP},
  97   {"local_port", VAR_LOCAL_PORT},
  98   {NULL, VAR_NONE}
  99 };
 100
 101 void ourWriteOut(CURL *curl, struct OutStruct *outs, const char *writeinfo)
 102 {
 103   FILE *stream = stdout;
 104   const char *ptr = writeinfo;
 105   char *stringp = NULL;
 106   long longinfo;
 107   double doubleinfo;
 108
 109   while(ptr && *ptr) {
 110     if('%' == *ptr) {
 111       if('%' == ptr[1]) {
 112         /* an escaped %-letter */
 113         fputc('%', stream);
 114         ptr += 2;
 115       }
 116       else {
 117         /* this is meant as a variable to output */
 118         char *end;
 119         char keepit;
 120         int i;
 121         if(('{' == ptr[1]) && ((end = strchr(ptr, '}')) != NULL)) {
 122           bool match = FALSE;
 123           ptr += 2; /* pass the % and the { */
 124           keepit = *end;
 125           *end = 0; /* zero terminate */
 126           for(i = 0; replacements[i].name; i++) {
 127             if(curl_strequal(ptr, replacements[i].name)) {
 128               match = TRUE;
 129               switch(replacements[i].id) {
 130               case VAR_EFFECTIVE_URL:
 131                 if((CURLE_OK ==
 132                     curl_easy_getinfo(curl, CURLINFO_EFFECTIVE_URL, &stringp))
 133                    && stringp)
 134                   fputs(stringp, stream);
 135                 break;
 136               case VAR_HTTP_CODE:
 137                 if(CURLE_OK ==
 138                    curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &longinfo))
 139                   fprintf(stream, "%03ld", longinfo);
 140                 break;
 141               case VAR_HTTP_CODE_PROXY:
 142                 if(CURLE_OK ==
 143                    curl_easy_getinfo(curl, CURLINFO_HTTP_CONNECTCODE,
 144                                      &longinfo))
 145                   fprintf(stream, "%03ld", longinfo);
 146                 break;
 147               case VAR_HEADER_SIZE:
 148                 if(CURLE_OK ==
 149                    curl_easy_getinfo(curl, CURLINFO_HEADER_SIZE, &longinfo))
 150                   fprintf(stream, "%ld", longinfo);
 151                 break;
 152               case VAR_REQUEST_SIZE:
 153                 if(CURLE_OK ==
 154                    curl_easy_getinfo(curl, CURLINFO_REQUEST_SIZE, &longinfo))
 155                   fprintf(stream, "%ld", longinfo);
 156                 break;
 157               case VAR_NUM_CONNECTS:
 158                 if(CURLE_OK ==
 159                    curl_easy_getinfo(curl, CURLINFO_NUM_CONNECTS, &longinfo))
 160                   fprintf(stream, "%ld", longinfo);
 161                 break;
 162               case VAR_REDIRECT_COUNT:
 163                 if(CURLE_OK ==
 164                    curl_easy_getinfo(curl, CURLINFO_REDIRECT_COUNT, &longinfo))
 165                   fprintf(stream, "%ld", longinfo);
 166                 break;
 167               case VAR_REDIRECT_TIME:
 168                 if(CURLE_OK ==
 169                    curl_easy_getinfo(curl, CURLINFO_REDIRECT_TIME,
 170                                      &doubleinfo))
 171                   fprintf(stream, "%.3f", doubleinfo);
 172                 break;
 173               case VAR_TOTAL_TIME:
 174                 if(CURLE_OK ==
 175                    curl_easy_getinfo(curl, CURLINFO_TOTAL_TIME, &doubleinfo))
 176                   fprintf(stream, "%.3f", doubleinfo);
 177                 break;
 178               case VAR_NAMELOOKUP_TIME:
 179                 if(CURLE_OK ==
 180                    curl_easy_getinfo(curl, CURLINFO_NAMELOOKUP_TIME,
 181                                      &doubleinfo))
 182                   fprintf(stream, "%.3f", doubleinfo);
 183                 break;
 184               case VAR_CONNECT_TIME:
 185                 if(CURLE_OK ==
 186                    curl_easy_getinfo(curl, CURLINFO_CONNECT_TIME, &doubleinfo))
 187                   fprintf(stream, "%.3f", doubleinfo);
 188                 break;
 189               case VAR_APPCONNECT_TIME:
 190                 if(CURLE_OK ==
 191                    curl_easy_getinfo(curl, CURLINFO_APPCONNECT_TIME,
 192                                      &doubleinfo))
 193                   fprintf(stream, "%.3f", doubleinfo);
 194                 break;
 195               case VAR_PRETRANSFER_TIME:
 196                 if(CURLE_OK ==
 197                    curl_easy_getinfo(curl, CURLINFO_PRETRANSFER_TIME,
 198                                      &doubleinfo))
 199                   fprintf(stream, "%.3f", doubleinfo);
 200                 break;
 201               case VAR_STARTTRANSFER_TIME:
 202                 if(CURLE_OK ==
 203                    curl_easy_getinfo(curl, CURLINFO_STARTTRANSFER_TIME,
 204                                      &doubleinfo))
 205                   fprintf(stream, "%.3f", doubleinfo);
 206                 break;
 207               case VAR_SIZE_UPLOAD:
 208                 if(CURLE_OK ==
 209                    curl_easy_getinfo(curl, CURLINFO_SIZE_UPLOAD, &doubleinfo))
 210                   fprintf(stream, "%.0f", doubleinfo);
 211                 break;
 212               case VAR_SIZE_DOWNLOAD:
 213                 if(CURLE_OK ==
 214                    curl_easy_getinfo(curl, CURLINFO_SIZE_DOWNLOAD,
 215                                      &doubleinfo))
 216                   fprintf(stream, "%.0f", doubleinfo);
 217                 break;
 218               case VAR_SPEED_DOWNLOAD:
 219                 if(CURLE_OK ==
 220                    curl_easy_getinfo(curl, CURLINFO_SPEED_DOWNLOAD,
 221                                      &doubleinfo))
 222                   fprintf(stream, "%.3f", doubleinfo);
 223                 break;
 224               case VAR_SPEED_UPLOAD:
 225                 if(CURLE_OK ==
 226                    curl_easy_getinfo(curl, CURLINFO_SPEED_UPLOAD, &doubleinfo))
 227                   fprintf(stream, "%.3f", doubleinfo);
 228                 break;
 229               case VAR_CONTENT_TYPE:
 230                 if((CURLE_OK ==
 231                     curl_easy_getinfo(curl, CURLINFO_CONTENT_TYPE, &stringp))
 232                    && stringp)
 233                   fputs(stringp, stream);
 234                 break;
 235               case VAR_FTP_ENTRY_PATH:
 236                 if((CURLE_OK ==
 237                     curl_easy_getinfo(curl, CURLINFO_FTP_ENTRY_PATH, &stringp))
 238                    && stringp)
 239                   fputs(stringp, stream);
 240                 break;
 241               case VAR_REDIRECT_URL:
 242                 if((CURLE_OK ==
 243                     curl_easy_getinfo(curl, CURLINFO_REDIRECT_URL, &stringp))
 244                    && stringp)
 245                   fputs(stringp, stream);
 246                 break;
 247               case VAR_SSL_VERIFY_RESULT:
 248                 if(CURLE_OK ==
 249                    curl_easy_getinfo(curl, CURLINFO_SSL_VERIFYRESULT,
 250                                      &longinfo))
 251                   fprintf(stream, "%ld", longinfo);
 252                 break;
 253               case VAR_EFFECTIVE_FILENAME:
 254                 if(outs->filename)
 255                   fprintf(stream, "%s", outs->filename);
 256                 break;
 257               case VAR_PRIMARY_IP:
 258                 if(CURLE_OK ==
 259                    curl_easy_getinfo(curl, CURLINFO_PRIMARY_IP,
 260                                      &stringp))
 261                   fprintf(stream, "%s", stringp);
 262                 break;
 263               case VAR_PRIMARY_PORT:
 264                 if(CURLE_OK ==
 265                    curl_easy_getinfo(curl, CURLINFO_PRIMARY_PORT,
 266                                      &longinfo))
 267                   fprintf(stream, "%ld", longinfo);
 268                 break;
 269               case VAR_LOCAL_IP:
 270                 if(CURLE_OK ==
 271                    curl_easy_getinfo(curl, CURLINFO_LOCAL_IP,
 272                                      &stringp))
 273                   fprintf(stream, "%s", stringp);
 274                 break;
 275               case VAR_LOCAL_PORT:
 276                 if(CURLE_OK ==
 277                    curl_easy_getinfo(curl, CURLINFO_LOCAL_PORT,
 278                                      &longinfo))
 279                   fprintf(stream, "%ld", longinfo);
 280                 break;
 281               default:
 282                 break;
 283               }
 284               break;
 285             }
 286           }
 287           if(!match) {
 288             fprintf(stderr, "curl: unknown --write-out variable: '%s'\n", ptr);
 289           }
 290           ptr = end + 1; /* pass the end */
 291           *end = keepit;
 292         }
 293         else {
 294           /* illegal syntax, then just output the characters that are used */
 295           fputc('%', stream);
 296           fputc(ptr[1], stream);
 297           ptr += 2;
 298         }
 299       }
 300     }
 301     else if('\\' == *ptr) {
 302       switch(ptr[1]) {
 303       case 'r':
 304         fputc('\r', stream);
 305         break;
 306       case 'n':
 307         fputc('\n', stream);
 308         break;
 309       case 't':
 310         fputc('\t', stream);
 311         break;
 312       default:
 313         /* unknown, just output this */
 314         fputc(*ptr, stream);
 315         fputc(ptr[1], stream);
 316         break;
 317       }
 318       ptr += 2;
 319     }
 320     else {
 321       fputc(*ptr, stream);
 322       ptr++;
 323     }
 324   }
 325
 326 }