Skip to content

CFE-2986: Added getdir command to cf-net, copies directory and files #6049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SimonThalvorsen wants to merge 1 commit into
base: master
Choose a base branch
from
+285 −0
Open

CFE-2986: Added getdir command to cf-net, copies directory and files #6049

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
285 changes: 285 additions & 0 deletions cf-net/cf-net.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
#include <cleanup.h>
#include <protocol.h>
#include <sequence.h>
#include <files_lib.h>

#define ARG_UNUSED __attribute__((unused))

Expand Down Expand Up @@ -100,6 +101,8 @@
"\t\t\t(%d can be used in both the remote and output file paths when '-j' is used)"},
{"opendir", "List files and folders in a directory",
"cf-net opendir masterfiles"},
{"getdir", "Recursively downloads files and folders in a directory",
"cf-net getdir masterfiles/ -o /tmp/ [-lRECURSIONLIMIT]"},
{NULL, NULL, NULL}
};

Expand Down Expand Up @@ -144,6 +147,7 @@
generator_macro(STAT) \
generator_macro(GET) \
generator_macro(OPENDIR) \
generator_macro(GETDIR) \
generator_macro(MULTI) \
generator_macro(MULTITLS) \
generator_macro(HELP) \
Expand Down Expand Up @@ -197,6 +201,7 @@
static int CFNetOpenDir(CFNetOptions *opts, const char *hostname, char **args);
static int CFNetMulti(const char *server);
static int CFNetMultiTLS(const char *server, const char *use_protocol_version);
static int CFNetGetDir(CFNetOptions *opts, const char *hostname, char **args);


