clixon_util_xpath.c

/*
 *
  ***** BEGIN LICENSE BLOCK *****
 
  Copyright (C) 2009-2019 Olof Hagsand
  Copyright (C) 2020-2022 Olof Hagsand and Rubicon Communications, LLC(Netgate)

  This file is part of CLIXON.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  Alternatively, the contents of this file may be used under the terms of
  the GNU General Public License Version 3 or later (the "GPL"),
  in which case the provisions of the GPL are applicable instead
  of those above. If you wish to allow use of your version of this file only
  under the terms of the GPL, and not to allow others to
  use your version of this file under the terms of Apache License version 2, 
  indicate your decision by deleting the provisions above and replace them with
  the  notice and other provisions required by the GPL. If you do not delete
  the provisions above, a recipient may use your version of this file under
  the terms of any one of the Apache License version 2 or the GPL.

  ***** END LICENSE BLOCK *****

See https://www.w3.org/TR/xpath/

*
*/

#ifdef HAVE_CONFIG_H
#include "clixon_config.h" /* generated by config & autoconf */
#endif

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <errno.h>
#include <string.h>
#include <limits.h>
#include <stdint.h>
#include <syslog.h>
#include <fcntl.h>
#include <signal.h>
#include <sys/stat.h>

/* cligen */
#include <cligen/cligen.h>

/* clixon */
#include "clixon/clixon.h"

/* Command line options to be passed to getopt(3) */
#define XPATH_OPTS "hD:f:p:i:In:cl:Ly:Y:"

static int
usage(char *argv0)
{
    fprintf(stderr, "usage:%s [options]\n"
            "where options are\n"
            "\t-h \t\tHelp\n"
            "\t-D <level> \tDebug\n"
            "\t-f <file>  \tXML file\n"
            "\t-p <xpath> \tPrimary XPath string\n"
            "\t-i <xpath0>\t(optional) Initial XPath string\n"
            "\t-I \t\tCheck inverse, map back xml result to xpath and check if equal\n"
            "\t-n <pfx:id>\tNamespace binding (pfx=NULL for default)\n"
            "\t-c \t\tMap xpath to canonical form\n"
            "\t-l <s|e|o|f<file>> \tLog on (s)yslog, std(e)rr, std(o)ut or (f)ile (stderr is default)\n"
            "\t-L \t\tLocalonly, ignore prefixes\n"
            "\t-y <filename> \tYang filename or dir (load all files)\n"
            "\t-Y <dir> \tYang dirs (can be several)\n"
            "and the following extra rules:\n"
            "\tif -f is not given, XML input is expected on stdin\n"
            "\tif -p is not given, <xpath> is expected as the first line on stdin\n"
            "This means that with no arguments, <xpath> and XML is expected on stdin.\n",
            argv0
            );
    exit(0);
}

static int
ctx_print2(cbuf   *cb,
           xp_ctx *xc)
{
    int retval = -1;
    int i;

    cprintf(cb, "%s:", (char*)clicon_int2str(ctxmap, xc->xc_type));
    switch (xc->xc_type){
    case XT_NODESET:
        for (i=0; i<xc->xc_size; i++){
            cprintf(cb, "%d:", i);
            if (clixon_xml2cbuf(cb, xc->xc_nodeset[i], 0, 0, NULL, -1, 0) < 0)
                goto done;
        }
        break;
    case XT_BOOL:
        cprintf(cb, "%s", xc->xc_bool?"true":"false");
        break;
    case XT_NUMBER:
        cprintf(cb, "%lf", xc->xc_number);
        break;
    case XT_STRING:
        cprintf(cb, "%s", xc->xc_string);
        break;
    }
    retval = 0;
 done:
    return retval;
}

