Skip to content

Commit

Permalink
- Added api get_default_options, get_options and set_options to…
Browse files Browse the repository at this point in the history 
… `json_utils`package to configure (`Pretty`, `AsciiOutput` and `EscapeSolitus`) the output.

- Added support for formatted (pretty) json output with the option `Pretty`.
- Fixed another error when converting `\f` and `\r`.
  • Loading branch information
@doberkofler
doberkofler committed Mar 9, 2020
1 parent 2489cc9 commit 056d377
Show file tree
Hide file tree
Showing 9 changed files with 296 additions and 62 deletions.
15 changes: 13 additions & 2 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,28 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
### Fixed


## [0.6.0] - 2020-03-09

### Changed
- Added api `get_default_options`, `get_options` and `set_options` to `json_utils`package to configure (`Pretty`, `AsciiOutput` and `EscapeSolitus`) the output.
- Added support for formatted (pretty) json output with the option `Pretty`.


### Fixed
- Fixed another error when converting `\f` and `\r`.


## [0.5.0] - 2020-03-08

### Changed
- No longer install debug module by default.
- Removed package json_cost and json_clob.
- Removed package `json_cost` and `json_clob`.
- Removed the obsolete performance tests.


### Fixed
- Required naming changes to run on current Oracle versions that now also have json support.
- Fixed an error when converting \f and \r.
- Fixed an error when converting `\f` and `\r`.


## [0.4.1] - 2016-12-22
Expand Down
199 changes: 160 additions & 39 deletions json_utils.pkb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,56 @@ CREATE OR REPLACE
PACKAGE BODY json_utils
IS

outputOptions OutputOptionsType;

NEW_LINE CONSTANT VARCHAR2(2) := '
';
INDENTATION_CHARACTER CONSTANT VARCHAR2(1) := ' ';

PROCEDURE copySubNodes(theTarget IN OUT NOCOPY jsonNodes, theFirstID IN OUT NOCOPY BINARY_INTEGER, theParentID IN BINARY_INTEGER, theSource IN jsonNodes, theFirstSourceID IN BINARY_INTEGER);
FUNCTION boolean_to_json(theBoolean IN NUMBER) RETURN VARCHAR2;
FUNCTION number_to_json(theNumber IN NUMBER) RETURN VARCHAR2;
FUNCTION get_gap(theIndentation IN INTEGER) RETURN VARCHAR2;
PROCEDURE escapeLOB(theInputLob IN CLOB, theLobBuf IN OUT NOCOPY CLOB, theStrBuf IN OUT NOCOPY VARCHAR2, theAsciiOutput IN BOOLEAN DEFAULT TRUE, theEscapeSolitus IN BOOLEAN DEFAULT FALSE);

----------------------------------------------------------
-- get_default_options
--
FUNCTION get_default_options RETURN outputOptionsType
IS
aOptions outputOptionsType;
BEGIN
RETURN aOptions;
END get_default_options;

----------------------------------------------------------
-- get_options
--
FUNCTION get_options RETURN outputOptionsType
IS
BEGIN
RETURN outputOptions;
END get_options;

----------------------------------------------------------
-- set_options
--
PROCEDURE set_options(theOptions IN outputOptionsType)
IS
BEGIN
outputOptions := theOptions;
END set_options;

----------------------------------------------------------
-- get_default_output_options
--
FUNCTION get_default_output_options RETURN OutputOptionsType
IS
aOptions OutputOptionsType;
BEGIN
RETURN aOptions;
END get_default_output_options;

----------------------------------------------------------
-- add_string
--
Expand Down Expand Up @@ -483,17 +528,22 @@ END removeNode;
----------------------------------------------------------
-- value_to_clob
--
PROCEDURE value_to_clob(theLobBuf IN OUT NOCOPY CLOB, theStrBuf IN OUT NOCOPY VARCHAR2, theNodes IN jsonNodes, theNodeID IN NUMBER)
PROCEDURE value_to_clob(theLobBuf IN OUT NOCOPY CLOB, theStrBuf IN OUT NOCOPY VARCHAR2, theNodes IN jsonNodes, theNodeID IN NUMBER, theIndentation IN OUT INTEGER)
IS
aNode jsonNode := theNodes(theNodeID);
PRAGMA INLINE (get_gap, 'YES');
GAP CONSTANT VARCHAR2(32767) := get_gap(theIndentation);

