Age Owner Branch data TLA Line data Source code
1 : : /*-------------------------------------------------------------------------
2 : : *
3 : : * json.c
4 : : * JSON data type support.
5 : : *
6 : : * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
7 : : * Portions Copyright (c) 1994, Regents of the University of California
8 : : *
9 : : * IDENTIFICATION
10 : : * src/backend/utils/adt/json.c
11 : : *
12 : : *-------------------------------------------------------------------------
13 : : */
14 : : #include "postgres.h"
15 : :
16 : : #include "access/htup_details.h"
17 : : #include "catalog/pg_proc.h"
18 : : #include "catalog/pg_type.h"
19 : : #include "common/hashfn.h"
20 : : #include "funcapi.h"
21 : : #include "libpq/pqformat.h"
22 : : #include "miscadmin.h"
23 : : #include "port/simd.h"
24 : : #include "utils/array.h"
25 : : #include "utils/builtins.h"
26 : : #include "utils/date.h"
27 : : #include "utils/datetime.h"
28 : : #include "utils/fmgroids.h"
29 : : #include "utils/json.h"
30 : : #include "utils/jsonfuncs.h"
31 : : #include "utils/lsyscache.h"
32 : : #include "utils/typcache.h"
33 : :
34 : :
35 : : /*
36 : : * Support for fast key uniqueness checking.
37 : : *
38 : : * We maintain a hash table of used keys in JSON objects for fast detection
39 : : * of duplicates.
40 : : */
41 : : /* Common context for key uniqueness check */
42 : : typedef struct HTAB *JsonUniqueCheckState; /* hash table for key names */
43 : :
44 : : /* Hash entry for JsonUniqueCheckState */
45 : : typedef struct JsonUniqueHashEntry
46 : : {
47 : : const char *key;
48 : : int key_len;
49 : : int object_id;
50 : : } JsonUniqueHashEntry;
51 : :
52 : : /* Stack element for key uniqueness check during JSON parsing */
53 : : typedef struct JsonUniqueStackEntry
54 : : {
55 : : struct JsonUniqueStackEntry *parent;
56 : : int object_id;
57 : : } JsonUniqueStackEntry;
58 : :
59 : : /* Context struct for key uniqueness check during JSON parsing */
60 : : typedef struct JsonUniqueParsingState
61 : : {
62 : : JsonLexContext *lex;
63 : : JsonUniqueCheckState check;
64 : : JsonUniqueStackEntry *stack;
65 : : int id_counter;
66 : : bool unique;
67 : : } JsonUniqueParsingState;
68 : :
69 : : /* Context struct for key uniqueness check during JSON building */
70 : : typedef struct JsonUniqueBuilderState
71 : : {
72 : : JsonUniqueCheckState check; /* unique check */
73 : : StringInfoData skipped_keys; /* skipped keys with NULL values */
74 : : MemoryContext mcxt; /* context for saving skipped keys */
75 : : } JsonUniqueBuilderState;
76 : :
77 : :
78 : : /* State struct for JSON aggregation */
79 : : typedef struct JsonAggState
80 : : {
81 : : StringInfo str;
82 : : JsonTypeCategory key_category;
83 : : Oid key_output_func;
84 : : JsonTypeCategory val_category;
85 : : Oid val_output_func;
86 : : JsonUniqueBuilderState unique_check;
87 : : } JsonAggState;
88 : :
89 : : static void composite_to_json(Datum composite, StringInfo result,
90 : : bool use_line_feeds);
91 : : static void array_dim_to_json(StringInfo result, int dim, int ndims, int *dims,
92 : : Datum *vals, bool *nulls, int *valcount,
93 : : JsonTypeCategory tcategory, Oid outfuncoid,
94 : : bool use_line_feeds);
95 : : static void array_to_json_internal(Datum array, StringInfo result,
96 : : bool use_line_feeds);
97 : : static void datum_to_json_internal(Datum val, bool is_null, StringInfo result,
98 : : JsonTypeCategory tcategory, Oid outfuncoid,
99 : : bool key_scalar);
100 : : static void add_json(Datum val, bool is_null, StringInfo result,
101 : : Oid val_type, bool key_scalar);
102 : : static text *catenate_stringinfo_string(StringInfo buffer, const char *addon);
103 : :
104 : : /*
105 : : * Input.
106 : : */
107 : : Datum
5019 rhaas@postgresql.org 108 :CBC 3158 : json_in(PG_FUNCTION_ARGS)
109 : : {
4596 andrew@dunslane.net 110 : 3158 : char *json = PG_GETARG_CSTRING(0);
111 : 3158 : text *result = cstring_to_text(json);
112 : : JsonLexContext lex;
113 : :
114 : : /* validate it */
754 alvherre@alvh.no-ip. 115 : 3158 : makeJsonLexContext(&lex, result, false);
116 [ + + ]: 3158 : if (!pg_parse_json_or_errsave(&lex, &nullSemAction, fcinfo->context))
1052 tgl@sss.pgh.pa.us 117 : 6 : PG_RETURN_NULL();
118 : :
119 : : /* Internal representation is the same as text */
4596 andrew@dunslane.net 120 : 3056 : PG_RETURN_TEXT_P(result);
121 : : }
122 : :
123 : : /*
124 : : * Output.
125 : : */
126 : : Datum
5019 rhaas@postgresql.org 127 : 2830 : json_out(PG_FUNCTION_ARGS)
128 : : {
129 : : /* we needn't detoast because text_to_cstring will handle that */
4888 bruce@momjian.us 130 : 2830 : Datum txt = PG_GETARG_DATUM(0);
131 : :
5019 rhaas@postgresql.org 132 : 2830 : PG_RETURN_CSTRING(TextDatumGetCString(txt));
133 : : }
134 : :
135 : : /*
136 : : * Binary send.
137 : : */
138 : : Datum
5019 rhaas@postgresql.org 139 :UBC 0 : json_send(PG_FUNCTION_ARGS)
140 : : {
4888 bruce@momjian.us 141 : 0 : text *t = PG_GETARG_TEXT_PP(0);
142 : : StringInfoData buf;
143 : :
5019 rhaas@postgresql.org 144 : 0 : pq_begintypsend(&buf);
145 [ # # # # : 0 : pq_sendtext(&buf, VARDATA_ANY(t), VARSIZE_ANY_EXHDR(t));
# # # # #
# # # ]
146 : 0 : PG_RETURN_BYTEA_P(pq_endtypsend(&buf));
147 : : }
148 : :
149 : : /*
150 : : * Binary receive.
151 : : */
152 : : Datum
153 : 0 : json_recv(PG_FUNCTION_ARGS)
154 : : {
155 : 0 : StringInfo buf = (StringInfo) PG_GETARG_POINTER(0);
156 : : char *str;
157 : : int nbytes;
158 : : JsonLexContext lex;
159 : :
160 : 0 : str = pq_getmsgtext(buf, buf->len - buf->cursor, &nbytes);
161 : :
162 : : /* Validate it. */
754 alvherre@alvh.no-ip. 163 : 0 : makeJsonLexContextCstringLen(&lex, str, nbytes, GetDatabaseEncoding(),
164 : : false);
165 : 0 : pg_parse_json_or_ereport(&lex, &nullSemAction);
166 : :
4237 andrew@dunslane.net 167 : 0 : PG_RETURN_TEXT_P(cstring_to_text_with_len(str, nbytes));
168 : : }
169 : :
170 : : /*
171 : : * Turn a Datum into JSON text, appending the string to "result".
172 : : *
173 : : * tcategory and outfuncoid are from a previous call to json_categorize_type,
174 : : * except that if is_null is true then they can be invalid.
175 : : *
176 : : * If key_scalar is true, the value is being printed as a key, so insist
177 : : * it's of an acceptable type, and force it to be quoted.
178 : : */
179 : : static void
830 amitlan@postgresql.o 180 :CBC 4230 : datum_to_json_internal(Datum val, bool is_null, StringInfo result,
181 : : JsonTypeCategory tcategory, Oid outfuncoid,
182 : : bool key_scalar)
183 : : {
184 : : char *outputstr;
185 : : text *jsontext;
186 : :
3676 noah@leadboat.com 187 : 4230 : check_stack_depth();
188 : :
189 : : /* callers are expected to ensure that null keys are not passed in */
3983 tgl@sss.pgh.pa.us 190 [ + + - + ]: 4230 : Assert(!(key_scalar && is_null));
191 : :
4996 andrew@dunslane.net 192 [ + + ]: 4230 : if (is_null)
193 : : {
680 nathan@postgresql.or 194 : 159 : appendBinaryStringInfo(result, "null", strlen("null"));
5016 andrew@dunslane.net 195 : 159 : return;
196 : : }
197 : :
4190 tgl@sss.pgh.pa.us 198 [ + + + + ]: 4071 : if (key_scalar &&
199 [ + + ]: 994 : (tcategory == JSONTYPE_ARRAY ||
200 [ + + ]: 991 : tcategory == JSONTYPE_COMPOSITE ||
201 [ - + ]: 985 : tcategory == JSONTYPE_JSON ||
202 : : tcategory == JSONTYPE_CAST))
203 [ + - ]: 18 : ereport(ERROR,
204 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
205 : : errmsg("key value must be scalar, not array, composite, or json")));
206 : :
5016 andrew@dunslane.net 207 [ + + + + : 4053 : switch (tcategory)
+ + + + +
+ ]
208 : : {
4190 tgl@sss.pgh.pa.us 209 : 162 : case JSONTYPE_ARRAY:
5016 andrew@dunslane.net 210 : 162 : array_to_json_internal(val, result, false);
211 : 162 : break;
4190 tgl@sss.pgh.pa.us 212 : 250 : case JSONTYPE_COMPOSITE:
4047 sfrost@snowman.net 213 : 250 : composite_to_json(val, result, false);
5016 andrew@dunslane.net 214 : 250 : break;
4190 tgl@sss.pgh.pa.us 215 : 19 : case JSONTYPE_BOOL:
216 [ - + ]: 19 : if (key_scalar)
680 nathan@postgresql.or 217 :UBC 0 : appendStringInfoChar(result, '"');
680 nathan@postgresql.or 218 [ + + ]:CBC 19 : if (DatumGetBool(val))
219 : 13 : appendBinaryStringInfo(result, "true", strlen("true"));
220 : : else
221 : 6 : appendBinaryStringInfo(result, "false", strlen("false"));
222 [ - + ]: 19 : if (key_scalar)
680 nathan@postgresql.or 223 :UBC 0 : appendStringInfoChar(result, '"');
5016 andrew@dunslane.net 224 :CBC 19 : break;
4190 tgl@sss.pgh.pa.us 225 : 2565 : case JSONTYPE_NUMERIC:
226 : 2565 : outputstr = OidOutputFunctionCall(outfuncoid, val);
227 : :
228 : : /*
229 : : * Don't quote a non-key if it's a valid JSON number (i.e., not
230 : : * "Infinity", "-Infinity", or "NaN"). Since we know this is a
231 : : * numeric data type's output, we simplify and open-code the
232 : : * validation for better performance.
233 : : */
690 nathan@postgresql.or 234 [ + + ]: 2565 : if (!key_scalar &&
235 [ + + + + ]: 1815 : ((*outputstr >= '0' && *outputstr <= '9') ||
236 [ + + ]: 33 : (*outputstr == '-' &&
237 [ + - + + ]: 27 : (outputstr[1] >= '0' && outputstr[1] <= '9'))))
3984 andrew@dunslane.net 238 : 1806 : appendStringInfoString(result, outputstr);
239 : : else
240 : : {
690 nathan@postgresql.or 241 : 759 : appendStringInfoChar(result, '"');
242 : 759 : appendStringInfoString(result, outputstr);
243 : 759 : appendStringInfoChar(result, '"');
244 : : }
4999 andrew@dunslane.net 245 : 2565 : pfree(outputstr);
246 : 2565 : break;
4090 tgl@sss.pgh.pa.us 247 : 12 : case JSONTYPE_DATE:
248 : : {
249 : : char buf[MAXDATELEN + 1];
250 : :
2225 akorotkov@postgresql 251 : 12 : JsonEncodeDateTime(buf, val, DATEOID, NULL);
690 nathan@postgresql.or 252 : 12 : appendStringInfoChar(result, '"');
253 : 12 : appendStringInfoString(result, buf);
254 : 12 : appendStringInfoChar(result, '"');
255 : : }
2842 andrew@dunslane.net 256 : 12 : break;
257 : 13 : case JSONTYPE_TIMESTAMP:
258 : : {
259 : : char buf[MAXDATELEN + 1];
260 : :
2225 akorotkov@postgresql 261 : 13 : JsonEncodeDateTime(buf, val, TIMESTAMPOID, NULL);
690 nathan@postgresql.or 262 : 13 : appendStringInfoChar(result, '"');
263 : 13 : appendStringInfoString(result, buf);
264 : 13 : appendStringInfoChar(result, '"');
265 : : }
2842 andrew@dunslane.net 266 : 13 : break;
267 : 12 : case JSONTYPE_TIMESTAMPTZ:
268 : : {
269 : : char buf[MAXDATELEN + 1];
270 : :
2225 akorotkov@postgresql 271 : 12 : JsonEncodeDateTime(buf, val, TIMESTAMPTZOID, NULL);
690 nathan@postgresql.or 272 : 12 : appendStringInfoChar(result, '"');
273 : 12 : appendStringInfoString(result, buf);
274 : 12 : appendStringInfoChar(result, '"');
275 : : }
2842 andrew@dunslane.net 276 : 12 : break;
277 : 411 : case JSONTYPE_JSON:
278 : : /* JSON and JSONB output will already be escaped */
279 : 411 : outputstr = OidOutputFunctionCall(outfuncoid, val);
280 : 411 : appendStringInfoString(result, outputstr);
281 : 411 : pfree(outputstr);
282 : 411 : break;
283 : 2 : case JSONTYPE_CAST:
284 : : /* outfuncoid refers to a cast function, not an output function */
285 : 2 : jsontext = DatumGetTextPP(OidFunctionCall1(outfuncoid, val));
680 nathan@postgresql.or 286 [ - + ]: 2 : appendBinaryStringInfo(result, VARDATA_ANY(jsontext),
287 [ - + - - : 2 : VARSIZE_ANY_EXHDR(jsontext));
- - - - -
+ ]
2842 andrew@dunslane.net 288 : 2 : pfree(jsontext);
289 : 2 : break;
290 : 607 : default:
291 : : /* special-case text types to save useless palloc/memcpy cycles */
458 drowley@postgresql.o 292 [ + + + - : 607 : if (outfuncoid == F_TEXTOUT || outfuncoid == F_VARCHAROUT ||
- + ]
293 : : outfuncoid == F_BPCHAROUT)
294 : 456 : escape_json_text(result, (text *) DatumGetPointer(val));
295 : : else
296 : : {
297 : 151 : outputstr = OidOutputFunctionCall(outfuncoid, val);
298 : 151 : escape_json(result, outputstr);
299 : 151 : pfree(outputstr);
300 : : }
2842 andrew@dunslane.net 301 : 607 : break;
302 : : }
303 : : }
304 : :
305 : : /*
306 : : * Encode 'value' of datetime type 'typid' into JSON string in ISO format using
307 : : * optionally preallocated buffer 'buf'. Optional 'tzp' determines time-zone
308 : : * offset (in seconds) in which we want to show timestamptz.
309 : : */
310 : : char *
2225 akorotkov@postgresql 311 : 865 : JsonEncodeDateTime(char *buf, Datum value, Oid typid, const int *tzp)
312 : : {
2842 andrew@dunslane.net 313 [ + + ]: 865 : if (!buf)
314 : 30 : buf = palloc(MAXDATELEN + 1);
315 : :
316 [ + + + + : 865 : switch (typid)
+ - ]
317 : : {
318 : 120 : case DATEOID:
319 : : {
320 : : DateADT date;
321 : : struct pg_tm tm;
322 : :
323 : 120 : date = DatumGetDateADT(value);
324 : :
325 : : /* Same as date_out(), but forcing DateStyle */
4090 tgl@sss.pgh.pa.us 326 [ + + + + ]: 120 : if (DATE_NOT_FINITE(date))
3661 327 : 12 : EncodeSpecialDate(date, buf);
328 : : else
329 : : {
4090 330 : 108 : j2date(date + POSTGRES_EPOCH_JDATE,
331 : : &(tm.tm_year), &(tm.tm_mon), &(tm.tm_mday));
332 : 108 : EncodeDateOnly(&tm, USE_XSD_DATES, buf);
333 : : }
334 : : }
335 : 120 : break;
2842 andrew@dunslane.net 336 : 135 : case TIMEOID:
337 : : {
338 : 135 : TimeADT time = DatumGetTimeADT(value);
339 : : struct pg_tm tt,
340 : 135 : *tm = &tt;
341 : : fsec_t fsec;
342 : :
343 : : /* Same as time_out(), but forcing DateStyle */
344 : 135 : time2tm(time, tm, &fsec);
345 : 135 : EncodeTimeOnly(tm, fsec, false, 0, USE_XSD_DATES, buf);
346 : : }
347 : 135 : break;
348 : 171 : case TIMETZOID:
349 : : {
350 : 171 : TimeTzADT *time = DatumGetTimeTzADTP(value);
351 : : struct pg_tm tt,
352 : 171 : *tm = &tt;
353 : : fsec_t fsec;
354 : : int tz;
355 : :
356 : : /* Same as timetz_out(), but forcing DateStyle */
357 : 171 : timetz2tm(time, tm, &fsec, &tz);
358 : 171 : EncodeTimeOnly(tm, fsec, true, tz, USE_XSD_DATES, buf);
359 : : }
360 : 171 : break;
361 : 184 : case TIMESTAMPOID:
362 : : {
363 : : Timestamp timestamp;
364 : : struct pg_tm tm;
365 : : fsec_t fsec;
366 : :
367 : 184 : timestamp = DatumGetTimestamp(value);
368 : : /* Same as timestamp_out(), but forcing DateStyle */
4165 369 [ + + + + ]: 184 : if (TIMESTAMP_NOT_FINITE(timestamp))
3661 tgl@sss.pgh.pa.us 370 : 12 : EncodeSpecialTimestamp(timestamp, buf);
4165 andrew@dunslane.net 371 [ + - ]: 172 : else if (timestamp2tm(timestamp, NULL, &tm, &fsec, NULL, NULL) == 0)
372 : 172 : EncodeDateTime(&tm, fsec, false, 0, NULL, USE_XSD_DATES, buf);
373 : : else
4165 andrew@dunslane.net 374 [ # # ]:UBC 0 : ereport(ERROR,
375 : : (errcode(ERRCODE_DATETIME_VALUE_OUT_OF_RANGE),
376 : : errmsg("timestamp out of range")));
377 : : }
4165 andrew@dunslane.net 378 :CBC 184 : break;
2842 379 : 255 : case TIMESTAMPTZOID:
380 : : {
381 : : TimestampTz timestamp;
382 : : struct pg_tm tm;
383 : : int tz;
384 : : fsec_t fsec;
4165 385 : 255 : const char *tzn = NULL;
386 : :
2842 387 : 255 : timestamp = DatumGetTimestampTz(value);
388 : :
389 : : /*
390 : : * If a time zone is specified, we apply the time-zone shift,
391 : : * convert timestamptz to pg_tm as if it were without a time
392 : : * zone, and then use the specified time zone for converting
393 : : * the timestamp into a string.
394 : : */
2225 akorotkov@postgresql 395 [ + + ]: 255 : if (tzp)
396 : : {
397 : 231 : tz = *tzp;
398 : 231 : timestamp -= (TimestampTz) tz * USECS_PER_SEC;
399 : : }
400 : :
401 : : /* Same as timestamptz_out(), but forcing DateStyle */
4165 andrew@dunslane.net 402 [ + + + + ]: 255 : if (TIMESTAMP_NOT_FINITE(timestamp))
3661 tgl@sss.pgh.pa.us 403 : 12 : EncodeSpecialTimestamp(timestamp, buf);
2225 akorotkov@postgresql 404 [ + + + + : 243 : else if (timestamp2tm(timestamp, tzp ? NULL : &tz, &tm, &fsec,
+ - ]
405 : : tzp ? NULL : &tzn, NULL) == 0)
406 : : {
407 [ + + ]: 243 : if (tzp)
408 : 231 : tm.tm_isdst = 1; /* set time-zone presence flag */
409 : :
4165 andrew@dunslane.net 410 : 243 : EncodeDateTime(&tm, fsec, true, tz, tzn, USE_XSD_DATES, buf);
411 : : }
412 : : else
4165 andrew@dunslane.net 413 [ # # ]:UBC 0 : ereport(ERROR,
414 : : (errcode(ERRCODE_DATETIME_VALUE_OUT_OF_RANGE),
415 : : errmsg("timestamp out of range")));
416 : : }
4165 andrew@dunslane.net 417 :CBC 255 : break;
5016 andrew@dunslane.net 418 :UBC 0 : default:
1917 michael@paquier.xyz 419 [ # # ]: 0 : elog(ERROR, "unknown jsonb value datetime type oid %u", typid);
420 : : return NULL;
421 : : }
422 : :
2842 andrew@dunslane.net 423 :CBC 865 : return buf;
424 : : }
425 : :
426 : : /*
427 : : * Process a single dimension of an array.
428 : : * If it's the innermost dimension, output the values, otherwise call
429 : : * ourselves recursively to process the next dimension.
430 : : */
431 : : static void
4888 bruce@momjian.us 432 : 189 : array_dim_to_json(StringInfo result, int dim, int ndims, int *dims, Datum *vals,
433 : : bool *nulls, int *valcount, JsonTypeCategory tcategory,
434 : : Oid outfuncoid, bool use_line_feeds)
435 : : {
436 : : int i;
437 : : const char *sep;
438 : :
5016 andrew@dunslane.net 439 [ - + ]: 189 : Assert(dim < ndims);
440 : :
441 [ + + ]: 189 : sep = use_line_feeds ? ",\n " : ",";
442 : :
443 : 189 : appendStringInfoChar(result, '[');
444 : :
445 [ + + ]: 705 : for (i = 1; i <= dims[dim]; i++)
446 : : {
447 [ + + ]: 516 : if (i > 1)
4888 bruce@momjian.us 448 : 327 : appendStringInfoString(result, sep);
449 : :
5016 andrew@dunslane.net 450 [ + + ]: 516 : if (dim + 1 == ndims)
451 : : {
830 amitlan@postgresql.o 452 : 510 : datum_to_json_internal(vals[*valcount], nulls[*valcount],
453 : : result, tcategory,
454 : : outfuncoid, false);
5016 andrew@dunslane.net 455 : 510 : (*valcount)++;
456 : : }
457 : : else
458 : : {
459 : : /*
460 : : * Do we want line feeds on inner dimensions of arrays? For now
461 : : * we'll say no.
462 : : */
4888 bruce@momjian.us 463 : 6 : array_dim_to_json(result, dim + 1, ndims, dims, vals, nulls,
464 : : valcount, tcategory, outfuncoid, false);
465 : : }
466 : : }
467 : :
5016 andrew@dunslane.net 468 : 189 : appendStringInfoChar(result, ']');
469 : 189 : }
470 : :
471 : : /*
472 : : * Turn an array into JSON.
473 : : */
474 : : static void
475 : 183 : array_to_json_internal(Datum array, StringInfo result, bool use_line_feeds)
476 : : {
477 : 183 : ArrayType *v = DatumGetArrayTypeP(array);
478 : 183 : Oid element_type = ARR_ELEMTYPE(v);
479 : : int *dim;
480 : : int ndim;
481 : : int nitems;
4888 bruce@momjian.us 482 : 183 : int count = 0;
483 : : Datum *elements;
484 : : bool *nulls;
485 : : int16 typlen;
486 : : bool typbyval;
487 : : char typalign;
488 : : JsonTypeCategory tcategory;
489 : : Oid outfuncoid;
490 : :
5016 andrew@dunslane.net 491 : 183 : ndim = ARR_NDIM(v);
492 : 183 : dim = ARR_DIMS(v);
493 : 183 : nitems = ArrayGetNItems(ndim, dim);
494 : :
495 [ - + ]: 183 : if (nitems <= 0)
496 : : {
4888 bruce@momjian.us 497 :UBC 0 : appendStringInfoString(result, "[]");
5016 andrew@dunslane.net 498 : 0 : return;
499 : : }
500 : :
4190 tgl@sss.pgh.pa.us 501 :CBC 183 : get_typlenbyvalalign(element_type,
502 : : &typlen, &typbyval, &typalign);
503 : :
831 amitlan@postgresql.o 504 : 183 : json_categorize_type(element_type, false,
505 : : &tcategory, &outfuncoid);
506 : :
5016 andrew@dunslane.net 507 : 183 : deconstruct_array(v, element_type, typlen, typbyval,
508 : : typalign, &elements, &nulls,
509 : : &nitems);
510 : :
4996 511 : 183 : array_dim_to_json(result, 0, ndim, dim, elements, nulls, &count, tcategory,
512 : : outfuncoid, use_line_feeds);
513 : :
5016 514 : 183 : pfree(elements);
515 : 183 : pfree(nulls);
516 : : }
517 : :
518 : : /*
519 : : * Turn a composite / record into JSON.
520 : : */
521 : : static void
4047 sfrost@snowman.net 522 : 628 : composite_to_json(Datum composite, StringInfo result, bool use_line_feeds)
523 : : {
524 : : HeapTupleHeader td;
525 : : Oid tupType;
526 : : int32 tupTypmod;
527 : : TupleDesc tupdesc;
528 : : HeapTupleData tmptup,
529 : : *tuple;
530 : : int i;
4888 bruce@momjian.us 531 : 628 : bool needsep = false;
532 : : const char *sep;
533 : : int seplen;
534 : :
535 : : /*
536 : : * We can avoid expensive strlen() calls by precalculating the separator
537 : : * length.
538 : : */
5016 andrew@dunslane.net 539 [ + + ]: 628 : sep = use_line_feeds ? ",\n " : ",";
690 nathan@postgresql.or 540 [ + + ]: 628 : seplen = use_line_feeds ? strlen(",\n ") : strlen(",");
541 : :
4888 bruce@momjian.us 542 : 628 : td = DatumGetHeapTupleHeader(composite);
543 : :
544 : : /* Extract rowtype info and find a tupdesc */
545 : 628 : tupType = HeapTupleHeaderGetTypeId(td);
546 : 628 : tupTypmod = HeapTupleHeaderGetTypMod(td);
547 : 628 : tupdesc = lookup_rowtype_tupdesc(tupType, tupTypmod);
548 : :
549 : : /* Build a temporary HeapTuple control structure */
550 : 628 : tmptup.t_len = HeapTupleHeaderGetDatumLength(td);
551 : 628 : tmptup.t_data = td;
5016 andrew@dunslane.net 552 : 628 : tuple = &tmptup;
553 : :
4888 bruce@momjian.us 554 : 628 : appendStringInfoChar(result, '{');
555 : :
556 [ + + ]: 1854 : for (i = 0; i < tupdesc->natts; i++)
557 : : {
558 : : Datum val;
559 : : bool isnull;
560 : : char *attname;
561 : : JsonTypeCategory tcategory;
562 : : Oid outfuncoid;
2991 andres@anarazel.de 563 : 1226 : Form_pg_attribute att = TupleDescAttr(tupdesc, i);
564 : :
565 [ - + ]: 1226 : if (att->attisdropped)
4888 bruce@momjian.us 566 :UBC 0 : continue;
567 : :
5016 andrew@dunslane.net 568 [ + + ]:CBC 1226 : if (needsep)
690 nathan@postgresql.or 569 : 598 : appendBinaryStringInfo(result, sep, seplen);
5016 andrew@dunslane.net 570 : 1226 : needsep = true;
571 : :
2991 andres@anarazel.de 572 : 1226 : attname = NameStr(att->attname);
4888 bruce@momjian.us 573 : 1226 : escape_json(result, attname);
574 : 1226 : appendStringInfoChar(result, ':');
575 : :
4047 sfrost@snowman.net 576 : 1226 : val = heap_getattr(tuple, i + 1, tupdesc, &isnull);
577 : :
4190 tgl@sss.pgh.pa.us 578 [ + + ]: 1226 : if (isnull)
579 : : {
580 : 90 : tcategory = JSONTYPE_NULL;
581 : 90 : outfuncoid = InvalidOid;
582 : : }
583 : : else
831 amitlan@postgresql.o 584 : 1136 : json_categorize_type(att->atttypid, false, &tcategory,
585 : : &outfuncoid);
586 : :
830 587 : 1226 : datum_to_json_internal(val, isnull, result, tcategory, outfuncoid,
588 : : false);
589 : : }
590 : :
4888 bruce@momjian.us 591 : 628 : appendStringInfoChar(result, '}');
592 [ + - ]: 628 : ReleaseTupleDesc(tupdesc);
5016 andrew@dunslane.net 593 : 628 : }
594 : :
595 : : /*
596 : : * Append JSON text for "val" to "result".
597 : : *
598 : : * This is just a thin wrapper around datum_to_json. If the same type will be
599 : : * printed many times, avoid using this; better to do the json_categorize_type
600 : : * lookups only once.
601 : : */
602 : : static void
4190 tgl@sss.pgh.pa.us 603 : 682 : add_json(Datum val, bool is_null, StringInfo result,
604 : : Oid val_type, bool key_scalar)
605 : : {
606 : : JsonTypeCategory tcategory;
607 : : Oid outfuncoid;
608 : :
4291 andrew@dunslane.net 609 [ - + ]: 682 : if (val_type == InvalidOid)
4291 andrew@dunslane.net 610 [ # # ]:UBC 0 : ereport(ERROR,
611 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
612 : : errmsg("could not determine input data type")));
613 : :
4190 tgl@sss.pgh.pa.us 614 [ + + ]:CBC 682 : if (is_null)
615 : : {
616 : 36 : tcategory = JSONTYPE_NULL;
617 : 36 : outfuncoid = InvalidOid;
618 : : }
619 : : else
831 amitlan@postgresql.o 620 : 646 : json_categorize_type(val_type, false,
621 : : &tcategory, &outfuncoid);
622 : :
830 623 : 682 : datum_to_json_internal(val, is_null, result, tcategory, outfuncoid,
624 : : key_scalar);
4291 andrew@dunslane.net 625 : 664 : }
626 : :
627 : : /*
628 : : * SQL function array_to_json(row)
629 : : */
630 : : Datum
4065 sfrost@snowman.net 631 : 9 : array_to_json(PG_FUNCTION_ARGS)
632 : : {
4047 633 : 9 : Datum array = PG_GETARG_DATUM(0);
634 : : StringInfo result;
635 : :
636 : 9 : result = makeStringInfo();
637 : :
638 : 9 : array_to_json_internal(array, result, false);
639 : :
640 : 9 : PG_RETURN_TEXT_P(cstring_to_text_with_len(result->data, result->len));
641 : : }
642 : :
643 : : /*
644 : : * SQL function array_to_json(row, prettybool)
645 : : */
646 : : Datum
647 : 12 : array_to_json_pretty(PG_FUNCTION_ARGS)
648 : : {
4888 bruce@momjian.us 649 : 12 : Datum array = PG_GETARG_DATUM(0);
650 : 12 : bool use_line_feeds = PG_GETARG_BOOL(1);
651 : : StringInfo result;
652 : :
5016 andrew@dunslane.net 653 : 12 : result = makeStringInfo();
654 : :
655 : 12 : array_to_json_internal(array, result, use_line_feeds);
656 : :
4362 rhaas@postgresql.org 657 : 12 : PG_RETURN_TEXT_P(cstring_to_text_with_len(result->data, result->len));
658 : : }
659 : :
660 : : /*
661 : : * SQL function row_to_json(row)
662 : : */
663 : : Datum
5016 andrew@dunslane.net 664 : 354 : row_to_json(PG_FUNCTION_ARGS)
665 : : {
4047 sfrost@snowman.net 666 : 354 : Datum array = PG_GETARG_DATUM(0);
667 : : StringInfo result;
668 : :
669 : 354 : result = makeStringInfo();
670 : :
671 : 354 : composite_to_json(array, result, false);
672 : :
673 : 354 : PG_RETURN_TEXT_P(cstring_to_text_with_len(result->data, result->len));
674 : : }
675 : :
676 : : /*
677 : : * SQL function row_to_json(row, prettybool)
678 : : */
679 : : Datum
680 : 24 : row_to_json_pretty(PG_FUNCTION_ARGS)
681 : : {
4888 bruce@momjian.us 682 : 24 : Datum array = PG_GETARG_DATUM(0);
683 : 24 : bool use_line_feeds = PG_GETARG_BOOL(1);
684 : : StringInfo result;
685 : :
5016 andrew@dunslane.net 686 : 24 : result = makeStringInfo();
687 : :
4047 sfrost@snowman.net 688 : 24 : composite_to_json(array, result, use_line_feeds);
689 : :
4362 rhaas@postgresql.org 690 : 24 : PG_RETURN_TEXT_P(cstring_to_text_with_len(result->data, result->len));
691 : : }
692 : :
693 : : /*
694 : : * Is the given type immutable when coming out of a JSON context?
695 : : *
696 : : * At present, datetimes are all considered mutable, because they
697 : : * depend on timezone. XXX we should also drill down into objects
698 : : * and arrays, but do not.
699 : : */
700 : : bool
944 alvherre@alvh.no-ip. 701 :UBC 0 : to_json_is_immutable(Oid typoid)
702 : : {
703 : : JsonTypeCategory tcategory;
704 : : Oid outfuncoid;
705 : :
831 amitlan@postgresql.o 706 : 0 : json_categorize_type(typoid, false, &tcategory, &outfuncoid);
707 : :
944 alvherre@alvh.no-ip. 708 [ # # # # : 0 : switch (tcategory)
# # ]
709 : : {
710 : 0 : case JSONTYPE_BOOL:
711 : : case JSONTYPE_JSON:
712 : : case JSONTYPE_JSONB:
713 : : case JSONTYPE_NULL:
714 : 0 : return true;
715 : :
716 : 0 : case JSONTYPE_DATE:
717 : : case JSONTYPE_TIMESTAMP:
718 : : case JSONTYPE_TIMESTAMPTZ:
719 : 0 : return false;
720 : :
721 : 0 : case JSONTYPE_ARRAY:
722 : 0 : return false; /* TODO recurse into elements */
723 : :
724 : 0 : case JSONTYPE_COMPOSITE:
725 : 0 : return false; /* TODO recurse into fields */
726 : :
727 : 0 : case JSONTYPE_NUMERIC:
728 : : case JSONTYPE_CAST:
729 : : case JSONTYPE_OTHER:
730 : 0 : return func_volatile(outfuncoid) == PROVOLATILE_IMMUTABLE;
731 : : }
732 : :
733 : 0 : return false; /* not reached */
734 : : }
735 : :
736 : : /*
737 : : * SQL function to_json(anyvalue)
738 : : */
739 : : Datum
4615 andrew@dunslane.net 740 :CBC 90 : to_json(PG_FUNCTION_ARGS)
741 : : {
4377 tgl@sss.pgh.pa.us 742 : 90 : Datum val = PG_GETARG_DATUM(0);
4615 andrew@dunslane.net 743 : 90 : Oid val_type = get_fn_expr_argtype(fcinfo->flinfo, 0);
744 : : JsonTypeCategory tcategory;
745 : : Oid outfuncoid;
746 : :
747 [ - + ]: 90 : if (val_type == InvalidOid)
4615 andrew@dunslane.net 748 [ # # ]:UBC 0 : ereport(ERROR,
749 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
750 : : errmsg("could not determine input data type")));
751 : :
831 amitlan@postgresql.o 752 :CBC 90 : json_categorize_type(val_type, false,
753 : : &tcategory, &outfuncoid);
754 : :
830 755 : 90 : PG_RETURN_DATUM(datum_to_json(val, tcategory, outfuncoid));
756 : : }
757 : :
758 : : /*
759 : : * Turn a Datum into JSON text.
760 : : *
761 : : * tcategory and outfuncoid are from a previous call to json_categorize_type.
762 : : */
763 : : Datum
764 : 125 : datum_to_json(Datum val, JsonTypeCategory tcategory, Oid outfuncoid)
765 : : {
766 : 125 : StringInfo result = makeStringInfo();
767 : :
768 : 125 : datum_to_json_internal(val, false, result, tcategory, outfuncoid,
769 : : false);
770 : :
771 : 125 : return PointerGetDatum(cstring_to_text_with_len(result->data, result->len));
772 : : }
773 : :
774 : : /*
775 : : * json_agg transition function
776 : : *
777 : : * aggregate input column as a json array value.
778 : : */
779 : : static Datum
944 alvherre@alvh.no-ip. 780 : 277 : json_agg_transfn_worker(FunctionCallInfo fcinfo, bool absent_on_null)
781 : : {
782 : : MemoryContext aggcontext,
783 : : oldcontext;
784 : : JsonAggState *state;
785 : : Datum val;
786 : :
4615 andrew@dunslane.net 787 [ - + ]: 277 : if (!AggCheckCallContext(fcinfo, &aggcontext))
788 : : {
789 : : /* cannot be called directly because of internal-type argument */
4615 andrew@dunslane.net 790 [ # # ]:UBC 0 : elog(ERROR, "json_agg_transfn called in non-aggregate context");
791 : : }
792 : :
4615 andrew@dunslane.net 793 [ + + ]:CBC 277 : if (PG_ARGISNULL(0))
794 : : {
3661 tgl@sss.pgh.pa.us 795 : 62 : Oid arg_type = get_fn_expr_argtype(fcinfo->flinfo, 1);
796 : :
3693 andrew@dunslane.net 797 [ - + ]: 62 : if (arg_type == InvalidOid)
3693 andrew@dunslane.net 798 [ # # ]:UBC 0 : ereport(ERROR,
799 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
800 : : errmsg("could not determine input data type")));
801 : :
802 : : /*
803 : : * Make this state object in a context where it will persist for the
804 : : * duration of the aggregate call. MemoryContextSwitchTo is only
805 : : * needed the first time, as the StringInfo routines make sure they
806 : : * use the right context to enlarge the object if necessary.
807 : : */
4615 andrew@dunslane.net 808 :CBC 62 : oldcontext = MemoryContextSwitchTo(aggcontext);
3693 809 : 62 : state = (JsonAggState *) palloc(sizeof(JsonAggState));
810 : 62 : state->str = makeStringInfo();
4615 811 : 62 : MemoryContextSwitchTo(oldcontext);
812 : :
3693 813 : 62 : appendStringInfoChar(state->str, '[');
831 amitlan@postgresql.o 814 : 62 : json_categorize_type(arg_type, false, &state->val_category,
815 : : &state->val_output_func);
816 : : }
817 : : else
818 : : {
3693 andrew@dunslane.net 819 : 215 : state = (JsonAggState *) PG_GETARG_POINTER(0);
820 : : }
821 : :
944 alvherre@alvh.no-ip. 822 [ + + + + ]: 277 : if (absent_on_null && PG_ARGISNULL(1))
823 : 45 : PG_RETURN_POINTER(state);
824 : :
825 [ + + ]: 232 : if (state->str->len > 1)
826 : 173 : appendStringInfoString(state->str, ", ");
827 : :
828 : : /* fast path for NULLs */
4615 andrew@dunslane.net 829 [ + + ]: 232 : if (PG_ARGISNULL(1))
830 : : {
830 amitlan@postgresql.o 831 : 27 : datum_to_json_internal((Datum) 0, true, state->str, JSONTYPE_NULL,
832 : : InvalidOid, false);
4615 andrew@dunslane.net 833 : 27 : PG_RETURN_POINTER(state);
834 : : }
835 : :
4377 tgl@sss.pgh.pa.us 836 : 205 : val = PG_GETARG_DATUM(1);
837 : :
838 : : /* add some whitespace if structured type and not first item */
944 alvherre@alvh.no-ip. 839 [ + + + + ]: 205 : if (!PG_ARGISNULL(0) && state->str->len > 1 &&
3693 andrew@dunslane.net 840 [ + + ]: 152 : (state->val_category == JSONTYPE_ARRAY ||
841 [ + + ]: 149 : state->val_category == JSONTYPE_COMPOSITE))
842 : : {
843 : 56 : appendStringInfoString(state->str, "\n ");
844 : : }
845 : :
830 amitlan@postgresql.o 846 : 205 : datum_to_json_internal(val, false, state->str, state->val_category,
847 : : state->val_output_func, false);
848 : :
849 : : /*
850 : : * The transition type for json_agg() is declared to be "internal", which
851 : : * is a pass-by-value type the same size as a pointer. So we can safely
852 : : * pass the JsonAggState pointer through nodeAgg.c's machinations.
853 : : */
4615 andrew@dunslane.net 854 : 205 : PG_RETURN_POINTER(state);
855 : : }
856 : :
857 : :
858 : : /*
859 : : * json_agg aggregate function
860 : : */
861 : : Datum
944 alvherre@alvh.no-ip. 862 : 79 : json_agg_transfn(PG_FUNCTION_ARGS)
863 : : {
864 : 79 : return json_agg_transfn_worker(fcinfo, false);
865 : : }
866 : :
867 : : /*
868 : : * json_agg_strict aggregate function
869 : : */
870 : : Datum
871 : 198 : json_agg_strict_transfn(PG_FUNCTION_ARGS)
872 : : {
873 : 198 : return json_agg_transfn_worker(fcinfo, true);
874 : : }
875 : :
876 : : /*
877 : : * json_agg final function
878 : : */
879 : : Datum
4615 andrew@dunslane.net 880 : 68 : json_agg_finalfn(PG_FUNCTION_ARGS)
881 : : {
882 : : JsonAggState *state;
883 : :
884 : : /* cannot be called directly because of internal-type argument */
885 [ - + ]: 68 : Assert(AggCheckCallContext(fcinfo, NULL));
886 : :
3693 887 : 136 : state = PG_ARGISNULL(0) ?
888 [ + + ]: 68 : NULL :
889 : 62 : (JsonAggState *) PG_GETARG_POINTER(0);
890 : :
891 : : /* NULL result for no rows in, as is standard with aggregates */
4615 892 [ + + ]: 68 : if (state == NULL)
893 : 6 : PG_RETURN_NULL();
894 : :
895 : : /* Else return state with appropriate array terminator added */
3693 896 : 62 : PG_RETURN_TEXT_P(catenate_stringinfo_string(state->str, "]"));
897 : : }
898 : :
899 : : /* Functions implementing hash table for key uniqueness check */
900 : : static uint32
944 alvherre@alvh.no-ip. 901 : 831 : json_unique_hash(const void *key, Size keysize)
902 : : {
903 : 831 : const JsonUniqueHashEntry *entry = (JsonUniqueHashEntry *) key;
904 : 831 : uint32 hash = hash_bytes_uint32(entry->object_id);
905 : :
906 : 831 : hash ^= hash_bytes((const unsigned char *) entry->key, entry->key_len);
907 : :
81 peter@eisentraut.org 908 :GNC 831 : return hash;
909 : : }
910 : :
911 : : static int
944 alvherre@alvh.no-ip. 912 :CBC 57 : json_unique_hash_match(const void *key1, const void *key2, Size keysize)
913 : : {
914 : 57 : const JsonUniqueHashEntry *entry1 = (const JsonUniqueHashEntry *) key1;
915 : 57 : const JsonUniqueHashEntry *entry2 = (const JsonUniqueHashEntry *) key2;
916 : :
917 [ - + ]: 57 : if (entry1->object_id != entry2->object_id)
944 alvherre@alvh.no-ip. 918 [ # # ]:UBC 0 : return entry1->object_id > entry2->object_id ? 1 : -1;
919 : :
944 alvherre@alvh.no-ip. 920 [ - + ]:CBC 57 : if (entry1->key_len != entry2->key_len)
944 alvherre@alvh.no-ip. 921 [ # # ]:UBC 0 : return entry1->key_len > entry2->key_len ? 1 : -1;
922 : :
944 alvherre@alvh.no-ip. 923 :CBC 57 : return strncmp(entry1->key, entry2->key, entry1->key_len);
924 : : }
925 : :
926 : : /*
927 : : * Uniqueness detection support.
928 : : *
929 : : * In order to detect uniqueness during building or parsing of a JSON
930 : : * object, we maintain a hash table of key names already seen.
931 : : */
932 : : static void
933 : 159 : json_unique_check_init(JsonUniqueCheckState *cxt)
934 : : {
935 : : HASHCTL ctl;
936 : :
937 : 159 : memset(&ctl, 0, sizeof(ctl));
938 : 159 : ctl.keysize = sizeof(JsonUniqueHashEntry);
939 : 159 : ctl.entrysize = sizeof(JsonUniqueHashEntry);
940 : 159 : ctl.hcxt = CurrentMemoryContext;
941 : 159 : ctl.hash = json_unique_hash;
942 : 159 : ctl.match = json_unique_hash_match;
943 : :
944 : 159 : *cxt = hash_create("json object hashtable",
945 : : 32,
946 : : &ctl,
947 : : HASH_ELEM | HASH_CONTEXT | HASH_FUNCTION | HASH_COMPARE);
948 : 159 : }
949 : :
950 : : static void
951 : 43 : json_unique_builder_init(JsonUniqueBuilderState *cxt)
952 : : {
953 : 43 : json_unique_check_init(&cxt->check);
954 : 43 : cxt->mcxt = CurrentMemoryContext;
955 : 43 : cxt->skipped_keys.data = NULL;
956 : 43 : }
957 : :
958 : : static bool
959 : 831 : json_unique_check_key(JsonUniqueCheckState *cxt, const char *key, int object_id)
960 : : {
961 : : JsonUniqueHashEntry entry;
962 : : bool found;
963 : :
964 : 831 : entry.key = key;
965 : 831 : entry.key_len = strlen(key);
966 : 831 : entry.object_id = object_id;
967 : :
968 : 831 : (void) hash_search(*cxt, &entry, HASH_ENTER, &found);
969 : :
970 : 831 : return !found;
971 : : }
972 : :
973 : : /*
974 : : * On-demand initialization of a throwaway StringInfo. This is used to
975 : : * read a key name that we don't need to store in the output object, for
976 : : * duplicate key detection when the value is NULL.
977 : : */
978 : : static StringInfo
979 : 21 : json_unique_builder_get_throwawaybuf(JsonUniqueBuilderState *cxt)
980 : : {
981 : 21 : StringInfo out = &cxt->skipped_keys;
982 : :
983 [ + + ]: 21 : if (!out->data)
984 : : {
985 : 15 : MemoryContext oldcxt = MemoryContextSwitchTo(cxt->mcxt);
986 : :
987 : 15 : initStringInfo(out);
988 : 15 : MemoryContextSwitchTo(oldcxt);
989 : : }
990 : : else
991 : : /* Just reset the string to empty */
992 : 6 : out->len = 0;
993 : :
994 : 21 : return out;
995 : : }
996 : :
997 : : /*
998 : : * json_object_agg transition function.
999 : : *
1000 : : * aggregate two input columns as a single json object value.
1001 : : */
1002 : : static Datum
1003 : 759 : json_object_agg_transfn_worker(FunctionCallInfo fcinfo,
1004 : : bool absent_on_null, bool unique_keys)
1005 : : {
1006 : : MemoryContext aggcontext,
1007 : : oldcontext;
1008 : : JsonAggState *state;
1009 : : StringInfo out;
1010 : : Datum arg;
1011 : : bool skip;
1012 : : int key_offset;
1013 : :
4291 andrew@dunslane.net 1014 [ - + ]: 759 : if (!AggCheckCallContext(fcinfo, &aggcontext))
1015 : : {
1016 : : /* cannot be called directly because of internal-type argument */
3983 tgl@sss.pgh.pa.us 1017 [ # # ]:UBC 0 : elog(ERROR, "json_object_agg_transfn called in non-aggregate context");
1018 : : }
1019 : :
4291 andrew@dunslane.net 1020 [ + + ]:CBC 759 : if (PG_ARGISNULL(0))
1021 : : {
1022 : : Oid arg_type;
1023 : :
1024 : : /*
1025 : : * Make the StringInfo in a context where it will persist for the
1026 : : * duration of the aggregate call. Switching context is only needed
1027 : : * for this initial step, as the StringInfo and dynahash routines make
1028 : : * sure they use the right context to enlarge the object if necessary.
1029 : : */
1030 : 67 : oldcontext = MemoryContextSwitchTo(aggcontext);
3693 1031 : 67 : state = (JsonAggState *) palloc(sizeof(JsonAggState));
1032 : 67 : state->str = makeStringInfo();
944 alvherre@alvh.no-ip. 1033 [ + + ]: 67 : if (unique_keys)
1034 : 27 : json_unique_builder_init(&state->unique_check);
1035 : : else
1036 : 40 : memset(&state->unique_check, 0, sizeof(state->unique_check));
4291 andrew@dunslane.net 1037 : 67 : MemoryContextSwitchTo(oldcontext);
1038 : :
3693 1039 : 67 : arg_type = get_fn_expr_argtype(fcinfo->flinfo, 1);
1040 : :
1041 [ - + ]: 67 : if (arg_type == InvalidOid)
3693 andrew@dunslane.net 1042 [ # # ]:UBC 0 : ereport(ERROR,
1043 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1044 : : errmsg("could not determine data type for argument %d", 1)));
1045 : :
831 amitlan@postgresql.o 1046 :CBC 67 : json_categorize_type(arg_type, false, &state->key_category,
1047 : : &state->key_output_func);
1048 : :
3693 andrew@dunslane.net 1049 : 67 : arg_type = get_fn_expr_argtype(fcinfo->flinfo, 2);
1050 : :
1051 [ - + ]: 67 : if (arg_type == InvalidOid)
3693 andrew@dunslane.net 1052 [ # # ]:UBC 0 : ereport(ERROR,
1053 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1054 : : errmsg("could not determine data type for argument %d", 2)));
1055 : :
831 amitlan@postgresql.o 1056 :CBC 67 : json_categorize_type(arg_type, false, &state->val_category,
1057 : : &state->val_output_func);
1058 : :
3693 andrew@dunslane.net 1059 : 67 : appendStringInfoString(state->str, "{ ");
1060 : : }
1061 : : else
1062 : : {
1063 : 692 : state = (JsonAggState *) PG_GETARG_POINTER(0);
1064 : : }
1065 : :
1066 : : /*
1067 : : * Note: since json_object_agg() is declared as taking type "any", the
1068 : : * parser will not do any type conversion on unknown-type literals (that
1069 : : * is, undecorated strings or NULLs). Such values will arrive here as
1070 : : * type UNKNOWN, which fortunately does not matter to us, since
1071 : : * unknownout() works fine.
1072 : : */
1073 : :
4098 tgl@sss.pgh.pa.us 1074 [ + + ]: 759 : if (PG_ARGISNULL(1))
1075 [ + - ]: 6 : ereport(ERROR,
1076 : : (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
1077 : : errmsg("null value not allowed for object key")));
1078 : :
1079 : : /* Skip null values if absent_on_null */
944 alvherre@alvh.no-ip. 1080 [ + + + + ]: 753 : skip = absent_on_null && PG_ARGISNULL(2);
1081 : :
1082 [ + + ]: 753 : if (skip)
1083 : : {
1084 : : /*
1085 : : * We got a NULL value and we're not storing those; if we're not
1086 : : * testing key uniqueness, we're done. If we are, use the throwaway
1087 : : * buffer to store the key name so that we can check it.
1088 : : */
1089 [ + + ]: 27 : if (!unique_keys)
1090 : 12 : PG_RETURN_POINTER(state);
1091 : :
1092 : 15 : out = json_unique_builder_get_throwawaybuf(&state->unique_check);
1093 : : }
1094 : : else
1095 : : {
1096 : 726 : out = state->str;
1097 : :
1098 : : /*
1099 : : * Append comma delimiter only if we have already output some fields
1100 : : * after the initial string "{ ".
1101 : : */
1102 [ + + ]: 726 : if (out->len > 2)
1103 : 662 : appendStringInfoString(out, ", ");
1104 : : }
1105 : :
4098 tgl@sss.pgh.pa.us 1106 : 741 : arg = PG_GETARG_DATUM(1);
1107 : :
944 alvherre@alvh.no-ip. 1108 : 741 : key_offset = out->len;
1109 : :
830 amitlan@postgresql.o 1110 : 741 : datum_to_json_internal(arg, false, out, state->key_category,
1111 : : state->key_output_func, true);
1112 : :
944 alvherre@alvh.no-ip. 1113 [ + + ]: 741 : if (unique_keys)
1114 : : {
1115 : : /*
1116 : : * Copy the key first, instead of pointing into the buffer. It will be
1117 : : * added to the hash table, but the buffer may get reallocated as
1118 : : * we're appending more data to it. That would invalidate pointers to
1119 : : * keys in the current buffer.
1120 : : */
412 tomas.vondra@postgre 1121 : 654 : const char *key = MemoryContextStrdup(aggcontext,
1122 : 654 : &out->data[key_offset]);
1123 : :
944 alvherre@alvh.no-ip. 1124 [ + + ]: 654 : if (!json_unique_check_key(&state->unique_check.check, key, 0))
1125 [ + - ]: 18 : ereport(ERROR,
1126 : : errcode(ERRCODE_DUPLICATE_JSON_OBJECT_KEY_VALUE),
1127 : : errmsg("duplicate JSON object key value: %s", key));
1128 : :
1129 [ + + ]: 636 : if (skip)
1130 : 9 : PG_RETURN_POINTER(state);
1131 : : }
1132 : :
3693 andrew@dunslane.net 1133 : 714 : appendStringInfoString(state->str, " : ");
1134 : :
4098 tgl@sss.pgh.pa.us 1135 [ + + ]: 714 : if (PG_ARGISNULL(2))
1136 : 6 : arg = (Datum) 0;
1137 : : else
1138 : 708 : arg = PG_GETARG_DATUM(2);
1139 : :
830 amitlan@postgresql.o 1140 : 714 : datum_to_json_internal(arg, PG_ARGISNULL(2), state->str,
1141 : : state->val_category,
1142 : : state->val_output_func, false);
1143 : :
4291 andrew@dunslane.net 1144 : 714 : PG_RETURN_POINTER(state);
1145 : : }
1146 : :
1147 : : /*
1148 : : * json_object_agg aggregate function
1149 : : */
1150 : : Datum
944 alvherre@alvh.no-ip. 1151 : 75 : json_object_agg_transfn(PG_FUNCTION_ARGS)
1152 : : {
1153 : 75 : return json_object_agg_transfn_worker(fcinfo, false, false);
1154 : : }
1155 : :
1156 : : /*
1157 : : * json_object_agg_strict aggregate function
1158 : : */
1159 : : Datum
1160 : 30 : json_object_agg_strict_transfn(PG_FUNCTION_ARGS)
1161 : : {
1162 : 30 : return json_object_agg_transfn_worker(fcinfo, true, false);
1163 : : }
1164 : :
1165 : : /*
1166 : : * json_object_agg_unique aggregate function
1167 : : */
1168 : : Datum
1169 : 627 : json_object_agg_unique_transfn(PG_FUNCTION_ARGS)
1170 : : {
1171 : 627 : return json_object_agg_transfn_worker(fcinfo, false, true);
1172 : : }
1173 : :
1174 : : /*
1175 : : * json_object_agg_unique_strict aggregate function
1176 : : */
1177 : : Datum
1178 : 27 : json_object_agg_unique_strict_transfn(PG_FUNCTION_ARGS)
1179 : : {
1180 : 27 : return json_object_agg_transfn_worker(fcinfo, true, true);
1181 : : }
1182 : :
1183 : : /*
1184 : : * json_object_agg final function.
1185 : : */
1186 : : Datum
4291 andrew@dunslane.net 1187 : 52 : json_object_agg_finalfn(PG_FUNCTION_ARGS)
1188 : : {
1189 : : JsonAggState *state;
1190 : :
1191 : : /* cannot be called directly because of internal-type argument */
1192 [ - + ]: 52 : Assert(AggCheckCallContext(fcinfo, NULL));
1193 : :
3693 1194 [ + + ]: 52 : state = PG_ARGISNULL(0) ? NULL : (JsonAggState *) PG_GETARG_POINTER(0);
1195 : :
1196 : : /* NULL result for no rows in, as is standard with aggregates */
4291 1197 [ + + ]: 52 : if (state == NULL)
4051 1198 : 3 : PG_RETURN_NULL();
1199 : :
1200 : : /* Else return state with appropriate object terminator added */
3693 1201 : 49 : PG_RETURN_TEXT_P(catenate_stringinfo_string(state->str, " }"));
1202 : : }
1203 : :
1204 : : /*
1205 : : * Helper function for aggregates: return given StringInfo's contents plus
1206 : : * specified trailing string, as a text datum. We need this because aggregate
1207 : : * final functions are not allowed to modify the aggregate state.
1208 : : */
1209 : : static text *
3983 tgl@sss.pgh.pa.us 1210 : 111 : catenate_stringinfo_string(StringInfo buffer, const char *addon)
1211 : : {
1212 : : /* custom version of cstring_to_text_with_len */
1213 : 111 : int buflen = buffer->len;
1214 : 111 : int addlen = strlen(addon);
1215 : 111 : text *result = (text *) palloc(buflen + addlen + VARHDRSZ);
1216 : :
1217 : 111 : SET_VARSIZE(result, buflen + addlen + VARHDRSZ);
1218 : 111 : memcpy(VARDATA(result), buffer->data, buflen);
1219 : 111 : memcpy(VARDATA(result) + buflen, addon, addlen);
1220 : :
1221 : 111 : return result;
1222 : : }
1223 : :
1224 : : Datum
749 peter@eisentraut.org 1225 : 217 : json_build_object_worker(int nargs, const Datum *args, const bool *nulls, const Oid *types,
1226 : : bool absent_on_null, bool unique_keys)
1227 : : {
1228 : : int i;
4098 tgl@sss.pgh.pa.us 1229 : 217 : const char *sep = "";
1230 : : StringInfo result;
1231 : : JsonUniqueBuilderState unique_check;
1232 : :
4291 andrew@dunslane.net 1233 [ + + ]: 217 : if (nargs % 2 != 0)
1234 [ + - ]: 9 : ereport(ERROR,
1235 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1236 : : errmsg("argument list must have even number of elements"),
1237 : : /* translator: %s is a SQL function name */
1238 : : errhint("The arguments of %s must consist of alternating keys and values.",
1239 : : "json_build_object()")));
1240 : :
1241 : 208 : result = makeStringInfo();
1242 : :
1243 : 208 : appendStringInfoChar(result, '{');
1244 : :
944 alvherre@alvh.no-ip. 1245 [ + + ]: 208 : if (unique_keys)
1246 : 16 : json_unique_builder_init(&unique_check);
1247 : :
4291 andrew@dunslane.net 1248 [ + + ]: 443 : for (i = 0; i < nargs; i += 2)
1249 : : {
1250 : : StringInfo out;
1251 : : bool skip;
1252 : : int key_offset;
1253 : :
1254 : : /* Skip null values if absent_on_null */
944 alvherre@alvh.no-ip. 1255 [ + + + + ]: 281 : skip = absent_on_null && nulls[i + 1];
1256 : :
1257 [ + + ]: 281 : if (skip)
1258 : : {
1259 : : /* If key uniqueness check is needed we must save skipped keys */
1260 [ + + ]: 13 : if (!unique_keys)
1261 : 7 : continue;
1262 : :
1263 : 6 : out = json_unique_builder_get_throwawaybuf(&unique_check);
1264 : : }
1265 : : else
1266 : : {
1267 : 268 : appendStringInfoString(result, sep);
1268 : 268 : sep = ", ";
1269 : 268 : out = result;
1270 : : }
1271 : :
1272 : : /* process key */
2925 andrew@dunslane.net 1273 [ + + ]: 274 : if (nulls[i])
4291 1274 [ + - ]: 12 : ereport(ERROR,
1275 : : (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
1276 : : errmsg("null value not allowed for object key")));
1277 : :
1278 : : /* save key offset before appending it */
944 alvherre@alvh.no-ip. 1279 : 262 : key_offset = out->len;
1280 : :
1281 : 262 : add_json(args[i], false, out, types[i], true);
1282 : :
1283 [ + + ]: 244 : if (unique_keys)
1284 : : {
1285 : : /*
1286 : : * check key uniqueness after key appending
1287 : : *
1288 : : * Copy the key first, instead of pointing into the buffer. It
1289 : : * will be added to the hash table, but the buffer may get
1290 : : * reallocated as we're appending more data to it. That would
1291 : : * invalidate pointers to keys in the current buffer.
1292 : : */
412 tomas.vondra@postgre 1293 : 47 : const char *key = pstrdup(&out->data[key_offset]);
1294 : :
944 alvherre@alvh.no-ip. 1295 [ + + ]: 47 : if (!json_unique_check_key(&unique_check.check, key, 0))
1296 [ + - ]: 16 : ereport(ERROR,
1297 : : errcode(ERRCODE_DUPLICATE_JSON_OBJECT_KEY_VALUE),
1298 : : errmsg("duplicate JSON object key value: %s", key));
1299 : :
1300 [ + + ]: 31 : if (skip)
1301 : 3 : continue;
1302 : : }
1303 : :
4291 andrew@dunslane.net 1304 : 225 : appendStringInfoString(result, " : ");
1305 : :
1306 : : /* process value */
2925 1307 : 225 : add_json(args[i + 1], nulls[i + 1], result, types[i + 1], false);
1308 : : }
1309 : :
4291 1310 : 162 : appendStringInfoChar(result, '}');
1311 : :
944 alvherre@alvh.no-ip. 1312 : 162 : return PointerGetDatum(cstring_to_text_with_len(result->data, result->len));
1313 : : }
1314 : :
1315 : : /*
1316 : : * SQL function json_build_object(variadic "any")
1317 : : */
1318 : : Datum
1319 : 78 : json_build_object(PG_FUNCTION_ARGS)
1320 : : {
1321 : : Datum *args;
1322 : : bool *nulls;
1323 : : Oid *types;
1324 : :
1325 : : /* build argument values to build the object */
1326 : 78 : int nargs = extract_variadic_args(fcinfo, 0, true,
1327 : : &args, &types, &nulls);
1328 : :
1329 [ + + ]: 78 : if (nargs < 0)
1330 : 3 : PG_RETURN_NULL();
1331 : :
1332 : 75 : PG_RETURN_DATUM(json_build_object_worker(nargs, args, nulls, types, false, false));
1333 : : }
1334 : :
1335 : : /*
1336 : : * degenerate case of json_build_object where it gets 0 arguments.
1337 : : */
1338 : : Datum
4291 andrew@dunslane.net 1339 : 3 : json_build_object_noargs(PG_FUNCTION_ARGS)
1340 : : {
1341 : 3 : PG_RETURN_TEXT_P(cstring_to_text_with_len("{}", 2));
1342 : : }
1343 : :
1344 : : Datum
749 peter@eisentraut.org 1345 : 115 : json_build_array_worker(int nargs, const Datum *args, const bool *nulls, const Oid *types,
1346 : : bool absent_on_null)
1347 : : {
1348 : : int i;
4098 tgl@sss.pgh.pa.us 1349 : 115 : const char *sep = "";
1350 : : StringInfo result;
1351 : :
4291 andrew@dunslane.net 1352 : 115 : result = makeStringInfo();
1353 : :
1354 : 115 : appendStringInfoChar(result, '[');
1355 : :
1356 [ + + ]: 319 : for (i = 0; i < nargs; i++)
1357 : : {
944 alvherre@alvh.no-ip. 1358 [ + + + + ]: 204 : if (absent_on_null && nulls[i])
1359 : 9 : continue;
1360 : :
4098 tgl@sss.pgh.pa.us 1361 : 195 : appendStringInfoString(result, sep);
1362 : 195 : sep = ", ";
2925 andrew@dunslane.net 1363 : 195 : add_json(args[i], nulls[i], result, types[i], false);
1364 : : }
1365 : :
4291 1366 : 115 : appendStringInfoChar(result, ']');
1367 : :
944 alvherre@alvh.no-ip. 1368 : 115 : return PointerGetDatum(cstring_to_text_with_len(result->data, result->len));
1369 : : }
1370 : :
1371 : : /*
1372 : : * SQL function json_build_array(variadic "any")
1373 : : */
1374 : : Datum
1375 : 27 : json_build_array(PG_FUNCTION_ARGS)
1376 : : {
1377 : : Datum *args;
1378 : : bool *nulls;
1379 : : Oid *types;
1380 : :
1381 : : /* build argument values to build the object */
1382 : 27 : int nargs = extract_variadic_args(fcinfo, 0, true,
1383 : : &args, &types, &nulls);
1384 : :
1385 [ + + ]: 27 : if (nargs < 0)
1386 : 3 : PG_RETURN_NULL();
1387 : :
1388 : 24 : PG_RETURN_DATUM(json_build_array_worker(nargs, args, nulls, types, false));
1389 : : }
1390 : :
1391 : : /*
1392 : : * degenerate case of json_build_array where it gets 0 arguments.
1393 : : */
1394 : : Datum
4291 andrew@dunslane.net 1395 : 3 : json_build_array_noargs(PG_FUNCTION_ARGS)
1396 : : {
1397 : 3 : PG_RETURN_TEXT_P(cstring_to_text_with_len("[]", 2));
1398 : : }
1399 : :
1400 : : /*
1401 : : * SQL function json_object(text[])
1402 : : *
1403 : : * take a one or two dimensional array of text as key/value pairs
1404 : : * for a json object.
1405 : : */
1406 : : Datum
1407 : 24 : json_object(PG_FUNCTION_ARGS)
1408 : : {
1409 : 24 : ArrayType *in_array = PG_GETARG_ARRAYTYPE_P(0);
1410 : 24 : int ndims = ARR_NDIM(in_array);
1411 : : StringInfoData result;
1412 : : Datum *in_datums;
1413 : : bool *in_nulls;
1414 : : int in_count,
1415 : : count,
1416 : : i;
1417 : : text *rval;
1418 : :
1419 [ + + + + ]: 24 : switch (ndims)
1420 : : {
1421 : 3 : case 0:
1422 : 3 : PG_RETURN_DATUM(CStringGetTextDatum("{}"));
1423 : : break;
1424 : :
1425 : 9 : case 1:
1426 [ + + ]: 9 : if ((ARR_DIMS(in_array)[0]) % 2)
1427 [ + - ]: 3 : ereport(ERROR,
1428 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
1429 : : errmsg("array must have even number of elements")));
1430 : 6 : break;
1431 : :
1432 : 9 : case 2:
1433 [ + + ]: 9 : if ((ARR_DIMS(in_array)[1]) != 2)
1434 [ + - ]: 6 : ereport(ERROR,
1435 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
1436 : : errmsg("array must have two columns")));
1437 : 3 : break;
1438 : :
1439 : 3 : default:
1440 [ + - ]: 3 : ereport(ERROR,
1441 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
1442 : : errmsg("wrong number of array subscripts")));
1443 : : }
1444 : :
1215 peter@eisentraut.org 1445 : 9 : deconstruct_array_builtin(in_array, TEXTOID, &in_datums, &in_nulls, &in_count);
1446 : :
4291 andrew@dunslane.net 1447 : 9 : count = in_count / 2;
1448 : :
1449 : 9 : initStringInfo(&result);
1450 : :
1451 : 9 : appendStringInfoChar(&result, '{');
1452 : :
1453 [ + + ]: 933 : for (i = 0; i < count; ++i)
1454 : : {
1455 [ - + ]: 924 : if (in_nulls[i * 2])
4291 andrew@dunslane.net 1456 [ # # ]:UBC 0 : ereport(ERROR,
1457 : : (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
1458 : : errmsg("null value not allowed for object key")));
1459 : :
4291 andrew@dunslane.net 1460 [ + + ]:CBC 924 : if (i > 0)
1461 : 915 : appendStringInfoString(&result, ", ");
458 drowley@postgresql.o 1462 : 924 : escape_json_text(&result, (text *) DatumGetPointer(in_datums[i * 2]));
4291 andrew@dunslane.net 1463 : 924 : appendStringInfoString(&result, " : ");
1464 [ + + ]: 924 : if (in_nulls[i * 2 + 1])
1465 : 6 : appendStringInfoString(&result, "null");
1466 : : else
1467 : : {
458 drowley@postgresql.o 1468 : 918 : escape_json_text(&result,
1469 : 918 : (text *) DatumGetPointer(in_datums[i * 2 + 1]));
1470 : : }
1471 : : }
1472 : :
4291 andrew@dunslane.net 1473 : 9 : appendStringInfoChar(&result, '}');
1474 : :
1475 : 9 : pfree(in_datums);
1476 : 9 : pfree(in_nulls);
1477 : :
1478 : 9 : rval = cstring_to_text_with_len(result.data, result.len);
1479 : 9 : pfree(result.data);
1480 : :
1481 : 9 : PG_RETURN_TEXT_P(rval);
1482 : : }
1483 : :
1484 : : /*
1485 : : * SQL function json_object(text[], text[])
1486 : : *
1487 : : * take separate key and value arrays of text to construct a json object
1488 : : * pairwise.
1489 : : */
1490 : : Datum
1491 : 21 : json_object_two_arg(PG_FUNCTION_ARGS)
1492 : : {
1493 : 21 : ArrayType *key_array = PG_GETARG_ARRAYTYPE_P(0);
1494 : 21 : ArrayType *val_array = PG_GETARG_ARRAYTYPE_P(1);
1495 : 21 : int nkdims = ARR_NDIM(key_array);
1496 : 21 : int nvdims = ARR_NDIM(val_array);
1497 : : StringInfoData result;
1498 : : Datum *key_datums,
1499 : : *val_datums;
1500 : : bool *key_nulls,
1501 : : *val_nulls;
1502 : : int key_count,
1503 : : val_count,
1504 : : i;
1505 : : text *rval;
1506 : :
1507 [ + + - + ]: 21 : if (nkdims > 1 || nkdims != nvdims)
1508 [ + - ]: 3 : ereport(ERROR,
1509 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
1510 : : errmsg("wrong number of array subscripts")));
1511 : :
1512 [ + + ]: 18 : if (nkdims == 0)
1513 : 3 : PG_RETURN_DATUM(CStringGetTextDatum("{}"));
1514 : :
1215 peter@eisentraut.org 1515 : 15 : deconstruct_array_builtin(key_array, TEXTOID, &key_datums, &key_nulls, &key_count);
1516 : 15 : deconstruct_array_builtin(val_array, TEXTOID, &val_datums, &val_nulls, &val_count);
1517 : :
4291 andrew@dunslane.net 1518 [ + + ]: 15 : if (key_count != val_count)
1519 [ + - ]: 6 : ereport(ERROR,
1520 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
1521 : : errmsg("mismatched array dimensions")));
1522 : :
1523 : 9 : initStringInfo(&result);
1524 : :
1525 : 9 : appendStringInfoChar(&result, '{');
1526 : :
1527 [ + + ]: 39 : for (i = 0; i < key_count; ++i)
1528 : : {
1529 [ + + ]: 33 : if (key_nulls[i])
1530 [ + - ]: 3 : ereport(ERROR,
1531 : : (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
1532 : : errmsg("null value not allowed for object key")));
1533 : :
1534 [ + + ]: 30 : if (i > 0)
1535 : 21 : appendStringInfoString(&result, ", ");
458 drowley@postgresql.o 1536 : 30 : escape_json_text(&result, (text *) DatumGetPointer(key_datums[i]));
4291 andrew@dunslane.net 1537 : 30 : appendStringInfoString(&result, " : ");
1538 [ - + ]: 30 : if (val_nulls[i])
4291 andrew@dunslane.net 1539 :UBC 0 : appendStringInfoString(&result, "null");
1540 : : else
458 drowley@postgresql.o 1541 :CBC 30 : escape_json_text(&result,
1542 : 30 : (text *) DatumGetPointer(val_datums[i]));
1543 : : }
1544 : :
4291 andrew@dunslane.net 1545 : 6 : appendStringInfoChar(&result, '}');
1546 : :
1547 : 6 : pfree(key_datums);
1548 : 6 : pfree(key_nulls);
1549 : 6 : pfree(val_datums);
1550 : 6 : pfree(val_nulls);
1551 : :
1552 : 6 : rval = cstring_to_text_with_len(result.data, result.len);
1553 : 6 : pfree(result.data);
1554 : :
1555 : 6 : PG_RETURN_TEXT_P(rval);
1556 : : }
1557 : :
1558 : : /*
1559 : : * escape_json_char
1560 : : * Inline helper function for escape_json* functions
1561 : : */
1562 : : static pg_attribute_always_inline void
458 drowley@postgresql.o 1563 : 2218173 : escape_json_char(StringInfo buf, char c)
1564 : : {
1565 [ + + + + : 2218173 : switch (c)
+ + + + ]
1566 : : {
1567 : 9 : case '\b':
1568 : 9 : appendStringInfoString(buf, "\\b");
1569 : 9 : break;
1570 : 3 : case '\f':
1571 : 3 : appendStringInfoString(buf, "\\f");
1572 : 3 : break;
1573 : 12 : case '\n':
1574 : 12 : appendStringInfoString(buf, "\\n");
1575 : 12 : break;
1576 : 3 : case '\r':
1577 : 3 : appendStringInfoString(buf, "\\r");
1578 : 3 : break;
1579 : 90 : case '\t':
1580 : 90 : appendStringInfoString(buf, "\\t");
1581 : 90 : break;
1582 : 315 : case '"':
1583 : 315 : appendStringInfoString(buf, "\\\"");
1584 : 315 : break;
1585 : 45 : case '\\':
1586 : 45 : appendStringInfoString(buf, "\\\\");
1587 : 45 : break;
1588 : 2217696 : default:
1589 [ + + ]: 2217696 : if ((unsigned char) c < ' ')
1590 : 3 : appendStringInfo(buf, "\\u%04x", (int) c);
1591 : : else
1592 [ + + ]: 2217693 : appendStringInfoCharMacro(buf, c);
1593 : 2217696 : break;
1594 : : }
1595 : 2218173 : }
1596 : :
1597 : : /*
1598 : : * escape_json
1599 : : * Produce a JSON string literal, properly escaping the NUL-terminated
1600 : : * cstring.
1601 : : */
1602 : : void
5016 andrew@dunslane.net 1603 : 19740 : escape_json(StringInfo buf, const char *str)
1604 : : {
458 drowley@postgresql.o 1605 [ + + ]: 19740 : appendStringInfoCharMacro(buf, '"');
1606 : :
1607 [ + + ]: 274626 : for (; *str != '\0'; str++)
1608 : 254886 : escape_json_char(buf, *str);
1609 : :
3598 peter_e@gmx.net 1610 [ + + ]: 19740 : appendStringInfoCharMacro(buf, '"');
458 drowley@postgresql.o 1611 : 19740 : }
1612 : :
1613 : : /*
1614 : : * Define the number of bytes that escape_json_with_len will look ahead in the
1615 : : * input string before flushing the input string to the destination buffer.
1616 : : * Looking ahead too far could result in cachelines being evicted that will
1617 : : * need to be reloaded in order to perform the appendBinaryStringInfo call.
1618 : : * Smaller values will result in a larger number of calls to
1619 : : * appendBinaryStringInfo and introduce additional function call overhead.
1620 : : * Values larger than the size of L1d cache will likely result in worse
1621 : : * performance.
1622 : : */
1623 : : #define ESCAPE_JSON_FLUSH_AFTER 512
1624 : :
1625 : : /*
1626 : : * escape_json_with_len
1627 : : * Produce a JSON string literal, properly escaping the possibly not
1628 : : * NUL-terminated characters in 'str'. 'len' defines the number of bytes
1629 : : * from 'str' to process.
1630 : : */
1631 : : void
1632 : 198930 : escape_json_with_len(StringInfo buf, const char *str, int len)
1633 : : {
1634 : : int vlen;
1635 : :
449 1636 [ - + ]: 198930 : Assert(len >= 0);
1637 : :
1638 : : /*
1639 : : * Since we know the minimum length we'll need to append, let's just
1640 : : * enlarge the buffer now rather than incrementally making more space when
1641 : : * we run out. Add two extra bytes for the enclosing quotes.
1642 : : */
1643 : 198930 : enlargeStringInfo(buf, len + 2);
1644 : :
1645 : : /*
1646 : : * Figure out how many bytes to process using SIMD. Round 'len' down to
1647 : : * the previous multiple of sizeof(Vector8), assuming that's a power-of-2.
1648 : : */
1649 : 198930 : vlen = len & (int) (~(sizeof(Vector8) - 1));
1650 : :
3598 peter_e@gmx.net 1651 [ - + ]: 198930 : appendStringInfoCharMacro(buf, '"');
1652 : :
449 drowley@postgresql.o 1653 : 198930 : for (int i = 0, copypos = 0;;)
1654 : : {
1655 : : /*
1656 : : * To speed this up, try searching sizeof(Vector8) bytes at once for
1657 : : * special characters that we need to escape. When we find one, we
1658 : : * fall out of the Vector8 loop and copy the portion we've vector
1659 : : * searched and then we process sizeof(Vector8) bytes one byte at a
1660 : : * time. Once done, come back and try doing vector searching again.
1661 : : * We'll also process any remaining bytes at the tail end of the
1662 : : * string byte-by-byte. This optimization assumes that most chunks of
1663 : : * sizeof(Vector8) bytes won't contain any special characters.
1664 : : */
1665 [ + + ]: 213495 : for (; i < vlen; i += sizeof(Vector8))
1666 : : {
1667 : : Vector8 chunk;
1668 : :
1669 : 14565 : vector8_load(&chunk, (const uint8 *) &str[i]);
1670 : :
1671 : : /*
1672 : : * Break on anything less than ' ' or if we find a '"' or '\\'.
1673 : : * Those need special handling. That's done in the per-byte loop.
1674 : : */
1675 [ + + + + ]: 29094 : if (vector8_has_le(chunk, (unsigned char) 0x1F) ||
1676 [ + + ]: 29055 : vector8_has(chunk, (unsigned char) '"') ||
1677 : 14526 : vector8_has(chunk, (unsigned char) '\\'))
1678 : : break;
1679 : :
1680 : : #ifdef ESCAPE_JSON_FLUSH_AFTER
1681 : :
1682 : : /*
1683 : : * Flush what's been checked so far out to the destination buffer
1684 : : * every so often to avoid having to re-read cachelines when
1685 : : * escaping large strings.
1686 : : */
1687 [ + + ]: 14508 : if (i - copypos >= ESCAPE_JSON_FLUSH_AFTER)
1688 : : {
1689 : 15 : appendBinaryStringInfo(buf, &str[copypos], i - copypos);
1690 : 15 : copypos = i;
1691 : : }
1692 : : #endif
1693 : : }
1694 : :
1695 : : /*
1696 : : * Write to the destination up to the point that we've vector searched
1697 : : * so far. Do this only when switching into per-byte mode rather than
1698 : : * once every sizeof(Vector8) bytes.
1699 : : */
1700 [ + + ]: 198987 : if (copypos < i)
1701 : : {
1702 : 13288 : appendBinaryStringInfo(buf, &str[copypos], i - copypos);
1703 : 13288 : copypos = i;
1704 : : }
1705 : :
1706 : : /*
1707 : : * Per-byte loop for Vector8s containing special chars and for
1708 : : * processing the tail of the string.
1709 : : */
1710 [ + + ]: 2162274 : for (int b = 0; b < sizeof(Vector8); b++)
1711 : : {
1712 : : /* check if we've finished */
1713 [ + + ]: 2162217 : if (i == len)
1714 : 198930 : goto done;
1715 : :
1716 [ - + ]: 1963287 : Assert(i < len);
1717 : :
1718 : 1963287 : escape_json_char(buf, str[i++]);
1719 : : }
1720 : :
1721 : 57 : copypos = i;
1722 : : /* We're not done yet. Try the vector search again. */
1723 : : }
1724 : :
1725 : 198930 : done:
458 1726 [ - + ]: 198930 : appendStringInfoCharMacro(buf, '"');
1727 : 198930 : }
1728 : :
1729 : : /*
1730 : : * escape_json_text
1731 : : * Append 'txt' onto 'buf' and escape using escape_json_with_len.
1732 : : *
1733 : : * This is more efficient than calling text_to_cstring and appending the
1734 : : * result as that could require an additional palloc and memcpy.
1735 : : */
1736 : : void
1737 : 2415 : escape_json_text(StringInfo buf, const text *txt)
1738 : : {
1739 : : /* must cast away the const, unfortunately */
1740 : 2415 : text *tunpacked = pg_detoast_datum_packed(unconstify(text *, txt));
1741 [ - + - - : 2415 : int len = VARSIZE_ANY_EXHDR(tunpacked);
- - - - +
+ ]
1742 : : char *str;
1743 : :
1744 [ + + ]: 2415 : str = VARDATA_ANY(tunpacked);
1745 : :
1746 : 2415 : escape_json_with_len(buf, str, len);
1747 : :
1748 : : /* pfree any detoasted values */
1749 [ - + ]: 2415 : if (tunpacked != txt)
458 drowley@postgresql.o 1750 :UBC 0 : pfree(tunpacked);
5016 andrew@dunslane.net 1751 :CBC 2415 : }
1752 : :
1753 : : /* Semantic actions for key uniqueness check */
1754 : : static JsonParseErrorType
942 alvherre@alvh.no-ip. 1755 : 90 : json_unique_object_start(void *_state)
1756 : : {
1757 : 90 : JsonUniqueParsingState *state = _state;
1758 : : JsonUniqueStackEntry *entry;
1759 : :
1760 [ - + ]: 90 : if (!state->unique)
942 alvherre@alvh.no-ip. 1761 :UBC 0 : return JSON_SUCCESS;
1762 : :
1763 : : /* push object entry to stack */
942 alvherre@alvh.no-ip. 1764 :CBC 90 : entry = palloc(sizeof(*entry));
1765 : 90 : entry->object_id = state->id_counter++;
1766 : 90 : entry->parent = state->stack;
1767 : 90 : state->stack = entry;
1768 : :
1769 : 90 : return JSON_SUCCESS;
1770 : : }
1771 : :
1772 : : static JsonParseErrorType
1773 : 87 : json_unique_object_end(void *_state)
1774 : : {
1775 : 87 : JsonUniqueParsingState *state = _state;
1776 : : JsonUniqueStackEntry *entry;
1777 : :
1778 [ + + ]: 87 : if (!state->unique)
1779 : 33 : return JSON_SUCCESS;
1780 : :
1781 : 54 : entry = state->stack;
1782 : 54 : state->stack = entry->parent; /* pop object from stack */
1783 : 54 : pfree(entry);
1784 : 54 : return JSON_SUCCESS;
1785 : : }
1786 : :
1787 : : static JsonParseErrorType
1788 : 130 : json_unique_object_field_start(void *_state, char *field, bool isnull)
1789 : : {
1790 : 130 : JsonUniqueParsingState *state = _state;
1791 : : JsonUniqueStackEntry *entry;
1792 : :
1793 [ - + ]: 130 : if (!state->unique)
942 alvherre@alvh.no-ip. 1794 :UBC 0 : return JSON_SUCCESS;
1795 : :
1796 : : /* find key collision in the current object */
942 alvherre@alvh.no-ip. 1797 [ + + ]:CBC 130 : if (json_unique_check_key(&state->check, field, state->stack->object_id))
1798 : 107 : return JSON_SUCCESS;
1799 : :
1800 : 23 : state->unique = false;
1801 : :
1802 : : /* pop all objects entries */
1803 [ + + ]: 56 : while ((entry = state->stack))
1804 : : {
1805 : 33 : state->stack = entry->parent;
1806 : 33 : pfree(entry);
1807 : : }
1808 : 23 : return JSON_SUCCESS;
1809 : : }
1810 : :
1811 : : /* Validate JSON text and additionally check key uniqueness */
1812 : : bool
1813 : 661 : json_validate(text *json, bool check_unique_keys, bool throw_error)
1814 : : {
1815 : : JsonLexContext lex;
1816 : 661 : JsonSemAction uniqueSemAction = {0};
1817 : : JsonUniqueParsingState state;
1818 : : JsonParseErrorType result;
1819 : :
754 1820 : 661 : makeJsonLexContext(&lex, json, check_unique_keys);
1821 : :
942 1822 [ + + ]: 661 : if (check_unique_keys)
1823 : : {
754 1824 : 116 : state.lex = &lex;
942 1825 : 116 : state.stack = NULL;
1826 : 116 : state.id_counter = 0;
1827 : 116 : state.unique = true;
1828 : 116 : json_unique_check_init(&state.check);
1829 : :
1830 : 116 : uniqueSemAction.semstate = &state;
1831 : 116 : uniqueSemAction.object_start = json_unique_object_start;
1832 : 116 : uniqueSemAction.object_field_start = json_unique_object_field_start;
1833 : 116 : uniqueSemAction.object_end = json_unique_object_end;
1834 : : }
1835 : :
754 1836 [ + + ]: 661 : result = pg_parse_json(&lex, check_unique_keys ? &uniqueSemAction : &nullSemAction);
1837 : :
942 1838 [ + + ]: 661 : if (result != JSON_SUCCESS)
1839 : : {
1840 [ - + ]: 108 : if (throw_error)
754 alvherre@alvh.no-ip. 1841 :UBC 0 : json_errsave_error(result, &lex, NULL);
1842 : :
942 alvherre@alvh.no-ip. 1843 :CBC 108 : return false; /* invalid json */
1844 : : }
1845 : :
1846 [ + + + + ]: 553 : if (check_unique_keys && !state.unique)
1847 : : {
1848 [ + + ]: 23 : if (throw_error)
1849 [ + - ]: 4 : ereport(ERROR,
1850 : : (errcode(ERRCODE_DUPLICATE_JSON_OBJECT_KEY_VALUE),
1851 : : errmsg("duplicate JSON object key value")));
1852 : :
1853 : 19 : return false; /* not unique keys */
1854 : : }
1855 : :
754 1856 [ + + ]: 530 : if (check_unique_keys)
1857 : 81 : freeJsonLexContext(&lex);
1858 : :
942 1859 : 530 : return true; /* ok */
1860 : : }
1861 : :
1862 : : /*
1863 : : * SQL function json_typeof(json) -> text
1864 : : *
1865 : : * Returns the type of the outermost JSON value as TEXT. Possible types are
1866 : : * "object", "array", "string", "number", "boolean", and "null".
1867 : : *
1868 : : * Performs a single call to json_lex() to get the first token of the supplied
1869 : : * value. This initial token uniquely determines the value's type. As our
1870 : : * input must already have been validated by json_in() or json_recv(), the
1871 : : * initial token should never be JSON_TOKEN_OBJECT_END, JSON_TOKEN_ARRAY_END,
1872 : : * JSON_TOKEN_COLON, JSON_TOKEN_COMMA, or JSON_TOKEN_END.
1873 : : */
1874 : : Datum
4401 andrew@dunslane.net 1875 : 30 : json_typeof(PG_FUNCTION_ARGS)
1876 : : {
942 alvherre@alvh.no-ip. 1877 : 30 : text *json = PG_GETARG_TEXT_PP(0);
1878 : : JsonLexContext lex;
1879 : : char *type;
1880 : : JsonParseErrorType result;
1881 : :
1882 : : /* Lex exactly one token from the input and check its type. */
754 1883 : 30 : makeJsonLexContext(&lex, json, false);
1884 : 30 : result = json_lex(&lex);
1153 andrew@dunslane.net 1885 [ - + ]: 30 : if (result != JSON_SUCCESS)
754 alvherre@alvh.no-ip. 1886 :UBC 0 : json_errsave_error(result, &lex, NULL);
1887 : :
754 alvherre@alvh.no-ip. 1888 [ + + + + :CBC 30 : switch (lex.token_type)
+ + - ]
1889 : : {
4297 andrew@dunslane.net 1890 : 6 : case JSON_TOKEN_OBJECT_START:
1891 : 6 : type = "object";
1892 : 6 : break;
1893 : 6 : case JSON_TOKEN_ARRAY_START:
1894 : 6 : type = "array";
1895 : 6 : break;
1896 : 3 : case JSON_TOKEN_STRING:
1897 : 3 : type = "string";
1898 : 3 : break;
1899 : 6 : case JSON_TOKEN_NUMBER:
1900 : 6 : type = "number";
1901 : 6 : break;
1902 : 6 : case JSON_TOKEN_TRUE:
1903 : : case JSON_TOKEN_FALSE:
1904 : 6 : type = "boolean";
1905 : 6 : break;
1906 : 3 : case JSON_TOKEN_NULL:
1907 : 3 : type = "null";
1908 : 3 : break;
4297 andrew@dunslane.net 1909 :UBC 0 : default:
754 alvherre@alvh.no-ip. 1910 [ # # ]: 0 : elog(ERROR, "unexpected json token: %d", lex.token_type);
1911 : : }
1912 : :
4370 peter_e@gmx.net 1913 :CBC 30 : PG_RETURN_TEXT_P(cstring_to_text(type));
1914 : : }
|
