(Tcl) Inspect the Complete Set of Defined Variables

See more CURL Examples

Note: This example requires Chilkat v11.5.0 or greater.

For more information, see https://www.chilkatsoft.com/curl_dependency_engine.asp

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

set success 0

# This example shows how to inspect the complete set of defined variables
# after executing the curl dependency plan.
# The code that enumerates and displays all variables is located at the end of the example.

set httpCurl [new_CkHttpCurl]

# The final curl command we want to execute.
# It depends on {{drive_id}}, which is not yet known.
set targetCurl "curl -X GET https://graph.microsoft.com/v1.0/drives/{{drive_id}}/root/children"

# Define a helper function that can produce drive_id.
# This function lists drives for a given site, which requires {{site_id}}.
set fnName "getDrives"
CkHttpCurl_AddFunction $httpCurl $fnName "curl -X GET https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives"

# Define the output of getDrives.
# The JSON response contains an array named "value".
# We take the first element (value[0]) and extract its "id" as drive_id.
set jsonPath "value[0].id"
CkHttpCurl_AddOutput $httpCurl $fnName $jsonPath "drive_id"

# drive_id depends on site_id, which is also not yet known.
# Define another helper function to obtain site_id.
set fnName "getSite"
CkHttpCurl_AddFunction $httpCurl $fnName "GET https://graph.microsoft.com/v1.0/sites/root:/sites/{{site_name}}"

# Map the "id" field from the getSite response to the variable site_id.
set jsonPath "id"
CkHttpCurl_AddOutput $httpCurl $fnName $jsonPath "site_id"

# Provide the initial known input.
# site_name is the starting value that allows the dependency chain to be resolved.
CkHttpCurl_SetVar $httpCurl "site_name" "test"

# ----------------------------------------------------------------------------------------------------------------------
# Configure OAuth2 authentication using the client credentials flow.
# Secrets (client_id, client_secret, token_endpoint) are retrieved from the
# local secrets manager because EnableSecrets is enabled.
set jsonOAuth2 [new_CkJsonObject]

CkJsonObject_put_EnableSecrets $jsonOAuth2 1
CkJsonObject_UpdateString $jsonOAuth2 "oauth2.client_id" "!!sharepoint|oauth2|client_id"
CkJsonObject_UpdateString $jsonOAuth2 "oauth2.client_secret" "!!sharepoint|oauth2|client_secret"
CkJsonObject_UpdateString $jsonOAuth2 "oauth2.scope" "https://graph.microsoft.com/.default"
CkJsonObject_UpdateString $jsonOAuth2 "oauth2.token_endpoint" "!!sharepoint|oauth2|token_endpoint"
CkHttpCurl_SetAuth $httpCurl $jsonOAuth2
# ----------------------------------------------------------------------------------------------------------------------

# Execute the target curl command.
# Internally, the system will:
# 
# 1) Detect that {{drive_id}} is required but not defined.
# 2) Find that "getDrives" can produce drive_id.
# 3) Detect that getDrives requires {{site_id}}, which is also not defined.
# 4) Find that "getSite" can produce site_id.
# 5) Verify that getSite requires {{site_name}}, which is already known.
# 6) Build a multi-step execution plan:
#      - First:  run getSite (produces site_id)
#      - Second: run getDrives (produces drive_id)
#      - Third:  run the target curl (uses drive_id)
set success [CkHttpCurl_DoYourThing $httpCurl $targetCurl]
if {$success == 0} then {
    puts [CkHttpCurl_lastErrorText $httpCurl]
    delete_CkHttpCurl $httpCurl
    delete_CkJsonObject $jsonOAuth2
    exit
}

# Retrieve and display the HTTP response status code.
set statusCode [CkHttpCurl_get_StatusCode $httpCurl]
puts "response status code: $statusCode"

# Load and display the JSON response from the final curl command.
set responseJson [new_CkJsonObject]

CkJsonObject_put_EmitCompact $responseJson 0
CkHttpCurl_GetResponseJson $httpCurl $responseJson
puts [CkJsonObject_emit $responseJson]

# ----------------------------------
# Examine all defined variables.
# ----------------------------------
set definedVarsJson [new_CkJsonObject]

CkJsonObject_put_EmitCompact $definedVarsJson 0

CkHttpCurl_GetAllVars $httpCurl $definedVarsJson
puts [CkJsonObject_emit $definedVarsJson]

# Sample output:

# {
#   "vars": [
#     {
#       "name": "site_name",
#       "value": "test"
#     },
#     {
#       "name": "site_id",
#       "value": "example.sharepoint.com,9b923c5e-5117-44ad-8b03-adbb8e19be85,b2451e19-290f-5f29-9f5d-674c2950a9f7"
#     },
#     {
#       "name": "drive_id",
#       "value": "b!XjySmxdRrrtLA827jhm-nRkeRbIPKSlPn11nTClQqfeVOj5VUvQMQae34rwOHdiP"
#     }
#   ]
# }

# Sample code to parse the above JSON.
set i 0
set numVars [CkJsonObject_SizeOfArray $definedVarsJson "vars"]
while {$i < $numVars} {
    CkJsonObject_put_I $definedVarsJson $i
    puts "name: [CkJsonObject_stringOf $definedVarsJson {vars[i].name}]"
    puts "value: [CkJsonObject_stringOf $definedVarsJson {vars[i].value}]"
    set i [expr $i + 1]
}

delete_CkHttpCurl $httpCurl
delete_CkJsonObject $jsonOAuth2
delete_CkJsonObject $responseJson
delete_CkJsonObject $definedVarsJson