aName VARCHAR2(32767);
aCLOB CLOB;
aNode jsonNode := theNodes(theNodeID);
aName VARCHAR2(32767);
aCLOB CLOB;
BEGIN
-- Add the property name
IF (aNode.nam IS NOT NULL) THEN
PRAGMA INLINE (escape, 'YES');
aName := '"' || escape(aNode.nam) || '":';
aName := GAP || '"' || escape(theString=>aNode.nam, theAsciiOutput=>outputOptions.AsciiOutput, theEscapeSolitus=>outputOptions.EscapeSolitus) || '":';
IF (outputOptions.Pretty) THEN
aName := aName || ' ';
END IF;

PRAGMA INLINE (add_string, 'YES');
json_utils.add_string(theLobBuf, theStrBuf, aName);
Expand All @@ -504,36 +554,36 @@ BEGIN

WHEN json_utils.NODE_TYPE_NULL THEN
PRAGMA INLINE (add_string, 'YES');
json_utils.add_string(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theValue=>'null');
json_utils.add_string(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theValue=>GAP || 'null');

WHEN json_utils.NODE_TYPE_STRING THEN
PRAGMA INLINE (escape, 'YES');
json_utils.add_string(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theValue=>'"' || escape(aNode.str) || '"');
json_utils.add_string(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theValue=>GAP || '"' || escape(theString=>aNode.str, theAsciiOutput=>outputOptions.AsciiOutput, theEscapeSolitus=>outputOptions.EscapeSolitus) || '"');

WHEN json_utils.NODE_TYPE_LOB THEN
PRAGMA INLINE (add_string, 'YES');
json_utils.add_string(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theValue=>'"');
json_utils.add_string(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theValue=>GAP || '"');
PRAGMA INLINE (escapeLOB, 'YES');
escapeLOB(theInputLob=>aNode.lob, theLobBuf=>theLobBuf, theStrBuf=>theStrBuf);
escapeLOB(theInputLob=>aNode.lob, theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theAsciiOutput=>outputOptions.AsciiOutput, theEscapeSolitus=>outputOptions.EscapeSolitus);
PRAGMA INLINE (add_string, 'YES');
json_utils.add_string(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theValue=>'"');

WHEN json_utils.NODE_TYPE_NUMBER THEN
PRAGMA INLINE (number_to_json, 'YES');
json_utils.add_string(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theValue=>number_to_json(aNode.num));
json_utils.add_string(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theValue=>GAP || number_to_json(aNode.num));

WHEN json_utils.NODE_TYPE_DATE THEN
json_utils.add_string(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theValue=>'"' || TO_CHAR(aNode.dat, 'FXYYYY-MM-DD"T"HH24:MI:SS') || '"');
json_utils.add_string(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theValue=>GAP || '"' || TO_CHAR(aNode.dat, 'FXYYYY-MM-DD"T"HH24:MI:SS') || '"');

WHEN json_utils.NODE_TYPE_BOOLEAN THEN
PRAGMA INLINE (boolean_to_json, 'YES');
json_utils.add_string(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theValue=>boolean_to_json(aNode.num));
json_utils.add_string(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theValue=>GAP || boolean_to_json(aNode.num));

WHEN json_utils.NODE_TYPE_OBJECT THEN
json_utils.object_to_clob(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theNodes=>theNodes, theNodeID=>theNodes(theNodeID).sub, theFlushToLOB=>FALSE);
json_utils.object_to_clob(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theNodes=>theNodes, theNodeID=>theNodes(theNodeID).sub, theIndentation=>theIndentation, theFlushToLOB=>FALSE);

