curl/src/tool_writeout_json.c
Viktor Szakats f4e23950c7
build: enable -Wcast-qual, fix or silence compiler warnings
The issues found fell into these categories, with the applied fixes:

- const was accidentally stripped.
  Adjust code to not cast or cast with const.

- const/volatile missing from arguments, local variables.
  Constify arguments or variables, adjust/delete casts. Small code
  changes in a few places.

- const must be stripped because an API dependency requires it.
  Strip `const` with `CURL_UNCONST()` macro to silence the warning out
  of our control. These happen at API boundaries. Sometimes they depend
  on dependency version, which this patch handles as necessary. Also
  enable const support for the zlib API, using `ZLIB_CONST`. Supported
  by zlib 1.2.5.2 and newer.

- const must be stripped because a curl API requires it.
  Strip `const` with `CURL_UNCONST()` macro to silence the warning out
  of our immediate control. For example we promise to send a non-const
  argument to a callback, though the data is const internally.

- other cases where we may avoid const stripping by code changes.
  Also silenced with `CURL_UNCONST()`.

- there are 3 places where `CURL_UNCONST()` is cast again to const.
  To silence this type of warning:
  ```
  lib/vquic/curl_osslq.c:1015:29: error: to be safe all intermediate
    pointers in cast from 'unsigned char **' to 'const unsigned char **'
    must be 'const' qualified [-Werror=cast-qual]
  lib/cf-socket.c:734:32: error: to be safe all intermediate pointers in
    cast from 'char **' to 'const char **' must be 'const' qualified
    [-Werror=cast-qual]
  ```
  There may be a better solution, but I couldn't find it.

These cases are handled in separate subcommits, but without further
markup.

If you see a `-Wcast-qual` warning in curl, we appreciate your report
about it.

Closes #16142
2025-03-10 22:30:15 +01:00

166 lines
4.8 KiB
C

/***************************************************************************
* _ _ ____ _
* Project ___| | | | _ \| |
* / __| | | | |_) | |
* | (__| |_| | _ <| |___
* \___|\___/|_| \_\_____|
*
* Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
*
* This software is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at https://curl.se/docs/copyright.html.
*
* You may opt to use, copy, modify, merge, publish, distribute and/or sell
* copies of the Software, and permit persons to whom the Software is
* furnished to do so, under the terms of the COPYING file.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
* SPDX-License-Identifier: curl
*
***************************************************************************/
#include "tool_setup.h"
#include "curlx.h"
#include "tool_cfgable.h"
#include "tool_writeout_json.h"
#include "tool_writeout.h"
#define MAX_JSON_STRING 100000
/* provide the given string in dynbuf as a quoted json string, but without the
outer quotes. The buffer is not inited by this function.
Return 0 on success, non-zero on error.
*/
int jsonquoted(const char *in, size_t len,
struct curlx_dynbuf *out, bool lowercase)
{
const unsigned char *i = (const unsigned char *)in;
const unsigned char *in_end = &i[len];
CURLcode result = CURLE_OK;
for(; (i < in_end) && !result; i++) {
switch(*i) {
case '\\':
result = curlx_dyn_addn(out, "\\\\", 2);
break;
case '\"':
result = curlx_dyn_addn(out, "\\\"", 2);
break;
case '\b':
result = curlx_dyn_addn(out, "\\b", 2);
break;
case '\f':
result = curlx_dyn_addn(out, "\\f", 2);
break;
case '\n':
result = curlx_dyn_addn(out, "\\n", 2);
break;
case '\r':
result = curlx_dyn_addn(out, "\\r", 2);
break;
case '\t':
result = curlx_dyn_addn(out, "\\t", 2);
break;
default:
if(*i < 32)
result = curlx_dyn_addf(out, "\\u%04x", *i);
else {
char o = (char)*i;
if(lowercase && (o >= 'A' && o <= 'Z'))
/* do not use tolower() since that is locale specific */
o |= ('a' - 'A');
result = curlx_dyn_addn(out, &o, 1);
}
break;
}
}
if(result)
return (int)result;
return 0;
}
void jsonWriteString(FILE *stream, const char *in, bool lowercase)
{
struct curlx_dynbuf out;
curlx_dyn_init(&out, MAX_JSON_STRING);
if(!jsonquoted(in, strlen(in), &out, lowercase)) {
fputc('\"', stream);
if(curlx_dyn_len(&out))
fputs(curlx_dyn_ptr(&out), stream);
fputc('\"', stream);
}
curlx_dyn_free(&out);
}
void ourWriteOutJSON(FILE *stream, const struct writeoutvar mappings[],
size_t nentries,
struct per_transfer *per, CURLcode per_result)
{
size_t i;
fputs("{", stream);
for(i = 0; i < nentries; i++) {
if(mappings[i].writefunc &&
mappings[i].writefunc(stream, &mappings[i], per, per_result, true))
fputs(",", stream);
}
/* The variables are sorted in alphabetical order but as a special case
curl_version (which is not actually a --write-out variable) is last. */
fprintf(stream, "\"curl_version\":");
jsonWriteString(stream, curl_version(), FALSE);
fprintf(stream, "}");
}
void headerJSON(FILE *stream, struct per_transfer *per)
{
struct curl_header *header;
struct curl_header *prev = NULL;
fputc('{', stream);
while((header = curl_easy_nextheader(per->curl, CURLH_HEADER, -1,
prev)) != NULL) {
if(header->amount > 1) {
if(!header->index) {
/* act on the 0-index entry and pull the others in, then output in a
JSON list */
size_t a = header->amount;
size_t i = 0;
char *name = header->name;
if(prev)
fputs(",\n", stream);
jsonWriteString(stream, header->name, TRUE);
fputc(':', stream);
prev = header;
fputc('[', stream);
do {
jsonWriteString(stream, header->value, FALSE);
if(++i >= a)
break;
fputc(',', stream);
if(curl_easy_header(per->curl, name, i, CURLH_HEADER,
-1, &header))
break;
} while(1);
fputc(']', stream);
}
}
else {
if(prev)
fputs(",\n", stream);
jsonWriteString(stream, header->name, TRUE);
fputc(':', stream);
fputc('[', stream);
jsonWriteString(stream, header->value, FALSE);
fputc(']', stream);
prev = header;
}
}
fputs("\n}", stream);
}