Jump to content

OO_JSON.UDF, JSON/path, OO, using javascript in Auto IT


Recommended Posts

Hi

 

This UDF is for anyone who

- Object Orientated Programing ie properties and methods in autoIT

- needs standards compliant JSON,, 

- JSON.parse (read) and JSON.stringify (to text )

- Now JSONPath

wants to use dot syntax in AutoIT like you would in Javascript 

- dosen't like AutoIt arrays - full javascript arrays and objects in AutoIT! 

- knows javascript or would like to learn autoIT or vice versa.

- call javascript functions like EncodeURI

- run any javascript from autoIT !

 
Tested  IE8 - IE11.
 
v7 JSON_OO v7.zip - IE free version. ( hey microsoft ditched IE now too!) .
- No IE dependencies
- Added arrayAdd and arrayDel
- JSONPath! for searching.
- Added Keys Function - to list properties of a JSON object.
- Secure JSON parse
- Native Pure JS implementaion not a port.

Credits to Douglas Crockford's for JSON2 code and stefan.goessner for JSONPath code.

(see example file).  

 

v4  - json_oo_v4.zip.  -  use v7 (v4 may not work because of  windows updates on dec-2014. ).

v4 uses IEs JSON ,  so no ported external libraries
v4 also includes a Non - IE version of JSON no include files but no stringify and uses javascript EVal (not secure). use v7.
eg valid JSON  '{ "hello" : "world" }' invalid "{ 'hello' : 'world' }"
v4 does not have JSONPath , arrayAdd, arrayDel or keys (properties) methods - use v7

 

 

 

- enjoy

...the brakes come off Autoit . This is the smallest OO extensions for AutoIT

Object Oriented JSON 

--- using JSON to Build Objects in Native AutoIT
-- Using JSON to create objects

$oJSON = _OO_JSON_Init ( )
$jsObj = $oJSON.parse('{ "hello": "world" }')
$jsObj.hello;-> world
$oJSON.stringify( $jsObj );-> {"hello":"world"}
$jsObj.stringify();-> {"hello":"world"}

 

ARRAYS - goodbye Auto it arrays hooray

The real magic in this script is that it lets you access JSON array items by index number through dot syntax

without the need for a for-each loop. eg you can go $obj.arr.item(n) 

It does this by making javascript objects  syntax friendly to Autoit.

Also you can go $obj.arr.item("property").and   $obj.arr.property & Also $obj.arr.length (see below)  

-- Using JSON to create one dimentional array
$sJSON=[ "h1", "h2", "h3" ]
$oResult.length= 3
$oResult.item(0);-> h1

-- Using JSON to create 2 dimentional array;  

$sJSON=[[1,2],[3,4],[5,6]]
$oResult.length= 3
$oResult.item(0);-> 
$oResult.item(0).stringify();-> [1,2]
$oResult.item(2).item(1);-> 6
$oResult.item(2).length;-> 2

-- Using JSON to create an object array 

$sJSON= [ { "card":"ace" }, {"card":"king" }]  
$oResult.length= 2
$oResult.item(0).card;-> ace

-- Using JSON to create key values   

$sJSON= { "name":"Jon" , "surname":"who" }  
$oResult.item("surname");-> who
$oResult.surname ;-> who
 

Many other benefits such as building objects using JSON text just like you would in JavaScript 

 

 

Basic OO - Properties and methods

-- Add properties to objects in AutoIT  
$jsObj.propAdd("myProp", "'x'")
$jsObj.myProp ;-> x
$jsObj.propAdd("myProp", '{ "hello": "world" }')
$jsObj.myProp.hello ;-> world

-- User Defined methods - using javascript -CASE SENSITIVE
$jsObj.methAdd("myMethod", " Function('y','return y*5') " )
$jsObj.myMethod(5) ;-> 25

 

Some people have problems on 64 bit autoIT windows with the script control...here is the work around..

'?do=embed' frameborder='0' data-embedContent>>

You will most likely have the script control ..but here it is..

 

http://www.microsoft.com/en-us/download/details.aspx?id=1949

 
--- using JSON to Build Objects in Native AutoIT  

-- Using JSON to create objects 
$oJSON = _OO_JSON_Init (  )
$jsObj = $oJSON.parse('{ "hello": "world" }')

-- Accessing Items 
$jsObj.hello;-> world
$jsObj.item("hello");-> world

-- Using Any Object to create objects 
$jsObj.stringify();-> {"hello":"world"}
$jsObj = $jsObj.parse('{ "goodbye": "world" }')
$jsObj.goodbye;-> world

-- Read JSON from a file (PC only) - untested 
$var = _OO_JSON_Read_File("jsondata.txt")
$obj = $oJSON.parse($var)

> BASIC OO (Object Oriented) programming in Auto it 

-- Compound Syntax 
$oJSON.parse( '{ "hello":"world" }' ).hello;-> world

-- assigning propeprties 
$jsObj.parse (  '{ "goodbye": "world" }')
$jsObj.goodbye ;-> world
$jsObj.goodbye = "hello" 
$jsObj.goodbye;-> hello

> OO Adding Methods and Properties in Auto it 

-- Add properties to objects in AutoIT  
$jsObj.propAdd("myProp", "'x'")
$jsObj.myProp ;-> x
$jsObj.propAdd("myProp", '{ "hello": "world" }')
$jsObj.myProp.hello ;-> world

-- User Defined methods - using javascript -CASE SENSITIVE
$jsObj.methAdd("myMethod", " Function('y','return y*5') " )
$jsObj.myMethod(5) ;-> 25

> Querying Objects 
$jsObj = $oJSON.parse('{ "hello": "world" , "Goodbye" : "World" } ')
$jsObj.type($jsObj)  ->object
$jsObj.isArray()  ->False

-- List object properties or "keys"  
$jsObj.keys($jsObj).stringify()  ->["hello","Goodbye"]

-- Querying Objects 
$jsObj = $jsObj.parse({ "hello" : "world" , "myarray" : [ "item0", 2 ,  { "jon" : "who"} ] })

> JSON path - always returns an array of matches 
$jsObj.jsonPath( "$.*").stringify() -> ["world",["item0",2,{"jon":"who"}]]
$jsObj.jsonPath( "$..hello").stringify() -> ["world"]
$jsObj.jsonPath( "$..myarray").stringify() ->[["item0",2,{"jon":"who"}]]
$jsObj.jsonPath( "$..myarray[?(@.jon)]").stringify() ->[{"jon":"who"}]
$jsObj.jsonPath( "$..myarray[?(@.jon)]").item(0).stringify() ->{"jon":"who"}

> Basic Arrays using JSON  

-- Querying Arrays 
$jsObj.myarray.stringify()           ->["item0",2,{"jon":"who"}]
$jsObj.type($jsObj.myarray)          ->object
$jsObj.myarray.isArray()             ->True
$jsObj.myarray.length                ->3
$jsObj.type($jsObj.myarray.item(0))  ->string
$jsObj.type($jsObj.myarray.item(1))  ->number
$jsObj.type($jsObj.myarray.item(2))  ->object

> Modifying Arrays using OO  

-- Empty array;  
$jsObj = $oJSON.parse('[]') 
$jsObj.stringify()  ->[]
$jsObj.isArray(  ) ->True

-- Add items;  
$jsObj.arrayAdd( 0, "test0") 
$jsObj.arrayAdd( 1, "test1")
$jsObj2 = $oJSON.parse( '{ "hello" : "world" }')
$jsObj.arrayAdd( 2, $jsObj2)
$jsObj.stringify()  ->["test0","test1",{"hello":"world"}]