WHEN json_utils.NODE_TYPE_ARRAY THEN
json_utils.array_to_clob(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theNodes=>theNodes, theNodeID=>theNodes(theNodeID).sub, theFlushToLOB=>FALSE);
json_utils.array_to_clob(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theNodes=>theNodes, theNodeID=>theNodes(theNodeID).sub, theIndentation=>theIndentation, theFlushToLOB=>FALSE);

ELSE
raise_application_error(-20100, 'Invalid node type: '||aNode.typ, TRUE);
Expand All @@ -543,29 +593,58 @@ END value_to_clob;
----------------------------------------------------------
-- object_to_clob
--
PROCEDURE object_to_clob(theLobBuf IN OUT NOCOPY CLOB, theStrBuf IN OUT NOCOPY VARCHAR2, theNodes IN jsonNodes, theNodeID IN NUMBER, theFlushToLOB IN BOOLEAN DEFAULT TRUE)
PROCEDURE object_to_clob(theLobBuf IN OUT NOCOPY CLOB, theStrBuf IN OUT NOCOPY VARCHAR2, theNodes IN jsonNodes, theNodeID IN NUMBER, theIndentation IN OUT INTEGER, theFlushToLOB IN BOOLEAN DEFAULT TRUE)
IS
i BINARY_INTEGER := theNodeID;
PRAGMA INLINE (get_gap, 'YES');
GAP CONSTANT VARCHAR2(32767) := get_gap(theIndentation);

aBracket VARCHAR2(32767);
aDelimiter VARCHAR2(32767);
aNodeID BINARY_INTEGER := theNodeID;
BEGIN
-- Serialize the object
-- open bracket {
IF (outputOptions.Pretty) THEN
aBracket := '{' || NEW_LINE;
ELSE
aBracket := '{';
END IF;
PRAGMA INLINE (add_string, 'YES');
json_utils.add_string(theLobBuf, theStrBuf, '{');
WHILE (i IS NOT NULL) LOOP
json_utils.add_string(theLobBuf, theStrBuf, aBracket);

-- compute the delimiter
IF (outputOptions.Pretty) THEN
aDelimiter := ',' || NEW_LINE;
ELSE
aDelimiter := ',';
END IF;

-- process all properties in the object
WHILE (aNodeID IS NOT NULL) LOOP
-- Add separator from last property if we are not the first one
IF (i != theNodeID) THEN
IF (aNodeID != theNodeID) THEN
PRAGMA INLINE (add_string, 'YES');
json_utils.add_string(theLobBuf, theStrBuf, ',');
json_utils.add_string(theLobBuf, theStrBuf, aDelimiter);
END IF;

-- Add the property pair
theIndentation := theIndentation + 1;
--PRAGMA INLINE (value_to_clob, 'YES');
json_utils.value_to_clob(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theNodes=>theNodes, theNodeID=>i);
json_utils.value_to_clob(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theNodes=>theNodes, theNodeID=>aNodeID, theIndentation=>theIndentation);
theIndentation := theIndentation -+ 1;

i := theNodes(i).nex;
aNodeID := theNodes(aNodeID).nex;
END LOOP;

-- close bracket }
IF (outputOptions.Pretty) THEN
aBracket := NEW_LINE || GAP || '}';
ELSE
aBracket := GAP || '}';
END IF;
PRAGMA INLINE (add_string, 'YES');
json_utils.add_string(theLobBuf, theStrBuf, '}');
json_utils.add_string(theLobBuf, theStrBuf, aBracket);

-- flush
IF (theFlushToLOB) THEN
json_utils.flush_clob(theLobBuf, theStrBuf);
END IF;
Expand All @@ -574,29 +653,58 @@ END object_to_clob;
----------------------------------------------------------
-- array_to_clob
--
PROCEDURE array_to_clob(theLobBuf IN OUT NOCOPY CLOB, theStrBuf IN OUT NOCOPY VARCHAR2, theNodes IN jsonNodes, theNodeID IN NUMBER, theFlushToLOB IN BOOLEAN DEFAULT TRUE)
PROCEDURE array_to_clob(theLobBuf IN OUT NOCOPY CLOB, theStrBuf IN OUT NOCOPY VARCHAR2, theNodes IN jsonNodes, theNodeID IN NUMBER, theIndentation IN OUT INTEGER, theFlushToLOB IN BOOLEAN DEFAULT TRUE)
IS
i BINARY_INTEGER := theNodeID;
PRAGMA INLINE (get_gap, 'YES');
GAP CONSTANT VARCHAR2(32767) := get_gap(theIndentation);

