Add --json-file/-j option to read from file w/ json contents

.github/workflows/codeql.yml

@@ -47,6 +47,11 @@ jobs:
           sudo apt-get update
           sudo apt-get install libcurl4-openssl-dev
 
+      - name: install libjson-c
+        run: |
+          sudo apt-get update
+          sudo apt-get install libjson-c-dev
+
       - name: build
         run: make
 

.github/workflows/makefile.yml

@@ -9,6 +9,9 @@ on:
 jobs:
   ubuntu:
     runs-on: ubuntu-latest
+
+    env:
+      TRURL_JSON_IN: true
 
     strategy:
       matrix:
@@ -30,7 +33,7 @@ jobs:
       - name: install libcurl
         run: |
           sudo apt-get update
-          sudo apt-get install libcurl4-openssl-dev ${{ matrix.build.install_packages }}
+          sudo apt-get install libcurl4-openssl-dev libjson-c-dev ${{ matrix.build.install_packages }}
 
       - name: code style check
         run: make checksrc
@@ -47,13 +50,16 @@ jobs:
   cygwin:
     runs-on: windows-latest
 
+    env:
+      TRURL_JSON_IN: true
+
     steps:
       - uses: actions/checkout@v4
 
       - name: install cygwin
         uses: cygwin/cygwin-install-action@master
         with:
-          packages: curl, libcurl-devel, libcurl4, make, gcc-core, python39
+          packages: curl, libcurl-devel, libcurl4, make, gcc-core, python39, libjson-c-devel
 
       - name: make
         run: make
@@ -67,9 +73,21 @@ jobs:
   macos:
     runs-on: macos-latest
 
+    env:
+      TRURL_JSON_IN: true
+
     steps:
       - uses: actions/checkout@v4
 
+      - name: Install Homebrew
+        id: install-homebrew
+        uses: Homebrew/actions/setup-homebrew@master
+
+      - name: Install json-c
+        run: |
+          brew install json-c
+          echo "JSON_C_PREFIX=$(brew --prefix)"  >> "$GITHUB_ENV"
+
       - name: make
         run: make
 

Makefile

@@ -33,6 +33,14 @@ CFLAGS += -Wconversion -Wmissing-prototypes -Wwrite-strings -Wsign-compare -Wno-
 ifndef NDEBUG
 CFLAGS += -g
 endif
+ifdef TRURL_JSON_IN
+CFLAGS += -DTRURL_JSON_IN -Wno-gnu
+LDLIBS += -ljson-c
+ifneq ($(strip $(JSON_C_PREFIX)),)
+CFLAGS += -I$(JSON_C_PREFIX)/include
+LDLIBS += -L$(JSON_C_PREFIX)/lib
+endif
+endif
 MANUAL = trurl.1
 
 PREFIX ?= /usr/local

README.md

@@ -155,6 +155,18 @@ trurl also uses `CURLUPART_ZONEID` added in libcurl 7.81.0 and
 It would certainly be possible to make trurl work with older libcurl versions
 if someone wanted to.
 
+## Building with JSON input
+To allow trurl to accept JSON input you must install libjson-c. Json input is disabled by default, so it
+must be enabled at compile time.
+1. Install json-c
+   - On Ubuntu and Debian linux it is called `libjson-c-dev`.
+   - On Cygwin it is called `libjson-c-devel`.
+   - On Homebrew it is called `json-c`.
+2. Enable JSON input at compile time
+   - Ensure `TRURL_JSON_IN` is in you environment
+   - In your environment set `JSON_C_PREFIX` to the install path of json-c to include and link json-c from unexpected locations. This step is only required if json-c is installed somewhere gcc can't find.
+
+
 ### Older libcurls
 
 trurl builds with libcurl older than 7.81.0 but will then not work as

testfiles/test0003.txt

@@ -0,0 +1,66 @@
+[
+  {
+    "parts": {
+      "host": "example.com"
+  }},
+  {
+    "parts": {
+      "host": "example.com"
+  }},
+  {
+    "parts": {
+      "host": "example.com"
+  }},
+  {
+    "parts": {
+      "host": "example.com"
+  }},
+  {
+    "parts": {
+      "host": "example.com"
+  }},
+  {
+    "parts": {
+      "host": "example.com"
+  }},
+  {
+    "parts": {
+      "host": "example.com"
+  }},
+  {
+    "parts": {
+      "host": "example.com"
+  }},
+  {
+    "parts": {
+      "host": "example.com"
+  }},
+  {
+    "parts": {
+      "host": "example.com"
+  }},
+  {
+    "parts": {
+      "host": "example.com"
+  }},
+  {
+    "parts": {
+      "host": "example.com"
+  }},
+  {
+    "parts": {
+      "host": "example.com"
+  }},
+  {
+    "parts": {
+      "host": "example.com"
+  }},
+  {
+    "parts": {
+      "host": "example.com"
+  }},
+  {
+    "parts": {
+      "host": "example.com"
+  }}
+]

