Make cat work correctly depending on env var

* If the env var UBERFTP_CAT_CORRECT is present, omit the odd UNIX newline
  that is printed out for non-empty files
* Fixes #22

Author: fscheiner

ChangeLog

@@ -2,6 +2,10 @@ Version 2.9.1 (Pre Release)
 	- The fix for recursive listings was incomplete and created a regression
 	  preventing recursive file transfer operations to succeed. This is
 	  fixed now.
+	- If the environment variable UBERFTP_CAT_CORRECT is present, this
+	  version omits the odd newline that is printed out by the cat
+	  functionality of previous versions of UberFTP. If not, the old
+	  behaviour is used for compatibility reasons.
 
 Version 2.9 09/02/22
 	- Build fixed for 32bit

NEWS

@@ -4,6 +4,8 @@ Version number scheme changed to semver (see semver.org)
 Bugfixes:
 - get -r and mget didn't work correctly in version 2.9 compared to version 2.8.
   This is fixed in this version.
+- cat did put out an odd newline after the file contents in previous versions.
+  This is prevented if the environment variable UBERFTP_CAT_CORRECT is present.
 
 Version 2.9
 -----------

cmds.c

@@ -278,7 +278,9 @@ static cmd_t gcmdlist [] = {
 "bye\n", NULL},
 
 	{ _c_cat,     "cat", C_A_RCH_1|C_A_STRINGS,
-"Print the contents of the remote file(s) to stdout.\n",
+"Print the contents of the remote file(s) to stdout.\n"
+"See CAT BEHAVIOUR in uberftp(1) for details about the behaviour of this\n"
+"functionality.\n",
 "cat file1 [file2 ... filen]\n", NULL},
 
 	{ _c_chdir,   "cd", C_A_RCH_1|C_A_OSTRING,
@@ -396,7 +398,9 @@ static cmd_t gcmdlist [] = {
 "seconds  number of seconds between NOOPs. Disabled if zero.\n"},
 
 	{ _c_cat,   "lcat", C_A_LCH_1|C_A_STRINGS,
-"Print the contents of the local file(s) to stdout.\n",
+"Print the contents of the local file(s) to stdout.\n"
+"See CAT BEHAVIOUR in uberftp(1) for details about the behaviour of this\n"
+"functionality.\n",
 "lcat file1 [file2 ... filen]\n", NULL},
 
 	{ _c_chdir, "lcd", C_A_LCH_1|C_A_OSTRING,
@@ -1465,8 +1469,11 @@ _c_cat(ch_t * ch, char ** files)
 				FREE(buf);
 			}
 
-			if (nl)
-				o_printf(DEBUG_ERRS_ONLY, "\n");
+			if ( getenv("UBERFTP_CAT_CORRECT") == NULL )
+			{
+				if (nl)
+					o_printf(DEBUG_ERRS_ONLY, "\n");
+			}
 
 finish:
 			ecl = l_close(ch->lh);
@@ -3807,7 +3814,7 @@ main()
 	char * tok   = NULL;
 	int    i     = 0;
 
-	printf(".TH UBERFTP 1C \"16 May 2008\"\n");
+	printf(".TH UBERFTP 1 \"22 Jul 2022\"\n");
 	printf(".SH COMMANDS\n");
 
 	for (i = 0; gcmdlist[i].name != NULL; i++)

main.c

@@ -385,7 +385,9 @@ printf(
 #ifndef MSSFTP
   "The supported \"-cmds\" are:\n"
   "\t-cat <url>\n"
-  "\t              Print to stdout the contents of the remote file.\n"
+  "\t              Print to stdout the contents of the remote file. See CAT\n"
+  "\t              BEHAVIOUR in uberftp(1) for details about the behaviour of\n"
+  "\t              this functionality.\n"
   "\t-chgrp [-r] group <url>\n"
   "\t              Set the group ownership on the remote object(s).\n"
   "\t-chmod [-r] perms <url>\n"

packaging/fedora/uberftp.spec

@@ -36,10 +36,11 @@ make install DESTDIR=%{buildroot}
 
 %changelog
 
-* Thu Jul 14 2022 Frank Scheiner <scheiner@hlrs.de> - 2.9.1-1
+* Thu Jul 22 2022 Frank Scheiner <scheiner@hlrs.de> - 2.9.1-1
 - New upstream version 2.9.1
 - changed version scheme to semver (see semver.org)
 - fixed recursive listings
+- correct cat behaviour depending on environment var
 
 * Tue Jan 18 2022 Frank Scheiner <scheiner@hlrs.de> - 2.9-1
 - New upstream version 2.9

uberftp.1

@@ -1,5 +1,5 @@
 .\" @(#)uberftp.1c 1.34 90/02/15 SMI; from UCB 4.3
-.TH UBERFTP 1C "12 Nov 2020"
+.TH UBERFTP 1 "22 Jul 2022"
 .SH NAME
 uberftp \- GridFTP-enabled client
 .SH SYNOPSIS
@@ -183,7 +183,8 @@ Print version information about all used globus modules and exit.
 .SH Supported \-cmds
 .TP
 .B \-cat \fIurl\fR
-Print to stdout the contents of the remote file.
+Print to stdout the contents of the remote file. See \fBCAT BEHAVIOUR\fR below for
+details about the behaviour of this functionality.
 .TP
 .B \-chgrp [\fI-r\fR] \fIgroup\fR \fIurl\fR
 Set the group ownership of the remote object(s).
@@ -290,7 +291,8 @@ Prints information regarding bug reporting and feature requests.
 Close all control and data connections and exit.
 .TP
 .B cat \fIfile1\fR [\fIfile2\fR ... \fIfilen\fR]
-Print the contents of the remote file(s) to stdout.
+Print the contents of the remote file(s) to stdout. See \fBCAT BEHAVIOUR\fR below for
+details about the behaviour of this functionality.
 .TP
 .B cdup
 Change the remote working directory up one level.
@@ -400,7 +402,8 @@ displayed. This feature is disabled by default.
 seconds  number of seconds between NOOPs. Disabled if zero.
 .TP
 .B lcat \fIfile1\fR [\fIfile2\fR ... \fIfilen\fR]
-Print the contents of the local file(s) to stdout.
+Print the contents of the local file(s) to stdout. See \fBCAT BEHAVIOUR\fR below for
+details about the behaviour of this functionality.
 .TP
 .B lcd [\fIdir\fR]
 Change the local working directory to \fIdir\fR. If \fIdir\fR is not given,
@@ -796,6 +799,21 @@ Setting the ephemeral port range to an unusable range will cause UberFTP connect
 to fail. For instance, setting a port range from 10 to 100 with a non root process will
 fail on most operating systems.
 
+.SH CAT BEHAVIOUR
+.LP
+UberFTP 2.9.1 comes with an additional environment variable:
+
+  UBERFTP_CAT_CORRECT
+
+If this environment variable is present UberFTP omits the odd newline that is
+otherwise printed out in addition to the file contents by the \fBcat\fR
+functionality of previous versions of UberFTP for non-empty files. If it is not
+present, the old behaviour is used for compatibility reasons. The content of
+this environment variable is not evaluated, just its presence in your
+environment. Also see:
+
+  https://github.com/gridcf/UberFTP/issues/22
+
 .SH EXIT VALUES
 .LP
 UberFTP will exit with a value of 0 if no errors occurred during the session,