lnav/src/fs-extension-functions.cc

/**
 * Copyright (c) 2013, Timothy Stack
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * * Neither the name of Timothy Stack nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @file fs-extension-functions.cc
 */

#include "config.h"

#include <stdio.h>
#include <string.h>
#include <sys/types.h>
#include <stdint.h>

#include <string>
#include <stddef.h>

#include "sqlite3.h"

#include "sqlite-extension-func.hh"

#include "vtab_module.hh"

using namespace std;
using namespace mapbox;

static
util::variant<const char *, string_fragment>
sql_basename(const char *path_in)
{
    int text_end = -1;

    if (path_in[0] == '\0') {
        return ".";
    }

    for (ssize_t lpc = strlen(path_in) - 1; lpc >= 0; lpc--) {
        if (path_in[lpc] == '/' || path_in[lpc] == '\\') {
            if (text_end != -1) {
                return string_fragment(path_in, lpc + 1, text_end);
            }
        }
        else if (text_end == -1) {
            text_end = (int) (lpc + 1);
        }
    }

    if (text_end == -1) {
        return "/";
    }
    else {
        return string_fragment(path_in, 0, text_end);
    }
}

static
util::variant<const char *, string_fragment>
sql_dirname(const char *path_in)
{
    ssize_t     text_end;

    text_end = strlen(path_in) - 1;
    while (text_end >= 0 &&
           (path_in[text_end] == '/' || path_in[text_end] == '\\')) {
        text_end -= 1;
    }

    while (text_end >= 0) {
        if (path_in[text_end] == '/' || path_in[text_end] == '\\') {
            return string_fragment(path_in, 0, text_end == 0 ? 1 : text_end);
        }

        text_end -= 1;
    }

    return path_in[0] == '/' ? "/" : ".";
}

static
nonstd::optional<string> sql_joinpath(const vector<const char *> paths)
{
    std::string full_path;

    if (paths.empty()) {
        return nonstd::nullopt;
    }

    for (auto &path_in : paths) {
        if (path_in == nullptr) {
            return nonstd::nullopt;
        }

        if (path_in[0] == '/' || path_in[0] == '\\') {
            full_path.clear();
        }
        if (!full_path.empty() &&
            full_path[full_path.length() - 1] != '/' &&
            full_path[full_path.length() - 1] != '\\') {
            full_path += "/";
        }
        full_path += path_in;
    }

    return full_path;
}

int fs_extension_functions(struct FuncDef **basic_funcs,
                           struct FuncDefAgg **agg_funcs)
{
    static struct FuncDef fs_funcs[] = {

        sqlite_func_adapter<decltype(&sql_basename), sql_basename>::builder(
            help_text("basename",
                      "Extract the base portion of a pathname.")
                .sql_function()
                .with_parameter({"path", "The path"})
                .with_example({"SELECT basename('foobar')"})
                .with_example({"SELECT basename('foo/bar')"})
                .with_example({"SELECT basename('foo/bar/')"})
                .with_example({"SELECT basename('')"})
                .with_example({"SELECT basename('foo\\bar')"})
                .with_example({"SELECT basename('foobar')"})
                .with_example({"SELECT basename('/')"})
        ),

        sqlite_func_adapter<decltype(&sql_dirname), sql_dirname>::builder(
            help_text("dirname",
                      "Extract the directory portion of a pathname.")
                .sql_function()
                .with_parameter({"path", "The path"})
                .with_example({"SELECT dirname('foo/bar')"})
                .with_example({"SELECT dirname('/foo/bar')"})
                .with_example({"SELECT dirname('/bar')"})
                .with_example({"SELECT dirname('foo\\bar')"})
                .with_example({"SELECT dirname('')"})
        ),

        sqlite_func_adapter<decltype(&sql_joinpath), sql_joinpath>::builder(
            help_text("joinpath",
                      "Join components of a path together.")
                .sql_function()
                .with_parameter(help_text("path", "One or more path components to join together.  "
                    "If an argument starts with a forward or backward slash, it will be considered "
                    "an absolute path and any preceding elements will be ignored.")
                                    .one_or_more())
                .with_example({"SELECT joinpath('foo', 'bar')"})
                .with_example({"SELECT joinpath('', 'foo', 'bar')"})
                .with_example({"SELECT joinpath('/', 'foo', 'bar')"})
                .with_example({"SELECT joinpath('/', 'foo', '/bar')"})
        ),

        /*
         * TODO: add other functions like readlink, normpath, ... 
         */

        { NULL }
    };

    *basic_funcs = fs_funcs;
    *agg_funcs   = NULL;

    return SQLITE_OK;
}