mdocml: fix section name bugs in man-cgi

because of the previous patch that allows man-cgi to use
`.gz`-compressed manpages, there were some issues in various places.

also adds patch that allows for injecting HTML into `<head>`, so we can
drop putting custom stuff in mandoc.css and just add a second stylesheet
when building the containers in void-infrastructure.
This commit is contained in:
classabbyamp 2024-02-16 20:07:36 -05:00 committed by classabbyamp
parent c80a9a10dc
commit 45756e8cde
4 changed files with 161 additions and 63 deletions

View file

@ -1,61 +0,0 @@
/** Void style **/
html {
--fg: #333;
--bg: #fff;
--fg-accent: #478061;
--nav-fg: #fff;
--nav-bg: #478061;
}
@media (prefers-color-scheme: dark) {
html {
--fg: #ccc;
--bg: #222;
--fg-accent: #62b086;
--nav-fg: #fff;
--nav-bg: #295340;
}
}
a, :link, :visited { color: var(--fg-accent); }
a:hover { color: var(--fg); }
html { max-width: 100% }
body { margin: 0 }
.manual-text { max-width: 65em; padding: 0 1em; }
nav#void-nav {
width:100%;
min-height:50px;
color:var(--nav-fg);
background-color:var(--nav-bg);
z-index:110;
font-size:14px
}
nav#void-nav ul {
display:block;
list-style:none;
margin:0
}
nav#void-nav ul li {
display:inline-block;
margin:0;
}
nav#void-nav ul li a {
display:inline-block;
padding:15px;
line-height:20px;
font-size:1.2em;
color:var(--nav-fg);
text-decoration: none
}
nav#void-nav ul li a:hover,nav#void-nav ul li a:focus {
color:#fff;
background-color:#000;
text-decoration:none
}
/** Hide architecture selector **/
select[name="arch"] {
display: none;
}

View file

@ -0,0 +1,60 @@
allows for injecting html into <head> for man-cgi
https://inbox.vuxu.org/mandoc-tech/4d6a587e4edb6a4bd7fc6c5a790e3cf9e16ed7a6.camel@placeviolette.net/T/#u
--- a/cgi.c
+++ b/cgi.c
@@ -408,11 +408,14 @@
printf("(%.*s)", secsz, sec);
fputs(" - ", stdout);
}
- printf("%s</title>\n"
- "</head>\n"
- "<body>\n",
+ printf("%s</title>\n",
CUSTOMIZE_TITLE);
+ resp_copy(MAN_DIR "/head.html");
+
+ printf("</head>\n"
+ "<body>\n");
+
resp_copy(MAN_DIR "/header.html");
}
--- a/man.cgi.3 15 Mar 2017 13:18:53 -0000 1.4
+++ b/man.cgi.3 7 Nov 2022 17:32:35 -0000
@@ -240,8 +240,10 @@
.It Ft void Fn resp_begin_html "int code" "const char *msg" "const char *file"
This generator calls
.Fn resp_begin_http
-to print the HTTP headers, then prints the HTML header up to the
-opening tag of the <body> element, then copies the file
+to print the HTTP headers, then prints the HTML header, then copies the file
+.Pa head.html
+to the output, if it exists and is readable, then prints up to the opening tag
+of the <body> element, then copies the file
.Pa header.html
to the output, if it exists and is readable.
If
--- a/man.cgi.8 6 Jul 2022 15:47:28 -0000 1.24
+++ b/man.cgi.8 7 Nov 2022 17:32:35 -0000
@@ -199,6 +199,7 @@
for this purpose.
The files
.Pa manpath.conf ,
+.Pa head.html ,
.Pa header.html ,
and
.Pa footer.html
@@ -380,6 +381,10 @@
.Sx Restricted character set ,
.Nm
reports an internal server error and exits without doing anything.
+.It Pa /man/head.html
+An optional file containing static HTML code to be inserted right before
+closing the <HEAD> element.
+For example, it can contain additional <META> tags or <LINK>s to other resources.
.It Pa /man/header.html
An optional file containing static HTML code to be wrapped in
a <HEADER> element and inserted right after opening the <BODY> element.

