##// END OF EJS Templates
hgweb: only include graph-related data in jsdata variable on /graph pages (BC)...
hgweb: only include graph-related data in jsdata variable on /graph pages (BC) Historically, client-side graph code was not only rendering the graph itself, but it was also adding all of the changeset information to the page as well. It meant that JavaScript code needed to construct valid HTML as a string (although proper escaping was done server-side). It wasn't too clunky, even though it meant that a lot of server-side things were duplicated client-side for no good reason, but the worst thing about it was the data format it used. It was somewhat future-proof, but not human-friendly, because it was just a tuple: it was possible to append things to it (as was done in e.g. 270f57d35525), but you'd then have to remember the indices and reading the resulting JS code wasn't easy, because cur[8] is not descriptive at all. So what would need to happen for graph to have more features, such as more changeset information or a different vertex style (branch-closing, obsolete)? First you'd need to take some property, process it (e.g. escape and pass through templatefilters function, and mind the encoding too), append it to jsdata and remember its index, then go add nearly identical JavaScript code to 4 different hgweb themes that use jsdata to render HTML, and finally try and forget how brittle it all felt. Oh yeah, and the indices go to double digits if we add 2 more items, say phase and obsolescence, and there are more to come. Rendering vertex in a different style would need another property (say, character "o", "_", or "x"), except if you want to be backwards-compatible, it would need to go after tags and bookmarks, and that just doesn't feel right. So here I'm trying to fix both the duplication of code and the data format: - changesets will be rendered by hgweb templates the same way as changelog and other such pages, so jsdata won't need any information that's not needed for rendering the graph itself - jsdata will be a dict, or an Object in JS, which is a lot nicer to humans and is a lot more future-proof in the long run, because it doesn't use numeric indices What about hgweb themes? Obviously, this will break all hgweb themes that render graph in JavaScript, including 3rd-party custom ones. But this will also reduce the size of client-side code and make it more uniform, so that it can be shared across hgweb themes, further reducing its size. The next few patches demonstrate that it's not hard to adapt a theme to these changes. And in a later series, I'm planning to move duplicate JS code from */graph.tmpl to mercurial.js and leave only 4 lines of code embedded in those <script> elements, and even that would be just to allow redefining graph.vertex function. So adapting a custom 3rd-party theme to these changes would mean: - creating or copying graphnode.tmpl and adding it to the map file (if a theme doesn't already use __base__) - modifying one line in graph.tmpl and simply removing the bigger part of JavaScript code from there Making these changes in this patch and not updating every hgweb theme that uses jsdata at the same time is a bit of a cheat to make this series more manageable: /graph pages that use jsdata are broken by this patch, but since there are no tests that would detect this, bisect works fine; and themes are updated separately, in the next 4 patches of this series to ease reviewing.

File last commit:

