-/*
- * Copyright (c) 2016, Olivier MATZ <zer0@droids-corp.org>
- *
- * 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 the University of California, Berkeley 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 AND 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.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright 2016, Olivier MATZ <zer0@droids-corp.org>
*/
-#define _GNU_SOURCE /* for asprintf */
#include <sys/types.h>
#include <sys/stat.h>
#include <stdio.h>
#include <ecoli_malloc.h>
#include <ecoli_test.h>
#include <ecoli_strvec.h>
+#include <ecoli_string.h>
#include <ecoli_node.h>
-#include <ecoli_parsed.h>
-#include <ecoli_completed.h>
+#include <ecoli_parse.h>
+#include <ecoli_complete.h>
#include <ecoli_node_file.h>
+EC_LOG_TYPE_REGISTER(node_file);
+
struct ec_node_file {
struct ec_node gen;
+
+ /* below functions pointers are only useful for test */
+ int (*lstat)(const char *pathname, struct stat *buf);
+ DIR *(*opendir)(const char *name);
+ struct dirent *(*readdir)(DIR *dirp);
+ int (*closedir)(DIR *dirp);
+ int (*dirfd)(DIR *dirp);
+ int (*fstatat)(int dirfd, const char *pathname, struct stat *buf,
+ int flags);
};
static int
ec_node_file_parse(const struct ec_node *gen_node,
- struct ec_parsed *state,
+ struct ec_parse *state,
const struct ec_strvec *strvec)
{
(void)gen_node;
(void)state;
if (ec_strvec_len(strvec) == 0)
- return EC_PARSED_NOMATCH;
+ return EC_PARSE_NOMATCH;
return 1;
}
/*
- * Almost the same than dirname (3) and basename (3) except that
- * it always returns a substring of the given path, which can
- * be empty.
+ * Almost the same than dirname (3) and basename (3) except that:
+ * - it always returns a substring of the given path, which can
+ * be empty.
* - the behavior is different when the path finishes with a '/'
- * - the argument is not modified
- * - the output is allocated and must be freed with ec_free().
+ * - the path argument is not modified
+ * - the outputs are allocated and must be freed with ec_free().
*
* path dirname basename split_path
* /usr/lib /usr lib /usr/ lib
dname = ec_strdup(path);
if (dname == NULL)
- return -ENOMEM;
+ return -1;
dname[dirlen] = '\0';
bname = ec_strdup(path + dirlen);
if (bname == NULL) {
ec_free(dname);
- return -ENOMEM;
+ return -1;
}
*dname_p = dname;
static int
ec_node_file_complete(const struct ec_node *gen_node,
- struct ec_completed *completed,
- struct ec_parsed *state,
+ struct ec_comp *comp,
const struct ec_strvec *strvec)
{
- struct stat st;
- const char *path;
+ struct ec_node_file *node = (struct ec_node_file *)gen_node;
+ char *dname = NULL, *bname = NULL, *effective_dir;
+ struct ec_comp_item *item = NULL;
+ enum ec_comp_type type;
+ struct stat st, st2;
+ const char *input;
size_t bname_len;
struct dirent *de = NULL;
DIR *dir = NULL;
- char *dname = NULL, *bname = NULL, *effective_dir;
- char *add = NULL;
- int ret;
+ char *comp_str = NULL;
+ char *disp_str = NULL;
int is_dir = 0;
/*
*/
if (ec_strvec_len(strvec) != 1)
- goto out;
+ return 0;
- path = ec_strvec_val(strvec, 0);
- ret = split_path(path, &dname, &bname);
- if (ret < 0) {
- ec_completed_free(completed);
- completed = NULL;
- goto out;
- }
+ input = ec_strvec_val(strvec, 0);
+ if (split_path(input, &dname, &bname) < 0)
+ return -1;
if (strcmp(dname, "") == 0)
effective_dir = ".";
else
effective_dir = dname;
- ret = lstat(effective_dir, &st);
- if (ret != 0) {
- ret = -errno;
- goto out;
- }
+ if (node->lstat(effective_dir, &st) < 0)
+ goto fail;
if (!S_ISDIR(st.st_mode))
goto out;
- dir = opendir(effective_dir);
+ dir = node->opendir(effective_dir);
if (dir == NULL)
- goto out;
+ goto fail;
bname_len = strlen(bname);
while (1) {
- de = readdir(dir);
- if (de == NULL)
- goto out;
+ int save_errno = errno;
+
+ errno = 0;
+ de = node->readdir(dir);
+ if (de == NULL) {
+ if (errno == 0) {
+ errno = save_errno;
+ goto out;
+ } else {
+ goto fail;
+ }
+ }
- if (strncmp(bname, de->d_name, bname_len))
+ if (!ec_str_startswith(de->d_name, bname))
continue;
if (bname[0] != '.' && de->d_name[0] == '.')
continue;
/* add '/' if it's a dir */
if (de->d_type == DT_DIR) {
is_dir = 1;
- } else if (de->d_type == DT_UNKNOWN) { // XXX todo
+ } else if (de->d_type == DT_UNKNOWN) {
+ int dir_fd = node->dirfd(dir);
+
+ if (dir_fd < 0)
+ goto fail;
+ if (node->fstatat(dir_fd, de->d_name, &st2, 0) < 0)
+ goto fail;
+ if (S_ISDIR(st2.st_mode))
+ is_dir = 1;
+ else
+ is_dir = 0;
} else {
is_dir = 0;
}
if (is_dir) {
- if (asprintf(&add, "%s/", &de->d_name[bname_len]) < 0) {
- ret = -errno;
- goto out;
- }
- if (ec_completed_add_partial_match(
- completed, state, gen_node, add) < 0) {
- ec_completed_free(completed);
- completed = NULL;
- goto out;
- }
+ type = EC_COMP_PARTIAL;
+ if (ec_asprintf(&comp_str, "%s%s/", input,
+ &de->d_name[bname_len]) < 0)
+ goto fail;
+ if (ec_asprintf(&disp_str, "%s/", de->d_name) < 0)
+ goto fail;
} else {
- if (asprintf(&add, "%s", &de->d_name[bname_len]) < 0) {
- ret = -errno;
- goto out;
- }
- if (ec_completed_add_match(completed, state, gen_node,
- add) < 0) {
- ec_completed_free(completed);
- completed = NULL;
- goto out;
- }
+ type = EC_COMP_FULL;
+ if (ec_asprintf(&comp_str, "%s%s", input,
+ &de->d_name[bname_len]) < 0)
+ goto fail;
+ if (ec_asprintf(&disp_str, "%s", de->d_name) < 0)
+ goto fail;
}
- }
- ret = 0;
+ if (ec_comp_add_item(comp, gen_node, &item,
+ type, input, comp_str) < 0)
+ goto out;
+
+ /* fix the display string: we don't want to display the full
+ * path. */
+ if (ec_comp_item_set_display(item, disp_str) < 0)
+ goto out;
+ item = NULL;
+ ec_free(comp_str);
+ comp_str = NULL;
+ ec_free(disp_str);
+ disp_str = NULL;
+ }
out:
- free(add);
+ ec_free(comp_str);
+ ec_free(disp_str);
ec_free(dname);
ec_free(bname);
if (dir != NULL)
- closedir(dir);
+ node->closedir(dir);
- return ret;
+ return 0;
+
+fail:
+ ec_free(comp_str);
+ ec_free(disp_str);
+ ec_free(dname);
+ ec_free(bname);
+ if (dir != NULL)
+ node->closedir(dir);
+
+ return -1;
+}
+
+static int
+ec_node_file_init_priv(struct ec_node *gen_node)
+{
+ struct ec_node_file *node = (struct ec_node_file *)gen_node;
+
+ node->lstat = lstat;
+ node->opendir = opendir;
+ node->readdir = readdir;
+ node->dirfd = dirfd;
+ node->fstatat = fstatat;
+
+ return 0;
}
static struct ec_node_type ec_node_file_type = {
.parse = ec_node_file_parse,
.complete = ec_node_file_complete,
.size = sizeof(struct ec_node_file),
+ .init_priv = ec_node_file_init_priv,
};
EC_NODE_TYPE_REGISTER(ec_node_file_type);
/* LCOV_EXCL_START */
+static int
+test_lstat(const char *pathname, struct stat *buf)
+{
+ if (!strcmp(pathname, "/tmp/toto/")) {
+ struct stat st = { .st_mode = S_IFDIR };
+ memcpy(buf, &st, sizeof(*buf));
+ return 0;
+ }
+
+ errno = ENOENT;
+ return -1;
+}
+
+static DIR *
+test_opendir(const char *name)
+{
+ int *p;
+
+ if (strcmp(name, "/tmp/toto/")) {
+ errno = ENOENT;
+ return NULL;
+ }
+
+ p = malloc(sizeof(int));
+ if (p)
+ *p = 0;
+
+ return (DIR *)p;
+}
+
+static struct dirent *
+test_readdir(DIR *dirp)
+{
+ static struct dirent de[] = {
+ { .d_type = DT_DIR, .d_name = ".." },
+ { .d_type = DT_DIR, .d_name = "." },
+ { .d_type = DT_REG, .d_name = "bar" },
+ { .d_type = DT_UNKNOWN, .d_name = "bar2" },
+ { .d_type = DT_REG, .d_name = "foo" },
+ { .d_type = DT_DIR, .d_name = "titi" },
+ { .d_type = DT_UNKNOWN, .d_name = "tutu" },
+ { .d_name = "" },
+ };
+ int *p = (int *)dirp;
+ struct dirent *ret = &de[*p];
+
+ if (!strcmp(ret->d_name, ""))
+ return NULL;
+
+ *p = *p + 1;
+
+ return ret;
+}
+
+static int
+test_closedir(DIR *dirp)
+{
+ free(dirp);
+ return 0;
+}
+
+static int
+test_dirfd(DIR *dirp)
+{
+ int *p = (int *)dirp;
+ return *p;
+}
+
+static int
+test_fstatat(int dirfd, const char *pathname, struct stat *buf,
+ int flags)
+{
+ (void)dirfd;
+ (void)flags;
+
+ if (!strcmp(pathname, "bar2")) {
+ struct stat st = { .st_mode = S_IFREG };
+ memcpy(buf, &st, sizeof(*buf));
+ return 0;
+ } else if (!strcmp(pathname, "tutu")) {
+ struct stat st = { .st_mode = S_IFDIR };
+ memcpy(buf, &st, sizeof(*buf));
+ return 0;
+ }
+
+ errno = ENOENT;
+ return -1;
+}
+
+static int
+ec_node_file_override_functions(struct ec_node *gen_node)
+{
+ struct ec_node_file *node = (struct ec_node_file *)gen_node;
+
+ node->lstat = test_lstat;
+ node->opendir = test_opendir;
+ node->readdir = test_readdir;
+ node->closedir = test_closedir;
+ node->dirfd = test_dirfd;
+ node->fstatat = test_fstatat;
+
+ return 0;
+}
+
static int ec_node_file_testcase(void)
{
struct ec_node *node;
- int ret = 0;
+ int testres = 0;
- node = ec_node("file", NULL);
+ node = ec_node("file", EC_NO_ID);
if (node == NULL) {
- ec_log(EC_LOG_ERR, "cannot create node\n");
+ EC_LOG(EC_LOG_ERR, "cannot create node\n");
return -1;
}
+ ec_node_file_override_functions(node);
+
/* any string matches */
- ret |= EC_TEST_CHECK_PARSE(node, 1, "foo");
- ret |= EC_TEST_CHECK_PARSE(node, 1, "/tmp/bar");
- ret |= EC_TEST_CHECK_PARSE(node, -1);
+ testres |= EC_TEST_CHECK_PARSE(node, 1, "foo");
+ testres |= EC_TEST_CHECK_PARSE(node, 1, "/tmp/bar");
+ testres |= EC_TEST_CHECK_PARSE(node, -1);
/* test completion */
-#if 0 // XXX how to properly test file completion?
- ret |= EC_TEST_CHECK_COMPLETE(node,
- EC_NODE_ENDLIST,
- EC_NODE_ENDLIST,
- "");
- ret |= EC_TEST_CHECK_COMPLETE(node,
- "", EC_NODE_ENDLIST,
+ testres |= EC_TEST_CHECK_COMPLETE(node,
EC_NODE_ENDLIST,
- "");
- ret |= EC_TEST_CHECK_COMPLETE(node,
- "/", EC_NODE_ENDLIST,
- EC_NODE_ENDLIST,
- "");
- ret |= EC_TEST_CHECK_COMPLETE(node,
- "/tmp", EC_NODE_ENDLIST,
- EC_NODE_ENDLIST,
- "");
- ret |= EC_TEST_CHECK_COMPLETE(node,
- "/tmp/", EC_NODE_ENDLIST,
- EC_NODE_ENDLIST,
- "");
- ret |= EC_TEST_CHECK_COMPLETE(node,
- "/tmp/.", EC_NODE_ENDLIST,
- EC_NODE_ENDLIST,
- "");
-#endif
+ EC_NODE_ENDLIST);
+ testres |= EC_TEST_CHECK_COMPLETE(node,
+ "/tmp/toto/t", EC_NODE_ENDLIST,
+ EC_NODE_ENDLIST);
+ testres |= EC_TEST_CHECK_COMPLETE_PARTIAL(node,
+ "/tmp/toto/t", EC_NODE_ENDLIST,
+ "/tmp/toto/titi/", "/tmp/toto/tutu/", EC_NODE_ENDLIST);
+ testres |= EC_TEST_CHECK_COMPLETE(node,
+ "/tmp/toto/f", EC_NODE_ENDLIST,
+ "/tmp/toto/foo", EC_NODE_ENDLIST);
+ testres |= EC_TEST_CHECK_COMPLETE(node,
+ "/tmp/toto/b", EC_NODE_ENDLIST,
+ "/tmp/toto/bar", "/tmp/toto/bar2", EC_NODE_ENDLIST);
+
ec_node_free(node);
- return ret;
+ return testres;
}
/* LCOV_EXCL_STOP */