View file

@ -0,0 +1,100 @@
fixes issues with the cgi script caused by our hacked-in gzip support.
* the page <title> showed foo.N(gz) instead of foo(N)
* links in apropos results linked to .../foo.N.gz instead of .../foo.N,
confusing man-cgi
* redirects for single-result apropos searches redirected to .../foo.N.gz too
--- a/cgi.c
+++ b/cgi.c
@@ -99,6 +99,7 @@
static int validate_filename(const char *);
static int validate_manpath(const struct req *, const char *);
static int validate_urifrag(const char *);
+static char * filename_trim_gz(const char *);
static const char *scriptname = SCRIPT_NAME;
@@ -139,6 +140,18 @@
};
static const int arch_MAX = sizeof(arch_names) / sizeof(char *);
+static char *
+filename_trim_gz(const char *s) {
+ char *r, *cp;
+ if (s == NULL || (r = malloc(strlen(s) + 1)) == NULL)
+ return NULL;
+ strcpy(r, s);
+ cp = strrchr(r, '.');
+ if (cp != NULL && strcasecmp(cp, ".gz") == 0)
+ *cp = '\0';
+ return r;
+}
+
/*
* Print a character, escaping HTML along the way.
* This will pass non-ASCII straight to output: be warned!
@@ -641,7 +641,7 @@
static void
pg_searchres(const struct req *req, struct manpage *r, size_t sz)
{
- char *arch, *archend;
+ char *arch, *archend, *fn;
const char *sec;
size_t i, iuse;
int archprio, archpriouse;
@@ -654,9 +667,11 @@
printf("%s/", scriptname);
if (strcmp(req->q.manpath, req->p[0]))
printf("%s/", req->q.manpath);
+ fn = filename_trim_gz(r[0].file);
printf("%s\r\n"
"Content-Type: text/html; charset=utf-8\r\n\r\n",
- r[0].file);
+ fn);
+ free(fn);
return;
}
@@ -699,7 +714,9 @@
priouse = prio;
iuse = i;
}
- resp_begin_html(200, NULL, r[iuse].file);
+ fn = filename_trim_gz(r[iuse].file);
+ resp_begin_html(200, NULL, fn);
+ free(fn);
} else
resp_begin_html(200, NULL, NULL);
@@ -716,7 +733,9 @@
printf("%s/", scriptname);
if (strcmp(req->q.manpath, req->p[0]))
printf("%s/", req->q.manpath);
- printf("%s\">", r[i].file);
+ fn = filename_trim_gz(r[i].file);
+ printf("%s\">", fn);
+ free(fn);
html_print(r[i].names);
printf("</a></td>\n"
" <td><span class=\"Nd\">");
@@ -951,7 +951,7 @@
static void
pg_show(struct req *req, const char *fullpath)
{
- char *manpath;
+ char *manpath, *fn;
const char *file;
if ((file = strchr(fullpath, '/')) == NULL) {
@@ -970,7 +989,9 @@
return;
}
- resp_begin_html(200, NULL, file);
+ fn = filename_trim_gz(file);
+ resp_begin_html(200, NULL, fn);
+ free(fn);
resp_searchform(req, FOCUS_NONE);
resp_show(req, file);
resp_end_html();

View file

@ -1,7 +1,7 @@
# Template file for 'mdocml'
pkgname=mdocml
version=1.14.6
revision=7
revision=8
build_style=configure
make_build_args="all man.cgi"
make_check_target="regress"
@ -29,7 +29,6 @@ alternatives="
CFLAGS="-fcommon"
post_patch() {
cat ${FILESDIR}/void.css >>mandoc.css
cp ${FILESDIR}/cgi.h .
}
pre_configure() {