Skip to content
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

ENT-12511: Now cf-net get no longer unlinks original file #5666

Merged
merged 2 commits into from
Dec 20, 2024
Merged

ENT-12511: Now cf-net get no longer unlinks original file #5666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99a802a
Now `cf-net get` no longer unlinks original file
larsewi Dec 18, 2024
cc12344
File Stream API now unlinks before open with `O_EXCL`
larsewi Dec 19, 2024
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
1 change: 1 addition & 0 deletions libcfnet/file_stream.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -853,6 +853,7 @@ static bool RecvDelta(
char in_buf[PROTOCOL_MESSAGE_SIZE * 2], out_buf[PROTOCOL_MESSAGE_SIZE];

/* Open/create the destination file */
unlink(dest);
int new = safe_open_create_perms(
dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL | O_BINARY, perms);
if (new == -1)
Expand Down
158 changes: 78 additions & 80 deletions libcfnet/protocol.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,11 @@ bool ProtocolGet(AgentConnection *conn, const char *remote_path,

perms = (perms == 0) ? CF_PERMS_DEFAULT : perms;

unlink(local_path);
FILE *file_ptr = safe_fopen_create_perms(local_path, "wx", perms);
if (file_ptr == NULL)
char dest[PATH_MAX];
int ret = snprintf(dest, sizeof(dest), "%s.cfnew", local_path);
if (ret < 0 || (size_t)ret >= sizeof(dest))
{
Log(LOG_LEVEL_WARNING, "Failed to open file %s (fopen: %s)",
local_path, GetErrorStr());
Log(LOG_LEVEL_ERR, "Truncation error: Path too long (%d >= %zu)", ret, sizeof(dest));
return false;
}

Expand All @@ -115,112 +114,111 @@ bool ProtocolGet(AgentConnection *conn, const char *remote_path,
CF_MSGSIZE, remote_path);


int ret = SendTransaction(conn->conn_info, buf, to_send, CF_DONE);
ret = SendTransaction(conn->conn_info, buf, to_send, CF_DONE);
if (ret == -1)
{
Log(LOG_LEVEL_WARNING, "Failed to send request for remote file %s:%s",
conn->this_server, remote_path);
unlink(local_path);
fclose(file_ptr);
return false;
}

/* Use file stream API if it is available */
bool success = true;

const ProtocolVersion version = ConnectionInfoProtocolVersion(conn->conn_info);
if (ProtocolSupportsFileStream(version))
{
fclose(file_ptr);

char dest[PATH_MAX];
ret = snprintf(dest, sizeof(dest), "%s.cfnew", local_path);
if (ret < 0 || (size_t)ret >= sizeof(dest))
{
Log(LOG_LEVEL_ERR, "Truncation error: Path too long (%d >= %zu)", ret, sizeof(dest));
return false;
}

/* Use file stream API if it is available */
if (!FileStreamFetch(conn->conn_info->ssl, local_path, dest, perms))
{
/* Error is already logged */
return false;
success = false;
}

Log(LOG_LEVEL_VERBOSE, "Replacing file '%s' with '%s'...", dest, local_path);
if (rename(dest, local_path) == -1)
}
else {
/* Otherwise, use older protocol */
unlink(dest);
FILE *file_ptr = safe_fopen_create_perms(dest, "wx", perms);
if (file_ptr == NULL)
{
Log(LOG_LEVEL_ERR, "Failed to replace destination file '%s' with basis file '%s': %s", dest, local_path, GetErrorStr());
Log(LOG_LEVEL_WARNING, "Failed to open file %s (fopen: %s)",
dest, GetErrorStr());
return false;
}

return true;
}

/* Otherwise, use old protocol */
char cfchangedstr[sizeof(CF_CHANGEDSTR1 CF_CHANGEDSTR2)];
snprintf(cfchangedstr, sizeof(cfchangedstr), "%s%s",
CF_CHANGEDSTR1, CF_CHANGEDSTR2);

char cfchangedstr[sizeof(CF_CHANGEDSTR1 CF_CHANGEDSTR2)];
snprintf(cfchangedstr, sizeof(cfchangedstr), "%s%s",
CF_CHANGEDSTR1, CF_CHANGEDSTR2);

bool success = true;
uint32_t received_bytes = 0;
while (received_bytes < file_size)
{
int len = TLSRecv(conn->conn_info->ssl, buf, CF_MSGSIZE);
if (len == -1)
{
Log(LOG_LEVEL_WARNING, "Failed to GET file %s:%s",
conn->this_server, remote_path);
success = false;
break;
}
else if (len > CF_MSGSIZE)
uint32_t received_bytes = 0;
while (received_bytes < file_size)
{
Log(LOG_LEVEL_WARNING,
"Incorrect length of incoming packet "
"while retrieving %s:%s, %d > %d",
conn->this_server, remote_path, len, CF_MSGSIZE);
success = false;
break;
}
int len = TLSRecv(conn->conn_info->ssl, buf, CF_MSGSIZE);
if (len == -1)
{
Log(LOG_LEVEL_WARNING, "Failed to GET file %s:%s",
conn->this_server, remote_path);
success = false;
break;
}
else if (len > CF_MSGSIZE)
{
Log(LOG_LEVEL_WARNING,
"Incorrect length of incoming packet "
"while retrieving %s:%s, %d > %d",
conn->this_server, remote_path, len, CF_MSGSIZE);
success = false;
break;
}

if (BadProtoReply(buf))
{
Log(LOG_LEVEL_ERR,
"Error from server while retrieving file %s:%s: %s",
conn->this_server, remote_path, buf);
success = false;
break;
}
if (BadProtoReply(buf))
{
Log(LOG_LEVEL_ERR,
"Error from server while retrieving file %s:%s: %s",
conn->this_server, remote_path, buf);
success = false;
break;
}

if (StringEqualN(buf, cfchangedstr, sizeof(cfchangedstr) - 1))
{
Log(LOG_LEVEL_ERR,
"Remote file %s:%s changed during file transfer",
conn->this_server, remote_path);
success = false;
break;
}
if (StringEqualN(buf, cfchangedstr, sizeof(cfchangedstr) - 1))
{
Log(LOG_LEVEL_ERR,
"Remote file %s:%s changed during file transfer",
conn->this_server, remote_path);
success = false;
break;
}

ret = fwrite(buf, sizeof(char), len, file_ptr);
if (ret < 0)
{
Log(LOG_LEVEL_ERR,
"Failed to write during retrieval of file %s:%s (fwrite: %s)",
conn->this_server, remote_path, GetErrorStr());
success = false;
break;
ret = fwrite(buf, sizeof(char), len, file_ptr);
if (ret < 0)
{
Log(LOG_LEVEL_ERR,
"Failed to write during retrieval of file %s:%s (fwrite: %s)",
conn->this_server, remote_path, GetErrorStr());
success = false;
break;
}

received_bytes += len;
}

received_bytes += len;
fclose(file_ptr);
}

if (!success)
{
unlink(local_path);
Log(LOG_LEVEL_VERBOSE, "Removing file '%s'...", dest);
Copy link
Contributor

Choose a reason for hiding this comment

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

These should be INFO, I think. The rule of thumb is that info: message inform the user about changes being made. (applies below as well)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not according to @olehermanse (see CFE-4470).

Copy link
Contributor

Choose a reason for hiding this comment

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

I have no problem with that. Let's just be consistent.

unlink(dest);
return false;
}

fclose(file_ptr);
return success;
Log(LOG_LEVEL_VERBOSE, "Replacing file '%s' with '%s'...", dest, local_path);
if (rename(dest, local_path) == -1)
{
Log(LOG_LEVEL_ERR, "Failed to replace destination file '%s' with basis file '%s': %s", dest, local_path, GetErrorStr());
return false;
}

return true;
}

bool ProtocolStatGet(AgentConnection *conn, const char *remote_path,
Expand Down
Loading