aBracket VARCHAR2(32767);
aDelimiter VARCHAR2(32767);
aNodeID BINARY_INTEGER := theNodeID;
BEGIN
-- Serialize the object
-- open bracket {
IF (outputOptions.Pretty) THEN
aBracket := '[' || NEW_LINE;
ELSE
aBracket := '[';
END IF;
PRAGMA INLINE (add_string, 'YES');
json_utils.add_string(theLobBuf, theStrBuf, '[');
WHILE (i IS NOT NULL) LOOP
json_utils.add_string(theLobBuf, theStrBuf, aBracket);

-- compute the delimiter
IF (outputOptions.Pretty) THEN
aDelimiter := ',' || NEW_LINE;
ELSE
aDelimiter := ',';
END IF;

-- process all properties in the object
WHILE (aNodeID IS NOT NULL) LOOP
-- Add separator from last array entry if we are not the first one
IF (i != theNodeID) THEN
IF (aNodeID != theNodeID) THEN
PRAGMA INLINE (add_string, 'YES');
json_utils.add_string(theLobBuf, theStrBuf, ',');
json_utils.add_string(theLobBuf, theStrBuf, aDelimiter);
END IF;

-- Add the property pair
theIndentation := theIndentation + 1;
PRAGMA INLINE (value_to_clob, 'YES');
json_utils.value_to_clob(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theNodes=>theNodes, theNodeID=>i);
json_utils.value_to_clob(theLobBuf=>theLobBuf, theStrBuf=>theStrBuf, theNodes=>theNodes, theNodeID=>aNodeID, theIndentation=>theIndentation);
theIndentation := theIndentation - 1;

i := theNodes(i).nex;
aNodeID := theNodes(aNodeID).nex;
END LOOP;

-- close bracket }
IF (outputOptions.Pretty) THEN
aBracket := NEW_LINE || GAP || ']';
ELSE
aBracket := GAP || ']';
END IF;
PRAGMA INLINE (add_string, 'YES');
json_utils.add_string(theLobBuf, theStrBuf, ']');
json_utils.add_string(theLobBuf, theStrBuf, aBracket);

-- flush
IF (theFlushToLOB) THEN
json_utils.flush_clob(theLobBuf, theStrBuf);
END IF;
Expand Down Expand Up @@ -662,6 +770,19 @@ BEGIN
END IF;
END htp_output_close;

----------------------------------------------------------
-- get_gap (private)
--
FUNCTION get_gap(theIndentation IN INTEGER) RETURN VARCHAR2
IS
BEGIN
IF (outputOptions.Pretty) THEN
RETURN RPAD(INDENTATION_CHARACTER, theIndentation, INDENTATION_CHARACTER);
ELSE
RETURN '';
END IF;
END get_gap;

----------------------------------------------------------
-- copySubNodes (private)
--
Expand Down Expand Up @@ -817,11 +938,11 @@ BEGIN
END IF;

CASE buf
WHEN CHR( 8) THEN buf := '\b'; -- backspace b = U+0008
WHEN CHR( 9) THEN buf := '\t'; -- tabulator t = U+0009
WHEN CHR(10) THEN buf := '\n'; -- newline n = U+000A
WHEN CHR(13) THEN buf := '\f'; -- formfeed f = U+000C
WHEN CHR(14) THEN buf := '\r'; -- carret r = U+000D
WHEN CHR(8) THEN buf := '\b'; -- backspace b = U+0008 = chr(8)
WHEN CHR(9) THEN buf := '\t'; -- tabulator t = U+0009 = chr(9)
WHEN CHR(10) THEN buf := '\n'; -- newline n = U+000A = chr(10)
WHEN CHR(12) THEN buf := '\f'; -- formfeed f = U+000C = chr(12)
WHEN CHR(13) THEN buf := '\r'; -- carret r = U+000D = chr(13)
WHEN CHR(34) THEN buf := '\"';
WHEN CHR(47) THEN -- slash
IF (theEscapeSolitus) THEN
Expand Down
30 changes: 27 additions & 3 deletions json_utils.pks
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@ CREATE OR REPLACE
PACKAGE json_utils
IS

