cb99f0b11bdeee5dfa76064d38b6410da0f4a709 max Thu Sep 10 00:55:21 2026 -0700 Centralize CGI Content-Type printing in one cgiPrintContentType() helper Around 90 places across the tree hand-rolled the CGI response header, each with its own spelling: "Content-Type:" or "Content-type:", \n or \r\n, and the terminating blank line written as part of the same string, as a separate puts("\n") (which emits two newlines, so a stray blank line led the body) or as printf("\r\n\r\n") (two blank lines). A handful forgot the terminator entirely and relied on a following header to supply it. cgiPrintContentType() in lib/cheapcgi.c now writes the Content-Type line and the blank line that ends the header. Header lines are not ordered, so the callers that also send Status, Set-Cookie, Content-Disposition, Content-Length or X-Sendfile write those first and call this last to close the header; that keeps it to a single helper rather than a print-the-line / end-the-header pair that a caller can half-use. cart.c's existing httpHeaders list already worked this way. Only the CGI response path is touched. The dyStringPrintf("Content-type: ...") calls that build outgoing HTTP *requests* (genomeSpace, oauthLogin, eapMetaSync, edwWebAuthLogin, ga4ghToBed) are unrelated and left alone. Also fills out the apiKey error message in botDelay.c to say where to create a key and that keys are server-specific. No behavior change on the wire beyond dropping those stray blank lines and adding the missing newline after Retry-After. diff --git src/lib/verbose.c src/lib/verbose.c index 9d55d1832b8..66067e25da1 100644 --- src/lib/verbose.c +++ src/lib/verbose.c @@ -1,157 +1,158 @@ /* verbose.c - write out status messages according to the * current verbosity level. These messages go to stderr. */ /* Copyright (C) 2011 The Regents of the University of California * See kent/LICENSE or http://genome.ucsc.edu/license/ for licensing information. */ #include "common.h" #include "portable.h" #include "verbose.h" #include "obscure.h" +#include "cheapcgi.h" static int logVerbosity = 1; /* The level of log verbosity. 0 is silent. */ static FILE *logFile; /* File to log to. */ static boolean checkedDotsEnabled = FALSE; /* have we check for dot output * being enabled? */ static boolean dotsEnabled = FALSE; /* is dot output enabled? */ static boolean doHtml = FALSE; void verboseVa(int verbosity, char *format, va_list args) /* Log with at given verbosity vprintf formatted args. */ { if (verbosity <= logVerbosity) { if (logFile == NULL) logFile = stderr; if (doHtml) { char buf[4096]; int threadId = get_thread_id(); safef(buf, sizeof(buf), "%d %s
", threadId, format); // cannot do two printfs, as they are not thread safe, so the
will not stay with the line vfprintf(logFile, buf, args); } else vfprintf(logFile, format, args); fflush(logFile); } } void verbose(int verbosity, char *format, ...) /* Write printf formatted message to log (which by * default is stderr) if global verbose variable * is set to verbosity or higher. */ { va_list args; va_start(args, format); verboseVa(verbosity, format, args); va_end(args); } static long lastTime = -1; // previous call time. void verboseTimeInit(void) /* Initialize or reinitialize the previous time for use by verboseTime. */ { lastTime = clock1000(); } void verboseTime(int verbosity, char *label, ...) /* Print label and how long it's been since last call. Start time can be * initialized with verboseTimeInit, otherwise the elapsed time will be * zero. */ { assert(label != NULL); // original version allowed this, but breaks some GCCs if (lastTime < 0) verboseTimeInit(); long time = clock1000(); va_list args; va_start(args, label); verboseVa(verbosity, label, args); verbose(verbosity, ": %ld millis\n", time - lastTime); lastTime = time; va_end(args); } boolean verboseDotsEnabled() /* check if outputting of happy dots are enabled. They will be enabled if the * verbosity is > 0, stderr is a tty and we don't appear to be running an * emacs shell. */ { if (!checkedDotsEnabled) { if (logFile == NULL) logFile = stderr; dotsEnabled = (logVerbosity > 0) && isatty(fileno(logFile)); if (dotsEnabled) { /* check for an possible emacs shell */ char *emacs = getenv("emacs"); char *term = getenv("TERM"); if ((emacs != NULL) && (emacs[0] == 't')) dotsEnabled = FALSE; else if ((term != NULL) && sameString(term, "dumb")) dotsEnabled = FALSE; } checkedDotsEnabled = TRUE; } return dotsEnabled; } void verboseDot() /* Write I'm alive dot (at verbosity level 1) */ { if (verboseDotsEnabled()) verbose(1, "."); } void verboseSetLevel(int verbosity) /* Set verbosity level in log. 0 for no logging, * higher number for increasing verbosity. */ { logVerbosity = verbosity; checkedDotsEnabled = FALSE; /* force rechecking of dots enabled */ } int verboseLevel(void) /* Get verbosity level. */ { return logVerbosity; } void verboseSetLogFile(char *name) /* Set logFile for verbose messages overrides stderr. */ { if (sameString(name, "stdout")) logFile = stdout; else if (sameString(name, "stderr")) logFile = stderr; else logFile = mustOpen(name, "w"); } FILE *verboseLogFile() /* Get the verbose log file. */ { if (logFile == NULL) logFile = stderr; return logFile; } void verboseCgi(char *level) /* Set verbosity level for a CGI: if level is not NULL, set output file to stdout, set verbosity and print a content-type header */ { if (level==NULL) return; int levelNum = atoi(level); if (levelNum==0) return; verboseSetLevel(levelNum); verboseSetLogFile("stdout"); - puts("Content-type: text/html\n"); + cgiPrintContentType("text/html"); doHtml = TRUE; verbose(0, "Debugging output activated, level %d", levelNum); }