//*******************************************************************
Expand Down Expand Up @@ -411,6 +416,8 @@
return CFNetGet(opts, hostname, args);
case CFNET_CMD_OPENDIR:
return CFNetOpenDir(opts, hostname, args);
case CFNET_CMD_GETDIR:
return CFNetGetDir(opts, hostname, args);
case CFNET_CMD_MULTI:
return CFNetMulti(hostname);
case CFNET_CMD_MULTITLS:
Expand Down Expand Up @@ -591,6 +598,16 @@
"\nbasename in current working directory (cwd). Override this"
"\nusing the -o filename option (-o - for stdout).\n");
}
else if (strcmp("getdir", topic) == 0)
{
printf("\ncf-net getdir recursively downloads a directory from a remote host."
"\nIt uses OPENDIR to list contents, STAT to check file types, and GET"
"\nto download files. By default the directory is saved with its basename"
"\nin the current working directory (cwd). Override the destination using"
"\nthe -o path option. Use --limit N to control recursion depth (default: 10)."
"\n\nUsage: cf-net getdir [-o output_path] [--limit N] <remote_directory>"
"\n\nExample: cf-net getdir -o /tmp/backup --limit 5 masterfiles/\n");
}
else
{
if (found == false)
Expand Down Expand Up @@ -865,7 +882,7 @@
for (int i = 0; i < n_threads; i++)
{
threads[i] = (CFNetThreadData*) xcalloc(1, sizeof(CFNetThreadData));
threads[i]->data = (GetFileData*) xcalloc(1, sizeof(GetFileData));

Check failure

Code scanning / CodeQL

Non-constant format string Critical

The format string argument to
snprintf
Loading
has a source which cannot be verified to originate from a string literal.
The format string argument to
snprintf
Loading
has a source which cannot be verified to originate from a string literal.
The format string argument to
snprintf
Loading
has a source which cannot be verified to originate from a string literal.
The format string argument to
snprintf
Loading
has a source which cannot be verified to originate from a string literal.
threads[i]->data->hostname = hostname;
threads[i]->data->use_protocol_version = opts->use_protocol_version;
threads[i]->data->print_stats = opts->print_stats;
Expand Down Expand Up @@ -973,9 +990,277 @@
PrintDirs(seq);
SeqDestroy(seq);
CFNetDisconnect(conn);
return 0;
}

// Helper: Get a single file with permissions
static bool CFNetGetWithPerms(AgentConnection *conn, const char *remote_path,
Copy link
Contributor

@larsewi larsewi Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

File permissions are preserved via ProtocolGet, but created directories don't get the remote directory's permissions applied.

const char *local_path, bool print_stats)
{
assert(conn != NULL && remote_path != NULL && local_path != NULL);

struct stat perms;
if (!ProtocolStat(conn, remote_path, &perms))
{
Log(LOG_LEVEL_ERR, "Failed to stat remote file: %s:%s",
conn->this_server, remote_path);
return false;
}

if (!ProtocolGet(conn, remote_path, local_path, perms.st_size, perms.st_mode, print_stats))
{
Log(LOG_LEVEL_ERR, "Failed to get remote file: %s:%s",
conn->this_server, remote_path);
return false;
}

Check notice

Code scanning / CodeQL

Pointer argument is dereferenced without checking for NULL Note

Parameter conn in CFNetGetWithPerms() is dereferenced without an explicit null-check

return true;
}

// Helper: Create local directory path
static bool create_local_dir(const char *local_base, const char *subdir,

Check notice

Code scanning / CodeQL

Pointer argument is dereferenced without checking for NULL Note

Parameter conn in CFNetGetWithPerms() is dereferenced without an explicit null-check
bool has_output_path, mode_t perms)
{
char path[PATH_MAX];
int written;

if (has_output_path)
{
written = snprintf(path, sizeof(path), "%s/%s/", local_base, subdir);
}
else
{
char cwd[PATH_MAX];
if (!getcwd(cwd, sizeof(cwd)))
{
Log(LOG_LEVEL_ERR, "Failed to get current working directory");
return false;
}
written = snprintf(path, sizeof(path), "%s/%s/%s/", cwd, local_base, subdir);
}

if (written < 0 || written >= sizeof(path))
{
Log(LOG_LEVEL_ERR, "Path too long for new directory: %s", subdir);
return false;
}

bool* created = NULL;
bool force = false;
MakeParentDirectoryPerms(path, force, created, perms);
return true;
}

// Helper: Recursively process directory entries
static int process_dir_recursive(AgentConnection *conn,
const char *remote_path,
const char *local_path,
bool has_output_path,
bool print_stats,
int limit)
{
if (0 > limit - 1)
{
Log(LOG_LEVEL_ERR, "Recursion limit reached");
return -2;
}

int written;
Seq *items = ProtocolOpenDir(conn, remote_path);
if (!items)
{
return -1;
}

for (size_t i = 0; i < SeqLength(items); i++)
{
char *item = SeqAt(items, i);

if (strcmp(".", item) == 0 || strcmp("..", item) == 0)
{
continue;
}

char remote_full[PATH_MAX];
written = snprintf(remote_full, sizeof(remote_full), "%s/%s", remote_path, item);
if (written < 0 || written >= sizeof(remote_full))
{
Log(LOG_LEVEL_ERR,
"Path too long for building full remote path: %s and %s",
remote_path, item);
continue;
}

char local_full[PATH_MAX];
written = snprintf(local_full, sizeof(local_full), "%s/%s", local_path, item);
if (written < 0 || written >= sizeof(local_full))
{
Log(LOG_LEVEL_ERR,
"Path too long for building full local path: %s and %s",
local_path, item);
return -1;
}

struct stat sb;
if (!ProtocolStat(conn, remote_full, &sb))
{
Log(LOG_LEVEL_ERR, "Could not stat: %s", remote_full);
return -1;
}

if (S_ISDIR(sb.st_mode)) // Is directory
{
if (!create_local_dir(local_path, item, has_output_path, sb.st_mode))
{
// Error already logged
return -1;
}
process_dir_recursive(conn, remote_full, local_full, has_output_path, print_stats, (limit - 1));
}
else
{
CFNetGetWithPerms(conn, remote_full, local_full, print_stats);
}
}

SeqDestroy(items);
return 0;
}

static int CFNetGetDir(CFNetOptions *opts, const char *hostname, char **args)
{
assert(opts != NULL);
assert(hostname != NULL);
assert(args != NULL);
char *local_dir = NULL;
int limit = 10;

int argc = 0;
while (args[argc] != NULL)

Check warning

Code scanning / CodeQL

Poorly documented large function Warning

Poorly documented function: fewer than 2% comments for a function of 115 lines.
{
++argc;
}

static struct option longopts[] = {
{ "output", required_argument, NULL, 'o' },
{ "limit", required_argument, NULL, 'l' },
{ NULL, 0, NULL, 0 }
};
if (argc <= 1)
{
return invalid_command("getdir");
}
extern int optind;
optind = 0;
extern char *optarg;
int c = 0;
const char *optstr = "o:l:";
bool specified_path = false;
while ((c = getopt_long(argc, args, optstr, longopts, NULL))
!= -1)
{
switch (c)
{
case 'o':
{
if (local_dir != NULL)
{
Log(LOG_LEVEL_INFO,
"Warning: multiple occurrences of -o in command, "\
"only last one will be used.");
free(local_dir);
}
local_dir = xstrdup(optarg);
specified_path = true;
break;
}
case 'l':
{
char *lim;
long val = strtol(optarg, &lim, 10);
if (*lim != '\0' || val < 0)
{
Log(LOG_LEVEL_ERR, "Invalid limit value: %s", optarg);
return invalid_command("getdir");
}
limit = (int)val;
break;
}
case ':':
case '?':
{
return invalid_command("getdir");
}
default:
{
printf("Default optarg = '%s', c = '%c' = %i\n",
optarg, c, (int)c);
break;
}
}
}
args = &(args[optind]);
argc -= optind;
char *remote_dir = args[0];
char *base = basename(remote_dir);
if (specified_path)
{
char temp[PATH_MAX];

int written = snprintf(temp, sizeof(temp), "%s/%s", local_dir, base);
if (written < 0 || written >= sizeof(temp))
{
Log(LOG_LEVEL_ERR, "Path too long for local path: %s/%s", local_dir, base);
free(local_dir);
return -1;
Copy link
Contributor

@larsewi larsewi Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

temp is leaked here

}
free(local_dir);
local_dir = xstrdup(temp);
}

if (local_dir == NULL)
{
local_dir = xstrdup(base);
}

AgentConnection *conn = CFNetOpenConnection(hostname, opts->use_protocol_version);
if (conn == NULL)
{
free(local_dir);
return -1;
}
struct stat sb;
int ret = (int) ProtocolStat(conn, remote_dir, &sb);
if (ret != 1)
{
printf("Could not stat: '%s'\n", remote_dir);
free(local_dir);
CFNetDisconnect(conn);
return -1;
}
if (!S_ISDIR(sb.st_mode))
{
printf("'%s' is not a directory, use 'get' for single file download\n", remote_dir);
free(local_dir);
CFNetDisconnect(conn);
return -1;
}

ret = process_dir_recursive(conn, remote_dir, local_dir, specified_path, opts->print_stats, limit);
if (ret == -2)
{
Log(LOG_LEVEL_INFO, "Recursion limit(%d) reached", limit);
}
else if (ret == -1)
{
Log(LOG_LEVEL_INFO, "Failed to copy all contents of %s", remote_dir);
}

free(local_dir);
CFNetDisconnect(conn);
return (ret == 0) ? 0 : -1;
}

static int CFNetMulti(const char *server)
{
time_t start;
Expand Down
Loading