-- output options
TYPE outputOptionsType IS RECORD
(
Pretty BOOLEAN DEFAULT FALSE,
AsciiOutput BOOLEAN DEFAULT TRUE,
EscapeSolitus BOOLEAN DEFAULT FALSE
);

-- node types
NODE_TYPE_NULL CONSTANT VARCHAR2(1) := '0';
NODE_TYPE_STRING CONSTANT VARCHAR2(1) := 'S';
NODE_TYPE_LOB CONSTANT VARCHAR2(1) := 'L';
Expand All @@ -11,6 +20,21 @@ NODE_TYPE_BOOLEAN CONSTANT VARCHAR2(1) := 'B';
NODE_TYPE_OBJECT CONSTANT VARCHAR2(1) := 'O';
NODE_TYPE_ARRAY CONSTANT VARCHAR2(1) := 'A';

----------------------------------------------------------
-- get_default_options
--
FUNCTION get_default_options RETURN outputOptionsType;

----------------------------------------------------------
-- get_options
--
FUNCTION get_options RETURN outputOptionsType;

----------------------------------------------------------
-- set_options
--
PROCEDURE set_options(theOptions IN outputOptionsType);

----------------------------------------------------------
-- add_string
--
Expand Down Expand Up @@ -81,17 +105,17 @@ FUNCTION removeNode(theNodes IN OUT NOCOPY jsonNodes, theNodeID IN BINARY_INTEGE
----------------------------------------------------------
-- convert a node value to a JSON string
--
PROCEDURE value_to_clob(theLobBuf IN OUT NOCOPY CLOB, theStrBuf IN OUT NOCOPY VARCHAR2, theNodes IN jsonNodes, theNodeID IN NUMBER);
PROCEDURE value_to_clob(theLobBuf IN OUT NOCOPY CLOB, theStrBuf IN OUT NOCOPY VARCHAR2, theNodes IN jsonNodes, theNodeID IN NUMBER, theIndentation IN OUT INTEGER);

----------------------------------------------------------
-- convert an object to a JSON string
--
PROCEDURE object_to_clob(theLobBuf IN OUT NOCOPY CLOB, theStrBuf IN OUT NOCOPY VARCHAR2, theNodes IN jsonNodes, theNodeID IN NUMBER, theFlushToLOB IN BOOLEAN DEFAULT TRUE);
PROCEDURE object_to_clob(theLobBuf IN OUT NOCOPY CLOB, theStrBuf IN OUT NOCOPY VARCHAR2, theNodes IN jsonNodes, theNodeID IN NUMBER, theIndentation IN OUT INTEGER, theFlushToLOB IN BOOLEAN DEFAULT TRUE);

----------------------------------------------------------
-- convert an array to a JSON string
--
PROCEDURE array_to_clob(theLobBuf IN OUT NOCOPY CLOB, theStrBuf IN OUT NOCOPY VARCHAR2, theNodes IN jsonNodes, theNodeID IN NUMBER, theFlushToLOB IN BOOLEAN DEFAULT TRUE);
PROCEDURE array_to_clob(theLobBuf IN OUT NOCOPY CLOB, theStrBuf IN OUT NOCOPY VARCHAR2, theNodes IN jsonNodes, theNodeID IN NUMBER, theIndentation IN OUT INTEGER, theFlushToLOB IN BOOLEAN DEFAULT TRUE);

----------------------------------------------------------
-- copy output to the browser using htp.prn
Expand Down
Loading

0 comments on commit 056d377

Please sign in to comment.