summaryrefslogtreecommitdiffstats
path: root/src/man-recode.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/man-recode.c')
-rw-r--r--src/man-recode.c296
1 files changed, 296 insertions, 0 deletions
diff --git a/src/man-recode.c b/src/man-recode.c
new file mode 100644
index 0000000..e198d17
--- /dev/null
+++ b/src/man-recode.c
@@ -0,0 +1,296 @@
+/*
+ * man-recode.c: convert manual pages to another encoding
+ *
+ * Copyright (C) 2019 Colin Watson.
+ *
+ * This file is part of man-db.
+ *
+ * man-db is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * man-db is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with man-db; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif /* HAVE_CONFIG_H */
+
+#include <stdbool.h>
+#include <stdlib.h>
+#include <string.h>
+#include <assert.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+
+#include "argp.h"
+#include "dirname.h"
+#include "error.h"
+#include "gl_array_list.h"
+#include "gl_xlist.h"
+#include "progname.h"
+#include "tempname.h"
+#include "xalloc.h"
+#include "xvasprintf.h"
+
+#include "gettext.h"
+#define _(String) gettext (String)
+#define N_(String) gettext_noop (String)
+
+#include "manconfig.h"
+
+#include "pipeline.h"
+
+#include "cleanup.h"
+#include "compression.h"
+#include "debug.h"
+#include "encodings.h"
+#include "fatal.h"
+#include "glcontainers.h"
+#include "sandbox.h"
+#include "util.h"
+
+#include "decompress.h"
+#include "manconv.h"
+#include "manconv_client.h"
+
+int quiet = 0;
+man_sandbox *sandbox;
+
+static char *to_code;
+static gl_list_t filenames;
+static const char *suffix;
+static bool in_place;
+
+struct try_file_at_args {
+ int dir_fd;
+ int flags;
+};
+
+static int
+try_file_at (char *tmpl, void *flags)
+{
+ struct try_file_at_args *args = flags;
+ return openat (args->dir_fd, tmpl,
+ (args->flags & ~O_ACCMODE) | O_RDWR | O_CREAT | O_EXCL,
+ S_IRUSR | S_IWUSR);
+}
+
+static int
+mkstempat (int dir_fd, char *xtemplate)
+{
+ struct try_file_at_args args;
+
+ args.dir_fd = dir_fd;
+ args.flags = 0;
+ return try_tempname (xtemplate, 0, &args, try_file_at);
+}
+
+enum opts {
+ OPT_SUFFIX = 256,
+ OPT_IN_PLACE = 257,
+ OPT_MAX
+};
+
+const char *argp_program_version = "man-recode " PACKAGE_VERSION;
+const char *argp_program_bug_address = PACKAGE_BUGREPORT;
+error_t argp_err_exit_status = FAIL;
+
+static const char args_doc[] =
+ N_("-t CODE {--suffix SUFFIX | --in-place} FILENAME...");
+
+static struct argp_option options[] = {
+ OPT ("to-code", 't', N_("CODE"), N_("encoding for output")),
+ OPT ("suffix", OPT_SUFFIX, N_("SUFFIX"),
+ N_("suffix to append to output file name")),
+ OPT ("in-place", OPT_IN_PLACE, 0,
+ N_("overwrite input files in place")),
+ OPT ("debug", 'd', 0, N_("emit debugging messages")),
+ OPT ("quiet", 'q', 0, N_("produce fewer warnings")),
+ OPT_HELP_COMPAT,
+ { 0 }
+};
+
+static error_t parse_opt (int key, char *arg, struct argp_state *state)
+{
+ switch (key) {
+ case 't':
+ to_code = xstrdup (arg);
+ return 0;
+ case OPT_SUFFIX:
+ suffix = arg;
+ return 0;
+ case OPT_IN_PLACE:
+ in_place = true;
+ return 0;
+ case 'd':
+ debug_level = true;
+ return 0;
+ case 'q':
+ quiet = 1;
+ return 0;
+ case 'h':
+ argp_state_help (state, state->out_stream,
+ ARGP_HELP_STD_HELP);
+ break;
+ case ARGP_KEY_ARG:
+ gl_list_add_last (filenames, xstrdup (arg));
+ return 0;
+ case ARGP_KEY_NO_ARGS:
+ argp_usage (state);
+ break;
+ case ARGP_KEY_SUCCESS:
+ if (!to_code)
+ argp_error (state,
+ _("must specify an output "
+ "encoding"));
+ if (!suffix && !in_place)
+ argp_error (state,
+ _("must use either --suffix or "
+ "--in-place"));
+ if (suffix && in_place)
+ argp_error (state,
+ _("--suffix and --in-place are "
+ "mutually exclusive"));
+ return 0;
+ }
+ return ARGP_ERR_UNKNOWN;
+}
+
+static struct argp argp = { options, parse_opt, args_doc };
+
+static void recode (const char *filename)
+{
+ decompress *decomp;
+ pipeline *convert, *decomp_p;
+ struct compression *comp;
+ int dir_fd = -1;
+ char *dirname, *basename, *stem, *outfilename;
+ char *page_encoding;
+ int status;
+
+ decomp = decompress_open (filename, 0);
+ if (!decomp)
+ error (FAIL, 0, _("can't open %s"), filename);
+
+ dirname = dir_name (filename);
+ basename = base_name (filename);
+ comp = comp_info (basename, true);
+ if (comp)
+ stem = comp->stem; /* steal memory */
+ else
+ stem = xstrdup (basename);
+
+ convert = pipeline_new ();
+ if (suffix) {
+ outfilename = xasprintf ("%s/%s%s", dirname, stem, suffix);
+ pipeline_want_outfile (convert, outfilename);
+ } else {
+ int dir_fd_open_flags;
+ char *template_path;
+ int outfd;
+
+ dir_fd_open_flags = O_SEARCH | O_DIRECTORY;
+#ifdef O_PATH
+ dir_fd_open_flags |= O_PATH;
+#endif
+ dir_fd = open (dirname, dir_fd_open_flags);
+ if (dir_fd < 0)
+ fatal (errno, _("can't open %s"), dirname);
+
+ outfilename = xasprintf ("%s.XXXXXX", stem);
+ /* For error messages. */
+ template_path = xasprintf ("%s/%s", dirname, outfilename);
+ outfd = mkstempat (dir_fd, outfilename);
+ if (outfd == -1)
+ fatal (errno,
+ _("can't open temporary file %s"),
+ template_path);
+ free (template_path);
+ pipeline_want_out (convert, outfd);
+ }
+
+ decompress_start (decomp);
+ page_encoding = check_preprocessor_encoding (decomp, NULL, NULL);
+ if (!page_encoding) {
+ char *lang = lang_dir (filename);
+ page_encoding = get_page_encoding (lang);
+ free (lang);
+ }
+ debug ("guessed input encoding %s for %s\n", page_encoding, filename);
+ add_manconv (convert, page_encoding, to_code);
+
+ if (!pipeline_get_ncommands (convert))
+ pipeline_command (convert, pipecmd_new_passthrough ());
+
+ decomp_p = decompress_get_pipeline (decomp);
+ pipeline_connect (decomp_p, convert, (void *) 0);
+ pipeline_pump (decomp_p, convert, (void *) 0);
+ pipeline_wait (decomp_p);
+ status = pipeline_wait (convert);
+ if (status != 0)
+ error (CHILD_FAIL, 0, _("command exited with status %d: %s"),
+ status, pipeline_tostring (convert));
+
+ if (in_place) {
+ assert (dir_fd != -1);
+ if (renameat (dir_fd, outfilename, dir_fd, stem) == -1) {
+ char *outfilepath = xasprintf
+ ("%s/%s", dirname, outfilename);
+ unlink (outfilename);
+ fatal (errno, _("can't rename %s to %s"),
+ outfilepath, filename);
+ }
+ debug ("stem: %s, basename: %s\n", stem, basename);
+ if (!STREQ (stem, basename)) {
+ if (unlinkat (dir_fd, basename, 0) == -1)
+ fatal (errno, _("can't remove %s"), filename);
+ }
+ }
+
+ free (page_encoding);
+ free (outfilename);
+ free (stem);
+ free (basename);
+ free (dirname);
+ if (dir_fd)
+ close (dir_fd);
+ pipeline_free (convert);
+ decompress_free (decomp);
+}
+
+int main (int argc, char *argv[])
+{
+ const char *filename;
+
+ set_program_name (argv[0]);
+
+ init_debug ();
+ pipeline_install_post_fork (pop_all_cleanups);
+ sandbox = sandbox_init ();
+ init_locale ();
+ filenames = new_string_list (GL_ARRAY_LIST, true);
+
+ if (argp_parse (&argp, argc, argv, 0, 0, 0))
+ exit (FAIL);
+
+ GL_LIST_FOREACH (filenames, filename)
+ recode (filename);
+
+ free (to_code);
+
+ gl_list_free (filenames);
+ sandbox_free (sandbox);
+
+ return 0;
+}