summaryrefslogtreecommitdiffstats
path: root/src/filenames.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/filenames.c')
-rw-r--r--src/filenames.c151
1 files changed, 151 insertions, 0 deletions
diff --git a/src/filenames.c b/src/filenames.c
new file mode 100644
index 0000000..a3ba7e5
--- /dev/null
+++ b/src/filenames.c
@@ -0,0 +1,151 @@
+/*
+ * filenames.c: compose and dissect man page file names
+ *
+ * Copyright (C) 1994, 1995 Graeme W. Wilford. (Wilf.)
+ * Copyright (C) 2001, 2002 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 <string.h>
+#include <stdlib.h>
+#include <unistd.h>
+
+#include "xvasprintf.h"
+
+#include "gettext.h"
+#define _(String) gettext (String)
+
+#include "manconfig.h"
+
+#include "error.h"
+
+#include "db_storage.h"
+
+#include "filenames.h"
+
+static void gripe_bogus_manpage (const char *manpage)
+{
+ if (quiet < 2)
+ error (0, 0, _("warning: %s: ignoring bogus filename"),
+ manpage);
+}
+
+char *make_filename (const char *path, const char *name,
+ struct mandata *in, const char *type)
+{
+ static char *file;
+
+ if (!name)
+ name = in->name; /* comes from dblookup(), so non-NULL */
+
+ file = xasprintf ("%s/%s%s/%s.%s", path, type, in->sec, name, in->ext);
+
+ if (in->comp && *in->comp != '-') /* Is there an extension? */
+ file = appendstr (file, ".", in->comp, (void *) 0);
+
+ debug ("Checking physical location: %s\n", file);
+ if (!CAN_ACCESS (file, R_OK)) {
+ free (file);
+ return NULL;
+ }
+
+ return file;
+}
+
+/* Fill in a mandata structure with information about a file name.
+ * file is the name to examine. info points to the structure to be filled
+ * in. req_name is the page name that was requested.
+ *
+ * Returns either a pointer to the buffer which the fields in info point
+ * into, to be freed by the caller, or NULL on error. The buffer will
+ * contain either three or four null-terminated strings: the directory name,
+ * the base of the file name in that directory, the section extension, and
+ * optionally the compression extension.
+ *
+ * Only the fields name, ext, sec, and comp are filled in by this function.
+ * name is only set if it differs from req_name; otherwise it remains at
+ * NULL.
+ */
+char *filename_info (const char *file, struct mandata *info,
+ const char *req_name)
+{
+ char *manpage = xstrdup (file);
+ char *slash = strrchr (manpage, '/');
+ char *base_name;
+ struct compression *comp;
+
+ memset (info, 0, sizeof (struct mandata));
+
+ if (slash) {
+ *slash = '\0'; /* strip '/base_name' */
+ base_name = slash + 1;
+ } else
+ base_name = manpage;
+
+ /* Bogus files either have (i) no period, ie no extension, (ii)
+ a compression extension, but no sectional extension, (iii)
+ a missmatch between the section they are under and the
+ sectional part of their extension. */
+
+ comp = comp_info (base_name, 1);
+ if (comp) {
+ info->comp = comp->ext;
+ *(base_name + strlen (comp->stem)) = '\0';
+ free (comp->stem);
+ } else
+ info->comp = NULL;
+
+ {
+ char *ext = strrchr (base_name, '.');
+ if (!ext) {
+ /* no section extension */
+ gripe_bogus_manpage (file);
+ free (manpage);
+ return NULL;
+ }
+ *ext++ = '\0'; /* set section ext */
+ info->ext = ext;
+ if (!*info->ext) {
+ /* zero-length section extension */
+ gripe_bogus_manpage (file);
+ free (manpage);
+ return NULL;
+ }
+ }
+
+ info->sec = strrchr (manpage, '/') + 4; /* set section name */
+
+ if (strlen (info->sec) >= 1 && strlen (info->ext) >= 1 &&
+ info->sec[0] != info->ext[0]) {
+ /* mismatch in section */
+ gripe_bogus_manpage (file);
+ free (manpage);
+ return NULL;
+ }
+
+ if (req_name && !STREQ (base_name, req_name))
+ info->name = xstrdup (base_name);
+ else
+ info->name = NULL;
+
+ return manpage;
+}