int
main(int    argc,
     char **argv)
{
    int         retval = -1;
    char       *argv0 = argv[0];
    int         i;
    cxobj      *x0 = NULL;
    cxobj      *x;
    int         c;
    int         len;
    char       *buf = NULL;
    int         ret;
    FILE       *fp = stdin; /* unless overriden by -f */
    char       *yang_file_dir = NULL;
    yang_stmt  *yspec = NULL;
    char       *xpath = NULL;
    char       *xpath0 = NULL;
    char       *filename;
    xp_ctx     *xc = NULL;
    cbuf       *cb = NULL;
    clixon_handle h;
    struct stat st;
    cvec       *nsc = NULL;
    int         canonical = 0;
    cxobj      *xcfg = NULL;
    cbuf       *cbret = NULL;
    cxobj      *xerr = NULL; /* malloced must be freed */
    int         logdst = CLIXON_LOG_STDERR;
    int         dbg = 0;
    int         xpath_inverse = 0;
    int         localonly = 0;

    /* Initialize clixon handle */
    if ((h = clixon_handle_init()) == NULL)
        goto done;
    /* In the startup, logs to stderr & debug flag set later */
    clixon_log_init(h, "xpath", LOG_DEBUG, logdst); 
    /* Initialize config tree (needed for -Y below) */
    if ((xcfg = xml_new("clixon-config", NULL, CX_ELMNT)) == NULL)
        goto done;
    if (clicon_conf_xml_set(h, xcfg) < 0)
        goto done;
    
    optind = 1;
    opterr = 0;
    while ((c = getopt(argc, argv, XPATH_OPTS)) != -1)
        switch (c) {
        case 'h':
            usage(argv0);
            break;
        case 'D':
            if (sscanf(optarg, "%d", &dbg) != 1)
                usage(argv0);
            break;
        case 'f': /* XML file */
            filename = optarg;
            if ((fp = fopen(filename, "r")) == NULL){
                clixon_err(OE_UNIX, errno, "fopen(%s)", optarg);
                goto done;
            }
            break;
        case 'p': /* Primary XPath string */
            xpath = optarg;
            break;
        case 'i': /* Optional initial XPath string */
            xpath0 = optarg;
            break;
        case 'I': /* Check inverse */
            xpath_inverse++;
            break;
        case 'n':{ /* Namespace binding */
            char *prefix;
            char *id;
            if (nsc == NULL &&
                (nsc = xml_nsctx_init(NULL, NULL)) == NULL)
                goto done;
            if (nodeid_split(optarg, &prefix, &id) < 0)
                goto done;
            if (prefix && strcmp(prefix, "null")==0){
                free(prefix);
                prefix = NULL;
            }
            if (xml_nsctx_add(nsc, prefix, id) < 0)
                goto done;
            if (prefix)
                free(prefix);
            if (id)
                free(id);
            break;
        }
        case 'c': /* Map namespace to canonical form */
            canonical = 1;
            break;
        case 'l': /* Log destination: s|e|o|f */
            if ((logdst = clixon_log_opt(optarg[0])) < 0)
                usage(argv[0]);
            if (logdst == CLIXON_LOG_FILE &&
                strlen(optarg)>1 &&
                clixon_log_file(optarg+1) < 0)
                goto done;
            break;
        case 'L':
            localonly = 1;
            break;
        case 'y':
            yang_file_dir = optarg;
            break;
        case 'Y':
            if (clicon_option_add(h, "CLICON_YANG_DIR", optarg) < 0)
                goto done;
            break;
        default:
            usage(argv[0]);
            break;
        }
    /* 
     * Logs, error and debug to stderr or syslog, set debug level
     */
    clixon_log_init(h, "xpath", dbg?LOG_DEBUG:LOG_INFO, logdst);
    clixon_debug_init(h, dbg);
    if (yang_init(h) < 0)
        goto done;
    /* Parse yang */
    if (yang_file_dir){
        if ((yspec = yspec_new(h, YANG_DATA_TOP)) == NULL)
            goto done;
        if (stat(yang_file_dir, &st) < 0){
            clixon_err(OE_YANG, errno, "%s not found", yang_file_dir);
            goto done;
        }
        if (S_ISDIR(st.st_mode)){
            if (yang_spec_load_dir(h, yang_file_dir, yspec) < 0)
                goto done;
        }
        else{
            if (yang_spec_parse_file(h, yang_file_dir, yspec) < 0)
                goto done;
        }
    }

    if (xpath==NULL){
        /* First read xpath */
        len = 1024; /* any number is fine */
        if ((buf = malloc(len)) == NULL){
            perror("pt_file malloc");
            goto done;
        }
        memset(buf, 0, len);
        i = 0;
        while (1){
            if ((ret = read(0, &c, 1)) < 0){
                perror("read");
                goto done;
            }
            if (ret == 0)
                break;
            if (c == '\n')
                break;
            if (len==i){
                if ((buf = realloc(buf, 2*len)) == NULL){
                    fprintf(stderr, "%s: realloc: %s\n", __FUNCTION__, strerror(errno));
                    goto done;
                }
                memset(buf+len, 0, len);
                len *= 2;
            }
            buf[i++] = (char)(c&0xff);
        }
        xpath = buf;
    }

    /* If canonical, translate nsc and xpath to canonical form */
    if (canonical){
        char *xpath1 = NULL;
        cvec *nsc1 = NULL;
        cbuf *cbreason = NULL;

        if ((ret = xpath2canonical1(xpath, nsc, yspec, 1, &xpath1, &nsc1, &cbreason)) < 0)
            goto done;
        if (ret == 0){
            fprintf(stderr, "Error with %s: %s", xpath, cbuf_get(cbreason));
            goto ok;
        }
        xpath = xpath1;
        if (xpath)
            fprintf(stdout, "%s\n", xpath);
        if (nsc)
            xml_nsctx_free(nsc);
        nsc = nsc1;
        if (nsc)
            cvec_print(stdout, nsc);
        goto ok; /* need a switch to continue, now just print and quit */
    }
    /*
     * If fp=stdin, then continue reading from stdin (after CR)
     * XXX Note 0 above, stdin here
     */
    if (clixon_xml_parse_file(fp, YB_NONE, NULL, &x0, NULL) < 0){
        fprintf(stderr, "Error: parsing: %s\n", clixon_err_reason());
        goto done;
    }

    /* Validate XML as well */
    if (yang_file_dir){
        /* Populate */
        if ((ret = xml_bind_yang(h, x0, YB_MODULE, yspec, &xerr)) < 0)
            goto done;
        if (ret == 0){
            if ((cbret = cbuf_new()) ==NULL){
                clixon_err(OE_XML, errno, "cbuf_new");
                goto done;
            }
            if (netconf_err2cb(h, xerr, cbret) < 0)
                goto done;
            fprintf(stderr, "xml validation error: %s\n", cbuf_get(cbret));
            goto done;
        }
        /* Sort */
        if (xml_sort_recurse(x0) < 0)
            goto done;

        /* Add default values */
        if (xml_default_recurse(x0, 0, 0) < 0)
            goto done;
        if (xml_apply0(x0, -1, xml_sort_verify, h) < 0)
            clixon_log(h, LOG_NOTICE, "%s: sort verify failed", __FUNCTION__);
        if ((ret = xml_yang_validate_all_top(h, x0, &xerr)) < 0)
            goto done;
        if (ret > 0 && (ret = xml_yang_validate_add(h, x0, &xerr)) < 0)
            goto done;
        if (ret == 0){
            if ((cbret = cbuf_new()) ==NULL){
                clixon_err(OE_XML, errno, "cbuf_new");
                goto done;
            }
            if (netconf_err2cb(h, xpath_first(xerr,NULL,"rpc-error"), cbret) < 0)
                goto done;
            fprintf(stderr, "xml validation error: %s\n", cbuf_get(cbret));
            goto done;
        }
    }
    /* If xpath0 given, position current x (ie somewhere else than root) */
    if (xpath0){
        if ((x = xpath_first(x0, NULL, "%s", xpath0)) == NULL){
            fprintf(stderr, "Error: xpath0 returned NULL\n");
            goto done;
        }
    }
    else
        x = x0;
#if 0 // filter syntax errors
    {
        xpath_tree *xptree = NULL;
        if (xpath_parse(xpath, &xptree) < 0)
            goto ok; // Parse errors returns OK
    }
#endif
    if (xpath_vec_ctx(x, nsc, xpath, localonly, &xc) < 0)
        goto done;

    /* Check inverse, eg XML back to xpath and compare with original, only if nodes */
    if (xpath_inverse && xc->xc_type == XT_NODESET){
        cxobj *xi;
        char  *xpathi = NULL;
        for (i=0; i<xc->xc_size; i++){
            xi = xc->xc_nodeset[i];
            if (xml2xpath(xi, nsc, 0, 0, &xpathi) < 0)
                goto done;
            fprintf(stdout, "Inverse: %s\n", xpathi);
            if (xpathi){
                free(xpathi);
                xpathi = NULL;
            }
        }
        goto ok;
    }
    /* Print results */
    cb = cbuf_new();
    ctx_print2(cb, xc);
    fprintf(stdout, "%s\n", cbuf_get(cb));
 ok:
    retval = 0;
 done:
    yang_exit(h);
    if (cb)
        cbuf_free(cb);
    if (nsc)
        xml_nsctx_free(nsc);
    if (xc)
        ctx_free(xc);
    if (xcfg)
        xml_free(xcfg);
    if (buf)
        free(buf);
    if (x0)
        xml_free(x0);
    if (fp)
        fclose(fp);
    if (h)
        clixon_handle_exit(h);
    return retval;
}