-- Delete items;  
$jsObj.arrayDel( 0) 
$jsObj.stringify()  ->["test1",{"hello":"world"}]

-- Using JSON to create one dimentional array 

$sJSON=[ "h1", "h2", "h3" ]
$oResult.length= 3
$oResult.item(0);-> h1

-- Using JSON to create 2 dimentional array;  

$sJSON=[[1,2],[3,4],[5,6]]
$oResult.length= 3
$oResult.item(0);-> 
$oResult.item(0).stringify();-> [1,2]
$oResult.item(2).item(1);-> 6
$oResult.item(2).length;-> 2

-- Using JSON to create an object array 

$sJSON= [ { "card":"ace" }, {"card":"king" }]  
$oResult.length= 2
$oResult.item(0).card;-> ace

-- Using JSON to create key values   

$sJSON= { "name":"Jon" , "surname":"who" }  
$oResult.item("surname");-> who
$oResult.surname ;-> who

> Working with OO Objects 

-- assigning JSON objects in AutoIT  
$jsObj = $oJSON.parse( '{ "hello" : "world" }')
$jsObj2 = $oJSON.parse( '{}' )
$jsObj2 = $jsObj
$jsObj.hello;-> world
$jsObj2.hello;-> world

-- Assign an JSON object to a property
$jsObj = $oJSON.parse( '{ "hello" : "world" }')
$jsObj.hello ;-> world
$jsObj2.propAdd("myProp")
$jsObj2.myProp = $jsObj 
$jsObj2.myProp ;-> 
$jsObj2.myProp.stringify() ;-> {"hello":"world"}
$jsObj2.myProp.hello ;-> world

-- Using Existing JS Objects , Object must exist in the scripting object (not IE) 
$oJSON2 =$jsObj.objGet('JSON')  ; objGet is javascript eval 
$oResult = $oJSON2.parse('{ "hello":"world" }') 
$oResult.hello;-> world

> Using Javascript functions extending UDF 