testfiles/test0004.txt

@@ -0,0 +1,31 @@
+[
+  {
+    "parts": {
+      "scheme": "ftp",
+      "user": "scream",
+      "host": "url.com",
+      "path": "/",
+      "query": "ignoredquery",
+      "fragment": "a-fragment"
+    },
+    "params": [
+      {
+        "key": "query",
+        "value": "pair"
+      },
+      {
+        "key": "singlequery",
+      }
+    ]
+  },
+  {
+    "parts": {
+      "scheme": "http",
+      "host": "example.org",
+      "path": "/"
+    }
+  },
+  {
+    "url": "example.com"
+  }
+]

tests.json

@@ -2499,6 +2499,20 @@
           "returncode": 0
       }
   },
+  {
+      "required": ["json-input"],
+      "input": {
+          "arguments": [
+              "--json-file",
+              "testfiles/test0003.txt"
+          ]
+       },
+       "expected": {
+           "returncode": 0,
+           "stderr": "",
+           "stdout": "http://example.com/\nhttp://example.com/\nhttp://example.com/\nhttp://example.com/\nhttp://example.com/\nhttp://example.com/\nhttp://example.com/\nhttp://example.com/\nhttp://example.com/\nhttp://example.com/\nhttp://example.com/\nhttp://example.com/\nhttp://example.com/\nhttp://example.com/\nhttp://example.com/\nhttp://example.com/\n"
+       }
+  },
   {
       "input": {
           "arguments": [
@@ -2544,5 +2558,49 @@
           "stderr": "",
           "returncode": 0
       }
+  },
+  {
+      "required": ["json-input"],
+      "input": {
+          "arguments": [
+              "-j",
+              "testfiles/test0001.txt"
+          ]
+       },
+       "expected": {
+           "returncode": 13 ,
+           "stderr": "trurl error: Cannot parse JSON, expected an array of objects.\ntrurl error: Try trurl -h for help\n",
+           "stdout": ""
+       }
+  },
+  {
+      "required": ["json-input"],
+      "input": {
+          "arguments": [
+              "-j",
+              "testfiles/test0004.txt"
+          ]
+       },
+       "expected": {
+           "returncode": 0,
+           "stderr": "trurl note: ignoring 'query', provide a separate 'params' array.\ntrurl note: Required key \"parts\" not found in json object.\n",
+           "stdout": "ftp://[email protected]/?query=pair&singlequery#a-fragment\nhttp://example.org/\n"
+       }
+  },
+  {
+      "required": ["json-input"],
+      "input": {
+          "arguments": [
+              "-j",
+              "testfiles/test0004.txt",
+              "--set",
+              "user=person"
+          ]
+      },
+      "expected": {
+           "returncode": 0,
+           "stderr": "trurl note: ignoring 'query', provide a separate 'params' array.\ntrurl note: Required key \"parts\" not found in json object.\n",
+           "stdout": "ftp://[email protected]/?query=pair&singlequery#a-fragment\nhttp://[email protected]/\n"
+       }
   }
 ]

trurl.1

@@ -169,6 +169,16 @@ Set the component to multiple values and output the result once for each
 iteration. Several combined iterations are allowed to generate combinations,
 but only one \fI--iterate\fP option per component. The listed items to iterate
 over should be separated by single spaces.
+.IP "-j, --json-file [file]"
+Creates urls based on a file which holds a JSON array. The --json-file option expects
+an array of objects, each object containing a "parts" object and optionally a "params"
+array. The keys of the "parts" object are equivalent to the options for --get or --set.
+The only required key in the parts object is "host". the get/set option "query" is not
+a valid key for the parts object. --json-file requires a separate "params" array where
+each element of the array specifies a "key" and a "value".
+
+Like --url-file, [file] may either be a path to a file, or if the file name is '-' then
+--json-file will read from standard in.
 .IP "--json"
 Outputs all set components of the URLs as JSON objects. All components of the
 URL that have data get populated in the parts object using their component
@@ -457,6 +467,33 @@ A problem with --get
 A problem with --iterate
 .IP 12
 A problem with --replace or --force-replace
+.f1
+.IP "use JSON input for trurl"
+.nf
+$ echo '
+  [
+    {
+      "parts": {
+        "host": "example.com",
+        "path": "/a/path/to/index"
+      },
+      "params": [
+        {
+          "key": "foo",
+          "value": "bar" 
+        }
+      ]
+    },
+    {
+      "parts": {
+        "host": "curl.se",
+        "scheme": "ftp"
+      }
+    }
+  ]' | trurl -j -
+http://example.com/a/path/to/index?foo=bar
+ftp://curl.se/
+.fi
 .SH WWW
 https://curl.se/trurl
 .SH "SEE ALSO"