r34310:b94db178 default
r35218:d61f2a3d default
Show More
util.c
199 lines | 4.2 KiB | text/x-c | CLexer
Yuya Nishihara
chg: import frontend sources...
r28060 /*
* Utility functions
*
* Copyright (c) 2011 Yuya Nishihara <yuya@tcha.org>
*
* This software may be used and distributed according to the terms of the
* GNU General Public License version 2 or any later version.
*/
Jun Wu
chg: add util function abortmsgerrno to print error with errno...
r28788 #include <errno.h>
Jun Wu
chg: extract the logic of setting FD_CLOEXEC to a utility function...
r28855 #include <fcntl.h>
Yuya Nishihara
chg: import frontend sources...
r28060 #include <signal.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
Yuya Nishihara
chg: initialize sigaction fields more reliably...
r28084 #include <string.h>
Jun Wu
chg: show timestamp with debug messages...
r34310 #include <sys/time.h>
Yuya Nishihara
chg: import frontend sources...
r28060 #include <sys/types.h>
#include <sys/wait.h>
#include <unistd.h>
#include "util.h"
Jun Wu
chg: use color in debug/error messages conditionally...
r28787 static int colorenabled = 0;
static inline void fsetcolor(FILE *fp, const char *code)
{
if (!colorenabled)
return;
fprintf(fp, "\033[%sm", code);
}
Jun Wu
chg: add util function abortmsgerrno to print error with errno...
r28788 static void vabortmsgerrno(int no, const char *fmt, va_list args)
{
fsetcolor(stderr, "1;31");
fputs("chg: abort: ", stderr);
vfprintf(stderr, fmt, args);
if (no != 0)
fprintf(stderr, " (errno = %d, %s)", no, strerror(no));
fsetcolor(stderr, "");
fputc('\n', stderr);
exit(255);
}
Yuya Nishihara
chg: import frontend sources...
r28060 void abortmsg(const char *fmt, ...)
{
va_list args;
va_start(args, fmt);
Jun Wu
chg: add util function abortmsgerrno to print error with errno...
r28788 vabortmsgerrno(0, fmt, args);
Yuya Nishihara
chg: import frontend sources...
r28060 va_end(args);
Jun Wu
chg: add util function abortmsgerrno to print error with errno...
r28788 }
Yuya Nishihara
chg: import frontend sources...
r28060
Jun Wu
chg: add util function abortmsgerrno to print error with errno...
r28788 void abortmsgerrno(const char *fmt, ...)
{
int no = errno;
va_list args;
va_start(args, fmt);
vabortmsgerrno(no, fmt, args);
va_end(args);
Yuya Nishihara
chg: import frontend sources...
r28060 }
static int debugmsgenabled = 0;
Jun Wu
chg: show timestamp with debug messages...
r34310 static double debugstart = 0;
static double now() {
struct timeval t;
gettimeofday(&t, NULL);
return t.tv_usec / 1e6 + t.tv_sec;
}
Yuya Nishihara
chg: import frontend sources...
r28060
Jun Wu
chg: use color in debug/error messages conditionally...
r28787 void enablecolor(void)
{
colorenabled = 1;
}
Yuya Nishihara
chg: import frontend sources...
r28060 void enabledebugmsg(void)
{
debugmsgenabled = 1;
Jun Wu
chg: show timestamp with debug messages...
r34310 debugstart = now();
Yuya Nishihara
chg: import frontend sources...
r28060 }
void debugmsg(const char *fmt, ...)
{
if (!debugmsgenabled)
return;
va_list args;
va_start(args, fmt);
Jun Wu
chg: use color in debug/error messages conditionally...
r28787 fsetcolor(stderr, "1;30");
Jun Wu
chg: show timestamp with debug messages...
r34310 fprintf(stderr, "chg: debug: %4.6f ", now() - debugstart);
Yuya Nishihara
chg: import frontend sources...
r28060 vfprintf(stderr, fmt, args);
Jun Wu
chg: use color in debug/error messages conditionally...
r28787 fsetcolor(stderr, "");
fputc('\n', stderr);
Yuya Nishihara
chg: import frontend sources...
r28060 va_end(args);
}
Jun Wu
chg: add fchdirx as a utility function...
r28854 void fchdirx(int dirfd)
{
int r = fchdir(dirfd);
if (r == -1)
abortmsgerrno("failed to fchdir");
}
Jun Wu
chg: extract the logic of setting FD_CLOEXEC to a utility function...
r28855 void fsetcloexec(int fd)
{
int flags = fcntl(fd, F_GETFD);
if (flags < 0)
abortmsgerrno("cannot get flags of fd %d", fd);
if (fcntl(fd, F_SETFD, flags | FD_CLOEXEC) < 0)
abortmsgerrno("cannot set flags of fd %d", fd);
}
Jun Wu
chg: add utility functions mallocx, reallocx...
r28165 void *mallocx(size_t size)
{
void *result = malloc(size);
if (!result)
abortmsg("failed to malloc");
return result;
}
void *reallocx(void *ptr, size_t size)
{
void *result = realloc(ptr, size);
if (!result)
abortmsg("failed to realloc");
return result;
}
Yuya Nishihara
chg: import frontend sources...
r28060 /*
* Execute a shell command in mostly the same manner as system(), with the
* give environment variables, after chdir to the given cwd. Returns a status
* code compatible with the Python subprocess module.
*/
int runshellcmd(const char *cmd, const char *envp[], const char *cwd)
{
enum { F_SIGINT = 1, F_SIGQUIT = 2, F_SIGMASK = 4, F_WAITPID = 8 };
unsigned int doneflags = 0;
int status = 0;
struct sigaction newsa, oldsaint, oldsaquit;
sigset_t oldmask;
/* block or mask signals just as system() does */
Yuya Nishihara
chg: initialize sigaction fields more reliably...
r28084 memset(&newsa, 0, sizeof(newsa));
Yuya Nishihara
chg: import frontend sources...
r28060 newsa.sa_handler = SIG_IGN;
newsa.sa_flags = 0;
if (sigemptyset(&newsa.sa_mask) < 0)
goto done;
if (sigaction(SIGINT, &newsa, &oldsaint) < 0)
goto done;
doneflags |= F_SIGINT;
if (sigaction(SIGQUIT, &newsa, &oldsaquit) < 0)
goto done;
doneflags |= F_SIGQUIT;
if (sigaddset(&newsa.sa_mask, SIGCHLD) < 0)
goto done;
if (sigprocmask(SIG_BLOCK, &newsa.sa_mask, &oldmask) < 0)
goto done;
doneflags |= F_SIGMASK;
pid_t pid = fork();
if (pid < 0)
goto done;
if (pid == 0) {
sigaction(SIGINT, &oldsaint, NULL);
sigaction(SIGQUIT, &oldsaquit, NULL);
sigprocmask(SIG_SETMASK, &oldmask, NULL);
if (cwd && chdir(cwd) < 0)
_exit(127);
const char *argv[] = {"sh", "-c", cmd, NULL};
if (envp) {
execve("/bin/sh", (char **)argv, (char **)envp);
} else {
execv("/bin/sh", (char **)argv);
}
_exit(127);
} else {
if (waitpid(pid, &status, 0) < 0)
goto done;
doneflags |= F_WAITPID;
}
done:
if (doneflags & F_SIGINT)
sigaction(SIGINT, &oldsaint, NULL);
if (doneflags & F_SIGQUIT)
sigaction(SIGQUIT, &oldsaquit, NULL);
if (doneflags & F_SIGMASK)
sigprocmask(SIG_SETMASK, &oldmask, NULL);
/* no way to report other errors, use 127 (= shell termination) */
if (!(doneflags & F_WAITPID))
return 127;
if (WIFEXITED(status))
return WEXITSTATUS(status);
if (WIFSIGNALED(status))
return -WTERMSIG(status);
return 127;
}