-- Calling javascript standard functions 
$jsObj.jsFunAdd( "encodeURI")
$jsObj.encodeURI( 'te st'  );-> te%20st
$jsObj.protoAdd("encodeURI", " function (s) { return encodeURI(s); } " 
$jsObj.encodeURI( 'te st'  );-> te%20st

-- Calling javascript literal methods 
$str_obj = $jsObj.toObj("my string")
$str_obj.jsMethAdd( "charAt")
$str_obj.charAt( 0 );-> m
$jsObj.toObj('\"my string').charAt(0) ;-> \
$str_obj.jsFunAdd( "charAt")
$str_obj.charAt( 0 );-> m
$jsObj.jsMethAdd("toFixed" )
$jsObj.toObj(5.56789).toFixed(2) ;-> 5.57
$jsObj.jsMethAdd("concat" , 3 )
$jsObj.toObj('hello').concat( ' world', ' again ', ' and again '  ) ;-> hello world again  and again 
$jsObj.dot("\""'my string", "charAt(0)" );-> \

> depreciated syntax  

-- depreciated syntax - previous UDFs 
$jsObj = _JS_obj_create (  '{ "hello": "world" }') ; invalid "{ 'hello':'world'}" 
$jsObj.hello ;-> world
$jsObj.objToString();-> {"hello":"world"}
$jsObj.strToObject  (  '{ "goodbye": "world" }')
$jsObj.goodbye ;-> world

-- Close IE explorer.exe instance - not required anymore 
_OO_JSON_Quit (  )

-- Objects still usable after _OO_JSON_Quit closes 
$jsObj.goodbye ;-> world
 

Example script output; see example file

;  

enjoy

Edited by ozmike
Link to post
Share on other sites
  • 4 weeks later...
  • Replies 49
  • Created
  • Last Reply

Top Posters In This Topic

Top Posters In This Topic

Popular Posts

Hi   This UDF is for anyone who - Object Orientated Programing ie properties and methods in autoIT - needs standards compliant JSON,,  - JSON.parse (read) and JSON.stringify (to text ) - Now JSONPath

Ok the new IE free version (v7) is up ..it has got the works..! Jsonpath + array add and delete , object type checking. See example file.

KB3008923 caused lots of issues such as this. Have you tried installing KB3025390 to see if it resolves the issue for you?

Thx dwalf 

Sorry i didn;t get back to you,  glad someone using my udf on christmas day!

 

Silly mistake on my part - must have left a duplicate  init call in during testing..it would start up 2 IEs - da!

The new version should fix this issue - i also included the IEWait as you suggested..shouldn't hurt. 

 

On finding what the 'path' to an element  - search GOOGLE for a online JSON viewer   it should let you explore your JSON.

I have now added JSOn path support..

cheers

mike

Edited by ozmike
Link to post
Share on other sites
  • 4 months later...
  • 2 weeks later...
  • 7 months later...

I had been using this script successfully until it just stopped working last week. Do you know what may have happened to stop your script from working for me?

When calling _OO_JSON_Init () the below line never returns.

 _IEDocWriteHTML($g_OO_JSON_oIE, $g_JS_HTML )

I grabbed the variable data for $g_JS_HTML (below) and saved it as a .html file. While loading this file in Internet Explorer I got a display from Internet Explorer 

" Internet Explorer restricted this webpage from running scripts and ActiveX controls.     [Allow blocked content] "

Also, allowing IECreate to return visible shows only a blank page, the 'allow blocked content' message never appears. Viewing the source shows the variable data of $g_JS_HTML.

IELoadWait's (inside _IEDocWriteHTML func [iE.au3]) internal timeout (5min) seems to not be in effect also. 

Further digging shows that I am stuck within a loop of IELoadWait [under Case __IEIsObjType($oObject, "document") ] where as $oTemp.document.readyState = '' indefinitely  

$iError is set to 1 in this loop and thus never hits the timeout ElseIf statement ....

 

 Internet Explorer version 11.09600.17501

Update Versions: 11.0.15 (KB3008923)

<!DOCTYPE html>   <script> Object.prototype.propAdd =function(prop, val ) { eval('this.' + prop + '=' + val )   } ;  Object.prototype.methAdd =function(meth, def ) { eval('this.' + meth + '= new ' + def )   } ;  Object.prototype.jsFunAdd =function( funname , numParams , objectTypeName ) {  var x = buildParamlist (numParams)  ;  objectTypeName = objectTypeName || 'Object';  return eval(objectTypeName + '.prototype.' + funname + ' = function(' + x + ') { return ' + funname + '(' + x + '); }'  )  } ;  function buildParamlist (numParams)   {  var x = ' p0' ; numParams = numParams || 1 ;   for (var i=1; i< numParams; i++) { x=  x + ' , ' + 'p'  + i ;  } ;  return x; } ; Object.prototype.protoAdd         =function( methName, jsFunction , objectTypeName) { objectTypeName = objectTypeName || 'Object'; eval( objectTypeName + '.prototype.' +  methName + '=' + jsFunction )};  Object.prototype.objGet       =function( s ) { return eval(s) }                ;  REM = "To get an obj $obj.objGet('JSON')  ";  Object.prototype.objToString    =function(   ) { return JSON.stringify(this) }   ;  REM = "Print out an object  ";  Object.prototype.strToObject    =function( s ) { return JSON.parse(s) }          ;  REM = "JSON String to object  ";  Object.prototype.stringify      =function(   ) { return JSON.stringify(this) }   ;  REM = "Print out an object  ";  Object.prototype.parse          =function( s ) { return JSON.parse(s) }          ;  REM = "JSON String to object  ";  Array.prototype.item            =function( i ) { return this[i] }                ;  REM = ' so that arrays can work in AutoIT obj.item(0)' ;  Object.prototype.item           =function( i ) { return this[i] }                ;  REM = "so that dynamic key values be obtained eg. obj.item('name' ) or just obj.surname "; Object.prototype.dot =function( str, jsStrFun ) { if ( typeof str == 'string' )  { return eval( '"'+  protectDoubleQuotes (str)  + '".' + jsStrFun ) } else  { return eval( ''+  str  + '.' + jsStrFun ) }  } ; function oLiteral (literal) {   this.literal  = literal; } function protectDoubleQuotes (str)   {  return str.replace(/\\/g, '\\\\').replace(/"/g,'\\"');   } Object.prototype.toObj =function( literal ) { if ( typeof literal == 'string' )  { return eval( 'new oLiteral("' + protectDoubleQuotes (literal) + '")' ) }  else {return eval( 'new oLiteral(' + literal + ')' )} } ;  Object.prototype.jsMethAdd =function( funname , numParams ) {  var x = buildParamlist (numParams)  ;   return eval('oLiteral.prototype.' + funname + ' = function(' + x + ') { return this.literal.' + funname + '(' + x + '); }'  )  } ; window.onload = function() { document.body.parse = function(json) { return JSON.parse(json); }; document.body.stringify = function(obj, space) { return JSON.stringify(obj, null, space); }}</script> <body id='JSONElem'> </body>
Edited by Shane0000
Link to post
Share on other sites
  • Moderators

Are you using the IE-11 and the update from Dec 18th?  If so, uninstall that update until they fix their issues, they broke code all across the coding communities.

Common sense plays a role in the basics of understanding AutoIt... If you're lacking in that, do us all a favor, and step away from the computer.

Link to post
Share on other sites
  • 2 weeks later...

Great Looking UDF ozmike.  Appreciate the examples.  

I'm new to JSON, and I'm trying to automate a web service that has a rest API. I have included my dataset below. 

Question 1:  What's the situation on support for parsing nested items?

 (It's not working for me out of box). 

Question 2: Any advice regarding my data not having double quotes (see below)?

 (I see your update: eg valid JSON  '{ "hello" : "world" }' invalid "{ 'hello' : 'world' }")

 (Do I have to do fancy stringreplace() logic to add them in before parsing?)

Question 3: Can I query the json path in the nested object example below?

 (Can't find any reference in the documentation regarding "nested" or "query"). 

In xpath I could do //id[name="Group02"] which would return the id of 2. 

Thanks in advance to any input from anyone. 

Here's a sample of the output I get back from the web service: 

{"status": 200,"data":[{"id":1,"recipients":[{"addr":"some.guy@emailaddress.com","method":"email","comment":"","type":"admin"}],"name":"Group01"}{"id":2,"recipients":[{"addr":"some.guy@emailaddress.com","method":"email","comment":"","type":"admin"}],"name":"Group02"}{"id":3,"recipients":[{"addr":"some.guy@emailaddress.com","method":"email","comment":"","type":"admin"}],"name":"Group03"}],"errmsg":"OK"}

Here's the same data formatted nicely:

{
   "status": 200,
   "data": [{
      "id": 1,
      "recipients": [{
         "addr": "some.guy@emailaddress.com",
         "method": "email",
         "comment": "",
         "type": "admin"
      }],
      "name": "Group01"
   }{
      "id": 2,
      "recipients": [{
         "addr": "some.guy@emailaddress.com",
         "method": "email",
         "comment": "",
         "type": "admin"
      }],
      "name": "Group02"
   }{
      "id": 3,
      "recipients": [{
         "addr": "some.guy@emailaddress.com",
         "method": "email",
         "comment": "",
         "type": "admin"
      }],
      "name": "Group03"
   }],
   "errmsg": "OK"
}
Edited by redrider81
Link to post
Share on other sites

hi 

redrider81

Q1) You must have well formed json.. (GOOGLE online json parser ;)

Parse error on line 15:
... "Group01" }{ "id":
----------------------^
Expecting 'EOF', '}', ',', ']'

 

Q2) you only need double quote around strings , number will be ok. so '{ "status": 200 } is ok!

 

Q3) I'm not familiar with Xpath - but you could have a look at JSON path ( not in this UDF feel free to write a json path udf if someone else hasn't ! ) .

nested should work ok for well formed JSON see Q1, Here are some examples of nested accessing you'll have to play around !

$var = '{ "status": 200 , "recipients":[{"addr":"some.guy@emailaddress.com","method":"email","comment":"","type":"admin"}] } '
$oJSON = _OO_JSON_Init()

$jsObj = $oJSON.parse($var)
ConsoleWrite("$jsObj.hello;-> " & $jsObj.status & @CR)
ConsoleWrite("$jsObj.hello;-> " & $jsObj.recipients.item(0).addr & @CR)
ConsoleWrite("$jsObj.hello;-> " & $jsObj.item("recipients").item(0).addr & @CR)
Edited by ozmike
Link to post
Share on other sites

Thanks for the reply with specific examples ozmike. Now I understand that there are two different options for referencing a value using the dot notation. This would have been confusing without your specific example.  Also, the nesting does seem to be working for at least 1 level of nesting which is encouraging. I now also understand that double quotes on the array aren't required in two cases: 

1. the value is numeric

2. the value is an array of objects, in which case you use brackets to enclose the array. 

Learning a lot. 

Also, Unfortunately, writing a JSON Path UDF is beyond me because I am new to JSON, but I do believe would be helpful.  In the meantime, can I easily loop through the items in a nested array so that I can search them for a specific value and return another value at the same level?

For example: I want to get find all the recipients where "type"="admin", and add their "addr" (into an array)

In the example you provided, would it be something like this?  

For $i = 0 to Ubound($jsObj.recipients)

If $jsObj.recipients.type = "admin" Then _ArrayAdd($MyArray,$jsObj.recipients.addr)

Next

Thanks again for the UDF, and support. 

Edited by redrider81
Link to post
Share on other sites

Also, I fixed my JSON by adding commas on lines 15 and 27, and added a second "recipient to show the level of nesting i'm actually dealing with. 

Here is the corrected/updated JSON.

I really want to loop through and find the "id" number of the item where the name is "Group03". 

{
    "status": 200,
    "data": [{
        "id": 1,
        "recipients": [{
            "addr": "some.guy1@emailaddress.com",
            "method": "email",
            "comment": "",
            "type": "admin"
        }],
        "name": "Group01"
    },
    {
        "id": 2,
        "recipients": [{
            "addr": "some.guy2@emailaddress.com",
            "method": "email",
            "comment": "",
            "type": "admin"
        }],
        "name": "Group02"
    },
    {
        "id": 3,
        "recipients": [{
            "addr": "some.guy3data@emailaddress.com",
            "method": "email",
            "comment": "",
            "type": "admin"
        },
        {
            "addr": "some.guy3voice@emailaddress.com",
            "method": "voice",
            "comment": "",
            "type": "admin"
        }],
        "name": "Group03"
    }],
    "errmsg": "OK"
}
Link to post
Share on other sites

Hi 

Here is what you want, notice you can't use UBound($obj.data) - Ubound is an auto it function. I have a length property  which you can use in autoit.

$oJSON = _OO_JSON_Init()
$var = '{ "data": [{  "id": 1,   "recipients": [{   "type": "admin" }], "name": "Group01" } , {  "id": 2,   "recipients": [{ "type": "admin" }], "name": "Group03" }] }'
$jsObj = $oJSON.parse($var)


For $i = 0 to $jsObj.data.length - 1
  
   if $jsObj.data.item($i).name = "Group03" Then
      ConsoleWrite("id found ->" & $jsObj.data.item($i).id & @CR)
   endif
next 
Exit

Alternatively try this >json UDF, someone has written _JSONGet($json, "test.x.2")  for this udf. this udf is not as object oriented as mine.

The _JSONGet or similar could be ported to my UDF

;USING JSON.UDF!  create an json object to test
Local $json = _JSONDecode('{"test":{"x":[11,22,{"y":55}]}}')

;query this object
Local $result = _JSONGet($json, "test.x.2")
Link to post
Share on other sites

Awesome!  I will try that loop at my next opportunity. 

Indeed it would be great if someone ported those Get and Set functions to your OO_JSON.au3 UDF (which seems to be the most favorable one thus far). 

Until then, if I wanted to return an array of all group names which contain a "type":"admin", is a nested for loop that manually stores the results into an array the best way to do that?

Edited by redrider81
Link to post
Share on other sites

Hi

Just build up a json string for the array

["Group01","Group03"]

and then  create  array..from that.(or you could load it into an Auto it array)

 
 
I'm having a playing with json path ...be some time off..
$oJSON = _OO_JSON_Init()
$var = '{ "data": [{  "id": 1,   "recipients": [{   "type": "admin" }], "name": "Group01" } , {  "id": 2,   "recipients": [{ "type": "admin" }], "name": "Group03" }] }'
$jsObj = $oJSON.parse($var)
$array_text = "["
For $i = 0 to $jsObj.data.length - 1
  
   if $jsObj.data.item($i).recipients.item(0).type = "admin" Then
      $array_text = $array_text & """" & $jsObj.data.item($i).name & ""","
   endif
next 
$array_text = $array_text & """""]"
ConsoleWrite("array ->" & $array_text & @CR)
$jsObj = $oJSON.parse($array_text)
ConsoleWrite("$jsObj.item(1) ->" & $jsObj.item(1) & @CR)
_OO_JSON_Quit (  )
Exit
Edited by ozmike
Link to post
Share on other sites

1. I will be looking forward to that addition when you get some time. 

2. I will use an AutoIt Array.  CSV.au3 includes two very useful functions:  "_WriteCSV()" and "_ParseCSV()". This enables very easy importing and exporting for my programs for any data that I put into a 2-Dimensional Array (which is what i'll be doing with many of the JSON objects I am working with).  

3.  I will be spending my time figuring out the best ways to loop through all the JSON Objects at a particular level, and put their properties into an AutoIt Array so that I can then use _WriteCSV() to export.  Then my team can update the CSV, and re-import it using the reverse process. 

Thanks again for all your tremendous work with this UDF.  It really among the best I've ever seen. 

EDIT:  Step 3 appears to be much more difficult than I anticipated because there is no native way to enumerate through "all" properties of an object when you don't know their names or how many there are.  Apparently it's a feature of some languages and not others. This is my conclusion based on what I've read... can anyone confirm that this correct?

Edited by redrider81
Link to post
Share on other sites

I did this string and array manipulation in the meantime. To anyone trying to reference this, sorry for the lack of comments...   Also sorry I can't provide the JSON string. In theory should work for any JSON. 

In my particular JSON data, a host has normal JSON properties, and then additional properties under a "properties" object. It's not nice. If not for this, you could simply remove the second line of code. 

 

$sHostObject = $oGetHostsObject.data.hosts.item(0).stringify()
$sHostProperties = StringReplace($sHostObject,'properties":{"','') ; Remove properties":{" so that all properties appear at same level
$sHostProperties = StringReplace($sHostProperties,'{"','') ; Remove special character
$sHostProperties = StringReplace($sHostProperties,'}','') ; Remove special character

_ArrayAdd($aHostProperties,$sHostProperties,0,':',',"') ; _ArrayAdd supports a delimiter for both dimensions... worked out well. 

For $i = 0 to Ubound($aHostProperties)-1
  For $j = 0 to Ubound($aHostProperties,2)-1
    $aHostProperties[$i][$j] = StringReplace($aHostProperties[$i][$j],'"','')  ;  Clean the remaining double quotes
  Next
Next


_ArrayDisplay($aHostProperties)
Link to post
Share on other sites

This is how to list  properties,  tell its type or tell is its an array. 

Note , you can extend my UDF without changing code in the UDF..! see protoAdd

$oJSON = _OO_JSON_Init()
$var = '{ "data": [{  "id": 1,   "recipients": [{   "type": "admin" }], "name": "Group01" } , {  "id": 2,   "recipients": [{ "type": "admin" }], "name": "Group03" }] }'
$jsObj = $oJSON.parse($var)

$jsObj.protoAdd( "getKeys2", " function( s ) { if (typeof s == 'object') { return Object.keys(s);}   }; ")
$jsObj.protoAdd( "getType2", " function( s ) { return typeof(s); }; ")
$jsObj.protoAdd( "isArray2", " function( s ) { return Array.isArray(s); }; ")

$keys = $jsObj.getKeys2( $jsObj.item("data").item(0) )
ConsoleWrite("keys of $jsObj.item(""data"").item(0)  ->" & $keys.stringify() & @CR) ; ->["id","recipients","name"]
$value = $jsObj.isArray2( $jsObj.item("data").item(0) )
ConsoleWrite("isArray $jsObj.item(""data"").item(0) ->" & $value & @CR) ;  ->false
$type = $jsObj.getType2( $jsObj.item("data").item(0))
ConsoleWrite("type    $jsObj.item(""data"").item(0) ->" & $type   & @CR & @CR) ;  ->object

$keys = $jsObj.getKeys2( $jsObj.item("data") )
ConsoleWrite("keys of $jsObj.item(""data"")  ->" & $keys.stringify() & @CR) ;->["0","1"]?
$value = $jsObj.isArray2( $jsObj.item("data") )
ConsoleWrite("isArray $jsObj.item(""data"") ->" & $value & @CR) ;  ->true
$type = $jsObj.getType2( $jsObj.item("data"))
ConsoleWrite("type    $jsObj.item(""data"") ->" & $type & @CR  & @CR) ;  ->object

$keys = $jsObj.getKeys2( $jsObj.item("data").item(0).id )
ConsoleWrite("keys of $jsObj.item(""data"").item(0).id ->" & $keys & @CR) ; blank no keys! not an object
$type = $jsObj.getType2( $jsObj.item("data").item(0).id )
ConsoleWrite("type $jsObj.item(""data"").item(0).id  ->" & $type & @CR) ; number
$type = $jsObj.getType2( $jsObj.item("data").item(0).name )
ConsoleWrite("type $jsObj.item(""data"").item(0).name  ->" & $type & @CR) ; string


_OO_JSON_Quit (  ) 

BTW if you need to get into a autoit array maybe look at the other JSON udf i mentioned  ...as it dumps • JSON arrays are decoded “as-is” to one-dimensional AutoIt arrays

Edited by ozmike
Link to post
Share on other sites

Hi ozmike, 

Another challenge if you have the time.  Just when I thought I was getting good with this UDF and JSON, I found something I don't know how to do:  take an AutoIt Array, and build a JSON object array out of it.  Also, to add to the difficulty, at least one JSON property value will be an object array of it's own.  I know the other UDF's provide some JSON to Array migration functions but once again, I only want to use your UDF if possible.  Your methods are excellent, but to be honest I can still barely wrap my head around them.  Also, extending with ProtoAdd or combining with other UDF is way beyond me at this time. 

My first problem is basic, is that I can't see how to add a "Property" an array of objects when starting with an empty object.  The examples show the object items parsed upon creation.

I do this to define the structure: 

$jsObj = $oJSON.parse( '{}' )

$jsObj.propAdd("data")
$jsObj.data.propAdd("name")
$jsObj.data.propAdd("id")
$jsObj.data.propAdd("recipients")
$jsObj.data.recipients.propAdd("addr")
$jsObj.data.recipients.propAdd("method")
$jsObj.data.recipients.propAdd("comment")
$jsObj.data.recipients.propAdd("type")

.... but I don't know what to do next. I tried several things. 

 

Here's a model of the source data. I import via CSV using _ParseCSV()

#include <Array.au3>
Global $array[1][6] = [['recipientGroupName','recipientGroupId','addr','method','comment','type']]

$string='"LOW"|100|Group1|||"group"' & @CRLF & '"LOW"|100|Group2|||"group"'
$string&= @CRLF & '"MED"|200|Group4|||"group"' & @CRLF & '"MED"|200|Group5|||"group"'
$string&= @CRLF & '"HIGH"|300|Group7|||"group"' & @CRLF & '"HIGH"|300|Group8|||"group"'

_ArrayAdd($array,$string)

_ArrayDisplay($array)

Here's the JSON object I want to make from it: 

{
    "data" : [{
            "id" : 100,
            "recipients" : [{
                    "addr" : "Group1",
                    "method" : "",
                    "comment" : "",
                    "type" : "group"
                }, {
                    "addr" : "Group2",
                    "method" : "",
                    "comment" : "",
                    "type" : "group"
                }
            ],
            "name" : "Groups_LOW"
        }, {
            "id" : 200,
            "recipients" : [{
                    "addr" : "Group4",
                    "method" : "",
                    "comment" : "",
                    "type" : "group"
                }, {
                    "addr" : "Group5",
                    "method" : "",
                    "comment" : "",
                    "type" : "group"
                }
            ],
            "name" : "Groups_MED"
        }, {
            "id" : 300,
            "recipients" : [{
                    "addr" : "Group7",
                    "method" : "",
                    "comment" : "",
                    "type" : "group"
                }, {
                    "addr" : "Group8",
                    "method" : "",
                    "comment" : "",
                    "type" : "group"
                }
            ],
            "name" : "Groups_HIGH"
        }
    ]
}
Edited by redrider81
Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Ward
      Introduction
      JSON (Javascript Object Notation) is a popular data-interchange format and supported by a lot of script languages. On AutoIt, there is already a >JSON UDF written by Gabriel Boehme. It is good but too slow, and not supports unicode and control characters very well. So I write a new one (and of course, fast one as usual).

      I use a machine code version of JSON parser called "jsmn". jsmn not only supports standard JSON, but also accepts some non-strict JSON string. See below for example.
       
      Important Update!!
      I rename the library from jsmn.au3 to json.au3. All function names are changed, too.
       
      Decoding Function
      Json_Decode($Json) $Json can be a standard or non-standard JSON string. For example, it accepts:
      { server: example.com port: 80 message: "this looks like a config file" } The most JSON data type will be decoded into corresponding AutoIt variable, including 1D array, string, number, true, false, and null. JSON object will be decoded into "Windows Scripting Dictionary Object" retuned from ObjCreate("Scripting.Dictionary"). AutoIt build-in functions like IsArray, IsBool, etc. can be used to check the returned data type. But for Object and Null, Json_IsObject() and Json_IsNull() should be used.

      If the input JSON string is invalid, @Error will be set to $JSMN_ERROR_INVAL. And if the input JSON string is not finish (maybe read from stream?), @Error will be set to $JSMN_ERROR_PART.

      Encoding Function
      Json_Encode($Data, $Option = 0, $Indent = "\t", $ArraySep = ",\r\n", $ObjectSep = ",\r\n", $ColonSep = ": ") $Data can be a string, number, bool, keyword(default or null), 1D arrry, or "Scripting.Dictionary" COM object. Ptr will be converted to number, Binary will be converted to string in UTF8 encoding. Other unsupported types like 2D array, dllstruct or object will be encoded into null.

      $Option is bitmask consisting following constant:
      $JSON_UNESCAPED_ASCII ; Don't escape ascii charcters between chr(1) ~ chr(0x1f) $JSON_UNESCAPED_UNICODE ; Encode multibyte Unicode characters literally $JSON_UNESCAPED_SLASHES ; Don't escape / $JSON_HEX_TAG ; All < and > are converted to \u003C and \u003E $JSON_HEX_AMP ; All &amp;amp;amp;amp;s are converted to \u0026 $JSON_HEX_APOS ; All ' are converted to \u0027 $JSON_HEX_QUOT ; All " are converted to \u0022 $JSON_PRETTY_PRINT ; Use whitespace in returned data to format it $JSON_STRICT_PRINT ; Make sure returned JSON string is RFC4627 compliant $JSON_UNQUOTED_STRING ; Output unquoted string if possible (conflicting with $JSMN_STRICT_PRINT) Most encoding option have the same means like PHP's json_enocde() function. When $JSON_PRETTY_PRINT is set, output format can be change by other 4 parameters ($Indent, $ArraySep, $ObjectSep, and $ColonSep). Because these 4 output format parameters will be checked inside Jsmn_Encode() function, returned string will be always accepted by Jsmn_Decode(). $JSON_UNQUOTED_STRING can be used to output unquoted string that also accetped by Jsmn_Decode().

      $JSON_STRICT_PRINT is used to check output format setting and avoid non-standard JSON output. So this option is conflicting with $JSON_UNQUOTED_STRING.

      Get and Put Functions
      Json_Put(ByRef $Var, $Notation, $Data, $CheckExists = False) Json_Get(ByRef $Var, $Notation) These functions helps user to access object or array more easily. Both dot notation and square bracket notation can be supported. Json_Put() by default will create non-exists objects and arrays. For example:
      Local $Obj Json_Put($Obj, ".foo", "foo") Json_Put($Obj, ".bar[0]", "bar") Json_Put($Obj, ".test[1].foo.bar[2].foo.bar", "Test") Local $Test = Json_Get($Obj, '["test"][1]["foo"]["bar"][2]["foo"]["bar"]') ; "Test" Object Help Functions
      Json_ObjCreate() Json_ObjPut(ByRef $Object, $Key, $Value) Json_ObjGet(ByRef $Object, $Key) Json_ObjDelete(ByRef $Object, $Key) Json_ObjExists(ByRef $Object, $Key) Json_ObjGetCount(ByRef $Object) Json_ObjGetKeys(ByRef $Object) Json_ObjClear(ByRef $Object) These functions are just warps of "Scripting.Dictionary" COM object. You can use these functions if you are not already familiar with it.
       
      == Update 2013/05/19 ==
       
      * Add Jsmn_Encode() option "$JSMN_UNESCAPED_ASCII". Now the default output of Json_Encode() is exactly the same as PHP's json_encode() function (for example, chr(1) will be encoded into u0001).
      $JSON_UNESCAPED_ASCII ; Don't escape ascii charcters between chr(1) ~ chr(0x1f)  
      == Update 2015/01/08 ==
      * Rename the library from jsmn.au3 to json.au3. All function names are changed, too.
      * Add Json_Put() and Json_Get()
      * Add Null support
      * Using BinaryCall.au3 to loading the machine code.
       
      == Update 2018/01/13==   (Jos)
      * Add JsonDump() to list all Json Keys and their values to easily figure out what they are.
      == Update 2018/10/01==  (Jos)
      * Fixed JsonDump() some fields and values were not showing as discussed here  - tnx @TheXman .
      == Update 2018/10/01b==   (Jos)
      * Added Json_ObjGetItems, Tidied source and fixed au3check warnings - tnx @TheXman .
      == Update 2018/10/28==   (Jos)
      * Added declaration for $value to avoid au3check warning - tnx @DerPensionist
      == Update 2018/12/16==   (Jos)
      * Added another declaration for $value to avoid au3check warning  and updated the version at the top - tnx @maniootek
      == Update 2018/12/29==   (Jos)
      * Changed Json_ObjGet() and Json_ObjExists() to allow for multilevel object in string.
      == Update 2019/01/17==   (Jos)
      * Added support for DOT notation in JSON functions.
      == Update 2019/07/15==   (Jos)
      *  Added support for reading keys with a dot inside when using a dot as separator (updated)
      == Update 2021/11/18==   (TheXman)
      * Update details in below post:  
      == Update 2021/11/20==   (TheXman)
      * Minor RegEx update, no change to the functionality or result._Json(2021.11.20).zip
       
    • By Chimp
      This script is an alternative (improvement) to the script published at this link (www.autoitscript.com/forum/topic/186225-interesting-effect-with-transparency). In that post a flash animation was used and therefore you need the flash player to work, while here only javascript is used.
      Here, too, the aim is to show an interesting effect that can be obtained by exploiting transparency, but can also be used as it is just for fun.
      The animation consists of some fish wandering around the screen. You can continue working on the computer by letting them swim.
      The javascript source was not written by me, but I got it from this link: https://github.com/lrusso/Aquarium. I shrunk it down a bit and tweaked it so that fish can swim across the entire screen even with different sized monitors.
      The fish images and html and javascript sources have been bundled into a single "monolithic" AutoIt script, so it's easier to run.
      I hope you find it relaxing.
      Have fun
      fishMonolitic.zip
    • By TheXman
      This UDF brings the power and flexibility of jq to AutoIt scripts.  jq is an open-source, powerful, and flexible command-line based JSON processor.  As it says on their website, jq is like 'sed' for JSON.  jq can be used for the simplest of tasks like retrieving JSON objects and values (parsing), to very advanced JSON processing using its numerous built-in functions and conditional processing.  Its built-in functions can handle math, selection, conditional processing, mapping, object and array manipulation, flattening, reduction, grouping, and much more.  You can even create your own jq functions.  You can learn more about jq and even play with it in real-time, using jq's online jq playground, all on their website.
      Here and some helpful links to get you more familiar with jq, what can be done with it, its built-in functions, and its syntax.
      jq Website: https://stedolan.github.io/jq/ jq Manual: https://stedolan.github.io/jq/manual/ jqWiki (FAQ, Cookbook, Advanced Topics) https://github.com/stedolan/jq/wiki jq Online Testing Playground: https://jqplay.org/ jq is a single 32 or 64 bit executable that has no other dependencies.  Just like using the SQLite UDF, the only requirement to use this UDF is that the jq executable reside in a location in which the UDF can execute it.  The latest win32 & win64 versions have been included in the UDF download.  You can always get newer versions from the jq website.
      I don't consider this UDF as a replacement for some of the other JSON UDFs like the one based on JSMN.  If speed and simple JSON parsing are your primary goals, then other UDFs may be a better choice.  However, if you like having the power to do just about anything related to JSON processing/manipulation, using a single UDF, then jq may be worth checking out.  It can be used by novices and experts alike.  Below, is a brief explanation of how jq works, how to use the jq UDF, and a few examples of how to do some simple tasks.  If you want to learn more about jq and what it can do, I would highly suggest checking out the jq website and some of the other resources listed above.
      jq at a high level
      Like 'sed', jq reads JSON in, either through STDIN or one or more files, processes it thru one or more "filters", and outputs the results.  You can, optionally, supply "options" that affect how it reads the input, where it gets its "filters", and how it writes its output.  It looks a little like this:
      JSON ---> jq processor (using supplied filters and options) ---> Output
      So in jq lingo, you basically use "Filters" to tell jq what you want it to do.  So in the UDF file, that is why the main functions ( _jqExec() and _jqExecFile() ) refer to filters and options.  Please make note that jq works with relatively strict JSON.  This means that all JSON read must be conform to the standard.  Luckily, jq is pretty good at identifying where a format error exists in non standard JSON.
      The jq UDF
      There are 2 main funtions in the UDF file, _jqExec and jqExecFile.  With these 2 functions, you can pretty much do anything that jq can do.  The only difference between to two functions is whether the JSON is supplied by a string or a file.  The 2 primary functions simply call the jq executable with the supplied information, after properly formatting the parameters.  There are additional functions in the UDF to easily pretty-print your json, compact-print your json, dump the json data with its associated paths, and see if specific JSON keys exist, but they all just execute the _jqExec or _jqExecFile function with the proper filter.  There are also a couple of extra functions to display what version of the UDF and jq executable you are currently using.  There are also a couple of functions to enable and disable logging of jq information for debugging purposes.  Most of the jq UDF file functions return an @error if unsuccessful.  Some also include @extended info.  Please see the actual function headers for more information on their usage and return values.
      The 2 primary functions below just format your jq request and pass it on the jq executable.  The functions will also properly escape double quotes (") that are used in the filter.  For most simple tasks, you just need to supply the JSON source and a filter.
      _jqExec($sJson, $sFilter, $sOptions = Default, $sWorkingDir = Default) Or _jqExecFile($sJsonFile, $sFilter, $sOptions = Default, $sWorkingDir = Default) Using jq in your script
      As stated earlier, the jq executable must reside somewhere where the script can locate and execute it.  The _jqInit() function always has to be executed before any jq processing occurs.  _jqInit() merely locates the executable or uses the supplied path.  It also clears any previous debug log.  The jq UDF folder contains a jq example script that has several examples to how to do some of the most common JSON processing tasks.  Here are a few examples to get you started:

      How to pretty-print some JSON
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '{"fruits":[{"Apple":{"color":"Red","season":"Fall"}}, {"Banana":{"color":"Yellow","season":"Summer"}}]}' $sCmdOutput = _jqPrettyPrintJson($sJson) ConsoleWrite(@CRLF & "Pretty-Print JSON" & @CRLF & $sCmdOutput & @CRLF) How to compact-print some JSON
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '{ "fruits" : [{"Apple" : {"color":"Red","season":"Fall"}}, {"Banana":{"color":"Yellow","season":"Summer"}}]}' $sCmdOutput = _jqCompactPrintJson($sJson) ConsoleWrite(@CRLF & "Compact-Print JSON" & @CRLF & $sCmdOutput & @CRLF) Dump JSON data (paths and values)
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '{ "fruits" : [{"Apple" : {"color":"Red","season":"Fall"}}, {"Banana":{"color":"Yellow","season":"Summer"}}]}' $sCmdOutput = _jqDump($sJson) ConsoleWrite(@CRLF & "Dump JSON paths and values" & @CRLF & $sCmdOutput & @CRLF) How to GET JSON values
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '{"Apple" : {"color":"Red","season":"Fall"}, "Banana":{"color":"Yellow","season":"Summer"}}' $sFilter = '.Banana.color' $sCmdOutput = _jqExec($sJson, $sFilter) ConsoleWrite("Get color of banana" & @CRLF) ConsoleWrite("Input: : " & _jqCompactPrintJson($sJson) & @CRLF) ConsoleWrite("Filter : " & $sFilter & @CRLF) ConsoleWrite("Output : " & $sCmdOutput & @CRLF) or
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '{"Apple" : {"color":"Red","season":"Fall"}, "Banana":{"color":"Yellow","season":"Summer"}}' $sFilter = 'getpath(["Banana", "color"])' $sCmdOutput = _jqExec($sJson, $sFilter) ConsoleWrite("Get color of banana" & @CRLF) ConsoleWrite("Input: : " & _jqCompactPrintJson($sJson) & @CRLF) ConsoleWrite("Filter : " & $sFilter & @CRLF) ConsoleWrite("Output : " & $sCmdOutput & @CRLF)  
      Check for the existence of a key
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '{"Apple":{"color":"Red","season":"Fall"}, "Banana":{"color":"Yellow","season":"Summer"}}' $sFilter = '.Banana | has("color")' $sCmdOutput = _jqExec($sJson, $sFilter) ConsoleWrite("Check for existence of color key within Banana object" & @CRLF) ConsoleWrite("Input: : " & _jqCompactPrintJson($sJson) & @CRLF) ConsoleWrite("Filter : " & $sFilter & @CRLF) ConsoleWrite("Output : " & $sCmdOutput & @CRLF) Count of how many Items in an object
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '{"Apple":{"color":"Red"}, "Banana":{"color":"Yellow","season":"Summer"}}' $sFilter = '.Banana | length' $sCmdOutput = _jqExec($sJson, $sFilter) ConsoleWrite("How many items in the Banana object" & @CRLF) ConsoleWrite("Input: : " & _jqCompactPrintJson($sJson) & @CRLF) ConsoleWrite("Filter : " & $sFilter & @CRLF) ConsoleWrite("Output : " & $sCmdOutput & @CRLF) How to PUT/Create/Modify JSON
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sInput = "" $sFilter = 'setpath(["Apple","color"];"Red") | setpath(["Banana","color"];"Yellow") | setpath(["Banana","season"];"Summer")' $sOptions = '-n' ;required if no input supplied $sCmdOutput = _jqExec($sInput, $sFilter, $sOptions) ConsoleWrite("Update/Create JSON" & @CRLF) ConsoleWrite("Filter : " & $sFilter & @CRLF) ConsoleWrite("Output : " & @CRLF & $sCmdOutput & @CRLF) List all of the fruits (top-level keys)
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '{"Apple":{"color":"Red"}, "Banana":{"color":"Yellow","season":"Summer"}}' $sFilter = 'keys | .[]' $sCmdOutput = _jqExec($sJson, $sFilter) ConsoleWrite("List all top-level keys (fruits)" & @CRLF) ConsoleWrite("Input : " & $sJson & @CRLF) ConsoleWrite("Filter : " & $sFilter & @CRLF) ConsoleWrite("Output : " & @CRLF & $sCmdOutput & @CRLF) Calculate the sum of all of the objects' price * qty
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '[{"id":1,"price":20.00,"qty":10},{"id":2,"price":15.00,"qty":20.25},{"id":3,"price":10.50,"qty":30}]' $sFilter = 'map(.price * .qty) | add' $sCmdOutput = _jqExec($sJson, $sFilter) ConsoleWrite("Calculate the sum of all of the objects' price * qty" & @CRLF) ConsoleWrite("Input : " & $sJson & @CRLF) ConsoleWrite("Filter : " & $sFilter & @CRLF) ConsoleWrite("Output : " & $sCmdOutput & @CRLF)
      The examples above, and the ones in the example files, merely scratch the surface of what jq can do.  It may look intimidating at first but it really isn't that bad once you start playing with it.
      If you have any questions regarding the UDF, or how to perform a certain task using jq, I'll try my best to answer them.  Since jq has been around for a while now, there's also several jq-related questions and answers on StackOverflow.
      If you work with JSON, I hope you find this UDF useful as I do.
      >>> Download in the Files Section <<<
       
    • By TheXman
      This UDF brings the power and flexibility of jq to AutoIt scripts.  jq is an open-source, powerful, and flexible command-line based JSON processor.  As it says on their website, jq is like 'sed' for JSON.  jq can be used for the simplest of tasks like retrieving JSON objects and values (parsing), to very advanced JSON processing using its numerous built-in functions and conditional processing.  Its built-in functions can handle math, selection, conditional processing, mapping, object and array manipulation, flattening, reduction, grouping, and much more.  You can even create your own jq functions.  You can learn more about jq and even play with it in real-time, using jq's online jq playground, all on their website.
      Here and some helpful links to get you more familiar with jq, what can be done with it, its built-in functions, and its syntax.
      jq Website: https://stedolan.github.io/jq/ jq Manual: https://stedolan.github.io/jq/manual/ jqWiki (FAQ, Cookbook, Advanced Topics) https://github.com/stedolan/jq/wiki jq Online Testing Playground: https://jqplay.org/ jq is a single 32 or 64 bit executable that has no other dependencies.  Just like using the SQLite UDF, the only requirement to use this UDF is that the jq executable reside in a location in which the UDF can execute it.  The latest win32 & win64 versions have been included in the UDF download.  You can always get newer versions from the jq website.
      I don't consider this UDF as a replacement for some of the other JSON UDFs like the one based on JSMN.  If speed and simple JSON parsing are your primary goals, then other UDFs may be a better choice.  However, if you like having the power to do just about anything related to JSON processing/manipulation, using a single UDF, then jq may be worth checking out.  It can be used by novices and experts alike.  Below, is a brief explanation of how jq works, how to use the jq UDF, and a few examples of how to do some simple tasks.  If you want to learn more about jq and what it can do, I would highly suggest checking out the jq website and some of the other resources listed above.
      jq at a high level
      Like 'sed', jq reads JSON in, either through STDIN or one or more files, processes it thru one or more "filters", and outputs the results.  You can, optionally, supply "options" that affect how it reads the input, where it gets its "filters", and how it writes its output.  It looks a little like this:
      JSON ---> jq processor (using supplied filters and options) ---> Output
      So in jq lingo, you basically use "Filters" to tell jq what you want it to do.  So in the UDF file, that is why the main functions ( _jqExec() and _jqExecFile() ) refer to filters and options.  Please make note that jq works with relatively strict JSON.  This means that all JSON read must be conform to the standard.  Luckily, jq is pretty good at identifying where a format error exists in non standard JSON.
      The jq UDF
      There are 2 main funtions in the UDF file, _jqExec and jqExecFile.  With these 2 functions, you can pretty much do anything that jq can do.  The only difference between to two functions is whether the JSON is supplied by a string or a file.  The 2 primary functions simply call the jq executable with the supplied information, after properly formatting the parameters.  There are additional functions in the UDF to easily pretty-print your json, compact-print your json, dump the json data with its associated paths, and see if specific JSON keys exist, but they all just execute the _jqExec or _jqExecFile function with the proper filter.  There are also a couple of extra functions to display what version of the UDF and jq executable you are currently using.  There are also a couple of functions to enable and disable logging of jq information for debugging purposes.  Most of the jq UDF file functions return an @error if unsuccessful.  Some also include @extended info.  Please see the actual function headers for more information on their usage and return values.
      The 2 primary functions below just format your jq request and pass it on the jq executable.  The functions will also properly escape double quotes (") that are used in the filter.  For most simple tasks, you just need to supply the JSON source and a filter.
      _jqExec($sJson, $sFilter, $sOptions = Default, $sWorkingDir = Default) Or _jqExecFile($sJsonFile, $sFilter, $sOptions = Default, $sWorkingDir = Default) Using jq in your script
      As stated earlier, the jq executable must reside somewhere where the script can locate and execute it.  The _jqInit() function always has to be executed before any jq processing occurs.  _jqInit() merely locates the executable or uses the supplied path.  It also clears any previous debug log.  The jq UDF folder contains a jq example script that has several examples to how to do some of the most common JSON processing tasks.  Here are a few examples to get you started:

      How to pretty-print some JSON
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '{"fruits":[{"Apple":{"color":"Red","season":"Fall"}}, {"Banana":{"color":"Yellow","season":"Summer"}}]}' $sCmdOutput = _jqPrettyPrintJson($sJson) ConsoleWrite(@CRLF & "Pretty-Print JSON" & @CRLF & $sCmdOutput & @CRLF) How to compact-print some JSON
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '{ "fruits" : [{"Apple" : {"color":"Red","season":"Fall"}}, {"Banana":{"color":"Yellow","season":"Summer"}}]}' $sCmdOutput = _jqCompactPrintJson($sJson) ConsoleWrite(@CRLF & "Compact-Print JSON" & @CRLF & $sCmdOutput & @CRLF) Dump JSON data (paths and values)
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '{ "fruits" : [{"Apple" : {"color":"Red","season":"Fall"}}, {"Banana":{"color":"Yellow","season":"Summer"}}]}' $sCmdOutput = _jqDump($sJson) ConsoleWrite(@CRLF & "Dump JSON paths and values" & @CRLF & $sCmdOutput & @CRLF) How to GET JSON values
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '{"Apple" : {"color":"Red","season":"Fall"}, "Banana":{"color":"Yellow","season":"Summer"}}' $sFilter = '.Banana.color' $sCmdOutput = _jqExec($sJson, $sFilter) ConsoleWrite("Get color of banana" & @CRLF) ConsoleWrite("Input: : " & _jqCompactPrintJson($sJson) & @CRLF) ConsoleWrite("Filter : " & $sFilter & @CRLF) ConsoleWrite("Output : " & $sCmdOutput & @CRLF) or
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '{"Apple" : {"color":"Red","season":"Fall"}, "Banana":{"color":"Yellow","season":"Summer"}}' $sFilter = 'getpath(["Banana", "color"])' $sCmdOutput = _jqExec($sJson, $sFilter) ConsoleWrite("Get color of banana" & @CRLF) ConsoleWrite("Input: : " & _jqCompactPrintJson($sJson) & @CRLF) ConsoleWrite("Filter : " & $sFilter & @CRLF) ConsoleWrite("Output : " & $sCmdOutput & @CRLF)  
      Check for the existence of a key
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '{"Apple":{"color":"Red","season":"Fall"}, "Banana":{"color":"Yellow","season":"Summer"}}' $sFilter = '.Banana | has("color")' $sCmdOutput = _jqExec($sJson, $sFilter) ConsoleWrite("Check for existence of color key within Banana object" & @CRLF) ConsoleWrite("Input: : " & _jqCompactPrintJson($sJson) & @CRLF) ConsoleWrite("Filter : " & $sFilter & @CRLF) ConsoleWrite("Output : " & $sCmdOutput & @CRLF) Count of how many Items in an object
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '{"Apple":{"color":"Red"}, "Banana":{"color":"Yellow","season":"Summer"}}' $sFilter = '.Banana | length' $sCmdOutput = _jqExec($sJson, $sFilter) ConsoleWrite("How many items in the Banana object" & @CRLF) ConsoleWrite("Input: : " & _jqCompactPrintJson($sJson) & @CRLF) ConsoleWrite("Filter : " & $sFilter & @CRLF) ConsoleWrite("Output : " & $sCmdOutput & @CRLF) How to PUT/Create/Modify JSON
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sInput = "" $sFilter = 'setpath(["Apple","color"];"Red") | setpath(["Banana","color"];"Yellow") | setpath(["Banana","season"];"Summer")' $sOptions = '-n' ;required if no input supplied $sCmdOutput = _jqExec($sInput, $sFilter, $sOptions) ConsoleWrite("Update/Create JSON" & @CRLF) ConsoleWrite("Filter : " & $sFilter & @CRLF) ConsoleWrite("Output : " & @CRLF & $sCmdOutput & @CRLF) List all of the fruits (top-level keys)
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '{"Apple":{"color":"Red"}, "Banana":{"color":"Yellow","season":"Summer"}}' $sFilter = 'keys | .[]' $sCmdOutput = _jqExec($sJson, $sFilter) ConsoleWrite("List all top-level keys (fruits)" & @CRLF) ConsoleWrite("Input : " & $sJson & @CRLF) ConsoleWrite("Filter : " & $sFilter & @CRLF) ConsoleWrite("Output : " & @CRLF & $sCmdOutput & @CRLF) Calculate the sum of all of the objects' price * qty
      #include "jq.au3" _jqInit() If @error Then Exit ConsoleWrite("ERROR: Unable to initialize jq - @error = " & @error & @CRLF) $sJson = '[{"id":1,"price":20.00,"qty":10},{"id":2,"price":15.00,"qty":20.25},{"id":3,"price":10.50,"qty":30}]' $sFilter = 'map(.price * .qty) | add' $sCmdOutput = _jqExec($sJson, $sFilter) ConsoleWrite("Calculate the sum of all of the objects' price * qty" & @CRLF) ConsoleWrite("Input : " & $sJson & @CRLF) ConsoleWrite("Filter : " & $sFilter & @CRLF) ConsoleWrite("Output : " & $sCmdOutput & @CRLF)
      The examples above, and the ones in the example files, merely scratch the surface of what jq can do.  It may look intimidating at first but it really isn't that bad once you start playing with it.
      If you have any questions regarding the UDF, or how to perform a certain task using jq, I'll try my best to answer them.  Since jq has been around for a while now, there's also several jq-related questions and answers on StackOverflow.
      If you work with JSON, I hope you find this UDF useful as I do.
    • By mdwerne
      Hello,
      Before Broadcom took over Symantec, I was able to use the following code as the base to scrape daily definition downloads from the web. Since the pages were moved over to the Broadcom web servers, I get a page full of what I believe may be JavaScript instead of the fully rendered page that lies behind it. Does anyone have any suggestions as to how I can read the full rendered webpage using AutoIt?
      #include <IE.au3> $oIE_DEFS = _IECreate("https://www.broadcom.com/support/security-center/definitions/download/detail?gid=sep14", 0, 0, 1, 1) $sString_DEFS = _IEBodyReadHTML($oIE_DEFS) MsgBox(0, "https://www.broadcom.com/support/security-center/definitions/download/detail?gid=sep14", $sString_DEFS) The above code will show the JavaScript, but if you go to the URL in a browser that has JavaScript enabled, you will see the fully rendered page that I would like to access. I hope my question makes sense, and I would appreciate any suggestions to get this working again.
      All the best,
      -Mike
×
×
  • Create New...