[JSONBridge] New bridge

Dockerfile

@@ -27,6 +27,8 @@ RUN set -xe && \
       curl \
       # for patching libcurl-impersonate
       patchelf \
+      # for installing jmespath.php
+      composer \
       && \
     # install curl-impersonate library
     curlimpersonate_version=1.0.0rc2 && \
@@ -53,7 +55,11 @@ RUN set -xe && \
     tar xaf "$archive" -C /usr/local/lib/curl-impersonate && \
     patchelf --set-soname libcurl.so.4 /usr/local/lib/curl-impersonate/libcurl-impersonate.so && \
     rm "$archive" && \
-    apt-get purge --assume-yes curl patchelf && \
+    # install jmespath.php using composer
+    mkdir /app && composer require mtdowling/jmespath.php --no-scripts --no-plugins --no-interaction --working-dir=/app && chown -R --no-dereference www-data:www-data /app && \
+    # cleanup buildtime dependencies
+    composer clear-cache && \
+    apt-get purge --assume-yes curl patchelf composer && \
     rm -rf /var/lib/apt/lists/*
 
 ENV LD_PRELOAD /usr/local/lib/curl-impersonate/libcurl-impersonate.so

bridges/JSONBridge.php

@@ -0,0 +1,184 @@
+<?php
+
+use JmesPath\Env as JmesPath;
+
+class JSONBridge extends BridgeAbstract
+{
+    const NAME = 'Generic JSON (JMESPath) Bridge';
+    const URI = 'https://github.com/RSS-Bridge/rss-bridge';
+    const DESCRIPTION = 'Build feeds from JSON via JMESPath selectors (with expressions)';
+    const MAINTAINER = 'wrobelda';
+
+    const PARAMETERS = [[
+        'url' => [
+            'name' => 'JSON URL',
+            'type' => 'text',
+            'required' => true,
+            'exampleValue' => 'https://registry.npmjs.org/react/latest',
+            'title' => 'The URL returning a JSON document (array or object)',
+        ],
+        'cookie' => [
+            'name' => 'The complete cookie value',
+            'title' => 'Paste the cookie value from your browser if needed',
+            'required' => false,
+        ],
+        'feed_uri' => [
+            'name' => 'JMESPath: feed\'s base URI',
+            'type' => 'text',
+            'required' => false,
+            'exampleValue' => 'join(``, search_query, `.html`])',
+            'title' => 'Optional: JMESPath expression for the feed\'s own URI, e.g. a HTML page that renders the JSON. Corresponds to getURI() function.',
+        ],
+        'feed_name' => [
+            'name' => 'JMESPath: feed\'s name',
+            'type' => 'text',
+            'required' => false,
+            'exampleValue' => 'search_query',
+            'title' => 'Optional: JMESPath expression for the feed\'s title. Corresponds to getName() function.',
+        ],
+        'root' => [
+            'name' => 'JMESPath: items selector',
+            'type' => 'text',
+            'required' => true,
+            'exampleValue' => '[*]',
+            'title' => 'JMESPath expression selecting the list of items (usually "[*]" for top-level arrays)',
+        ],
+        'id' => [
+            'name' => 'JMESPath (per item): ID',
+            'type' => 'text',
+            'required' => true,
+            'exampleValue' => 'id',
+            'title' => 'JMESPath expression for a unique ID per item.',
+        ],
+        'uri' => [
+            'name' => 'JMESPath (per item): URL',
+            'type' => 'text',
+            'required' => true,
+            'exampleValue' => 'item.url',
+            'title' => 'JMESPath expression for the item link (e.g. a product or article URL). Use join() to build the URL if needed.',
+        ],
+        'title' => [
+            'name' => 'JMESPath (per item): Title',
+            'type' => 'text',
+            'required' => true,
+            'exampleValue' => 'name',
+            'title' => 'JMESPath expression for the item title (headline, product name, etc.)',
+        ],
+        'content' => [
+            'name' => 'JMESPath (per item): Content/Description',
+            'type' => 'text',
+            'required' => false,
+            'exampleValue' => 'join(``, [`Price: `, price.formatted, ` USD`])',
+            'title' => 'Optional: JMESPath expression for description text. You can use join() to concatenate fields.',
+        ],
+        'image' => [
+            'name' => 'JMESPath (per item): Image URI',
+            'type' => 'text',
+            'required' => false,
+            'exampleValue' => 'thumb.url',
+            'title' => 'Optional: JMESPath expression for an image URL to add as an enclosure',
+        ],
+    ]];
+
+    private $name;
+    private $feed_uri;
+
+    public function getName()
+    {
+        if (isset($this->name)) {
+            return $this->name;
+        }
+
+        return parent::getName();
+    }
+
+    public function getURI()
+    {
+        if (isset($this->feed_uri)) {
+            return $this->feed_uri;
+        }
+
+        return parent::getURI();
+    }
+
+    public function collectData()
+    {
+        if ($this->getInput('cookie')) {
+            $raw  = getContents($this->getInput('url'), [], [CURLOPT_COOKIE => $this->getInput('cookie')]);
+        } else {
+            $raw  = getContents($this->getInput('url'));
+        }
+
+        $json = json_decode($raw, true);
+        if ($json === null) {
+            throwServerException('Invalid JSON');
+        }
+
+        // root must be array or a single object
+        try {
+            $items = JmesPath::search($this->getInput('root'), $json);
+        } catch (\Throwable $e) {
+            throwServerException('JMESPath error in "root": ' . $e->getMessage());
+        }
+        if (!is_array($items)) {
+            throwServerException('Root JMESPath must return an array or an object');
+        }
+
+        // If it's an associative array (single object), wrap it; if it's a list, use as-is
+        $list = array_is_list($items) ? $items : [$items];
+
+        foreach ($list as $idx => $it) {
+            if (!is_array($it)) {
+                throwServerException("Item #$idx is not an object/assoc array");
+            }
+
+            // Required
+            $id = $this->extract($it, $this->getInput('id'), 'id', $idx);
+            if ($id === null || $id === '') {
+                throwServerException("Required 'id' missing or not scalar for item #$idx");
+            }
+
+            $uri = $this->extract($it, $this->getInput('uri'), 'uri', $idx);
+            if ($uri === null || $uri === '') {
+                throwServerException("Required 'uri' missing or not scalar for item #$idx");
+            }
+
+            $title = $this->extract($it, $this->getInput('title'), 'title', $idx);
+            if ($title === null || $title === '') {
+                throwServerException("Required 'title' missing or not scalar for item #$idx");
+            }
+
+            // Optional
+            $content = $this->extract($it, $this->getInput('content'), 'content', $idx);
+            $image   = $this->extract($it, $this->getInput('image'), 'image', $idx);
+            $name    = $this->extract($it, $this->getInput('name'), 'name', $idx);
+            $feed_uri    = $this->extract($it, $this->getInput('feed_uri'), 'feed_uri', $idx);
+
+            $this->items[] = [
+              'uid'        => (string)$id,
+              'uri'        => (string)$uri,
+              'title'      => (string)$title,
+              'content'    => $content ?? '',
+              'enclosures' => $image ? [$image . '#.image'] : [],
+            ];
+        }
+    }
+
+    /**
+     * Single helper: evaluate a JMESPath expression.
+     * - Throws server error on JMESPath syntax/runtime errors.
+     * - Returns scalar string or null (if expr empty or result non-scalar/empty).
+     */
+    private function extract(array $context, ?string $expr, string $param, int $idx): ?string
+    {
+        if (!$expr) {
+            return null; // caller decides if required
+        }
+        try {
+            $res = JmesPath::search($expr, $context);
+        } catch (\Throwable $e) {
+            throwServerException("JMESPath error in '$param' for item #$idx: " . $e->getMessage());
+        }
+        return (is_scalar($res) && $res !== '') ? (string)$res : null;
+    }
+}

composer.json

@@ -30,7 +30,8 @@
         "ext-simplexml": "*",
         "ext-dom": "*",
         "ext-json": "*",
-        "ext-filter": "*"
+        "ext-filter": "*",
+        "mtdowling/jmespath.php": "*"
     },
     "require-dev": {
         "phpunit/phpunit": "^9",