Add optional bsdcat tool.

bsdcat works like zcat, bzcat, xzcat and similar tools, but auto-detects
source data format, which can also vary between multiple input files.

4 files changed, 248 insertions, 0 deletions

diff --git a/cat/CMakeLists.txt b/cat/CMakeLists.txt
new file mode 100644
index 00000000..3c46aaa2
--- /dev/null
+++ b/cat/CMakeLists.txt
@@ -0,0 +1,31 @@
+############################################
+#
+# How to build bsdcat
+#
+############################################
+IF(ENABLE_CAT)
+
+  SET(bsdcat_SOURCES
+    bsdcat.c
+    bsdcat.h
+  )
+  INCLUDE_DIRECTORIES(${CMAKE_CURRENT_SOURCE_DIR}/../libarchive_fe)
+
+  # bsdcat documentation
+  SET(bsdcat_MANS bsdcat.1)
+
+  # How to build bsdcat
+  ADD_EXECUTABLE(bsdcat ${bsdcat_SOURCES})
+  IF(ENABLE_CAT_SHARED)
+    TARGET_LINK_LIBRARIES(bsdcat archive ${ADDITIONAL_LIBS})
+  ELSE(ENABLE_CAT_SHARED)
+    TARGET_LINK_LIBRARIES(bsdcat archive_static ${ADDITIONAL_LIBS})
+    SET_TARGET_PROPERTIES(bsdcat PROPERTIES COMPILE_DEFINITIONS
+    				 LIBARCHIVE_STATIC)
+  ENDIF(ENABLE_CAT_SHARED)
+  GET_TARGET_PROPERTY(BSDCAT bsdcat LOCATION)
+
+  # Installation rules
+  INSTALL(TARGETS bsdcat RUNTIME DESTINATION bin)
+  INSTALL_MAN(${bsdcat_MANS})
+ENDIF(ENABLE_CAT)
diff --git a/cat/bsdcat.1 b/cat/bsdcat.1
new file mode 100644
index 00000000..4f82b1e5
--- /dev/null
+++ b/cat/bsdcat.1
@@ -0,0 +1,62 @@
+.\" Copyright (c) 2011-2014, Mike Kazantsev
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. 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.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd March 1, 2014
+.Dt BSDCAT 1
+.Os
+.Sh NAME
+.Nm bsdcat
+.Nd expand files to standard output
+.Sh SYNOPSIS
+.Nm
+.Op options
+.Op files
+.Pp
+.Sh DESCRIPTION
+.Nm
+expands files to standard output.
+.Sh OPTIONS
+.Nm
+typically takes a filename as an argument or reads standard input when used in a
+pipe. In both cases decompressed data it written to standard output.
+.Sh EXAMPLES
+.Pp
+To decompress a file:
+.Pp
+.Dl bsdcat example.txt.gz > example.txt
+.Pp
+To decompress standard input in a pipe:
+.Pp
+.Dl cat example.txt.gz | bsdcat > example.txt
+.Pp
+Both examples achieve the same results - a decompressed file by redirecting
+output.
+.Sh SEE ALSO
+.Xr uncompress 1 ,
+.Xr zcat 1 ,
+.Xr bzcat 1 ,
+.Xr xzcat 1 ,
+.Xr libarchive-formats 5 ,
diff --git a/cat/bsdcat.c b/cat/bsdcat.c
new file mode 100644
index 00000000..e9b34487
--- /dev/null
+++ b/cat/bsdcat.c
@@ -0,0 +1,116 @@
+/*-
+ * Copyright (c) 2011-2014, Mike Kazantsev
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``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 AUTHOR(S) 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.
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <getopt.h>
+
+#include "bsdcat.h"
+#include "err.h"
+
+#define	BYTES_PER_BLOCK	(20*512)
+
+struct archive *a;
+struct archive_entry *ae;
+char *bsdcat_current_path;
+int c, err;
+
+
+static struct option long_options[] = {
+	{"help", 0, 0, 'h'},
+	{"version", 0, 0, 'v'},
+	{NULL, 0, NULL, 0}
+};
+
+void
+usage(void)
+{
+	const char *p;
+	p = lafe_getprogname();
+	fprintf(stderr, "Usage: %s [-h] [--help] [--version] [--] [filenames...]\n", p);
+	exit(1);
+}
+
+static void
+version(void)
+{
+	printf("bsdcat %s - %s\n",
+	    BSDCAT_VERSION_STRING,
+	    archive_version_details());
+	exit(0);
+}
+
+void
+bsdcat_next()
+{
+	a = archive_read_new();
+	archive_read_support_filter_all(a);
+	archive_read_support_format_raw(a);
+}
+
+void
+bsdcat_read_to_stdout(char* filename)
+{
+	if ((archive_read_open_filename(a, filename, BYTES_PER_BLOCK) != ARCHIVE_OK)
+	    || (archive_read_next_header(a, &ae) != ARCHIVE_OK)
+	    || (archive_read_data_into_fd(a, 1) != ARCHIVE_OK)
+	    || (archive_read_free(a) != ARCHIVE_OK))
+		goto fail;
+	return;
+fail:
+	lafe_errc(1, 0, "Error: %s - %s",
+	    bsdcat_current_path, archive_error_string(a));
+}
+
+int
+main(int argc, char **argv)
+{
+	lafe_setprogname(*argv, "bsdcat");
+
+	int option_index = 0;
+	while ((c = getopt_long(argc, argv, "h",
+	    long_options, &option_index)) != -1) {
+		switch (c) {
+			case 'v':
+				version();
+				break;
+			default:
+				usage();
+		}
+	}
+
+	bsdcat_next();
+	if (optind >= argc) {
+		bsdcat_current_path = "<stdin>";
+		bsdcat_read_to_stdout(NULL);
+	} else
+		while (optind < argc) {
+			bsdcat_current_path = argv[optind++];
+			bsdcat_read_to_stdout(bsdcat_current_path);
+			bsdcat_next();
+		}
+
+	exit(0);
+}
diff --git a/cat/bsdcat.h b/cat/bsdcat.h
new file mode 100644
index 00000000..5daf3cf3
--- /dev/null
+++ b/cat/bsdcat.h
@@ -0,0 +1,39 @@
+/*-
+ * Copyright (c) 2014, Mike Kazantsev
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``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 AUTHOR(S) 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.
+ */
+
+#if defined(PLATFORM_CONFIG_H)
+/* Use hand-built config.h in environments that need it. */
+#include PLATFORM_CONFIG_H
+#else
+/* Not having a config.h of some sort is a serious problem. */
+#include "config.h"
+#endif
+
+#include <archive.h>
+#include <archive_entry.h>
+
+void usage(void);
+void bsdcat_next(void);
+void bsdcat_read_to_stdout(char* filename);