trace.con commit trace: refactor to support multiple env variables (0679660)
   1/*
   2 * GIT - The information manager from hell
   3 *
   4 * Copyright (C) 2000-2002 Michael R. Elkins <me@mutt.org>
   5 * Copyright (C) 2002-2004 Oswald Buddenhagen <ossi@users.sf.net>
   6 * Copyright (C) 2004 Theodore Y. Ts'o <tytso@mit.edu>
   7 * Copyright (C) 2006 Mike McCormack
   8 * Copyright (C) 2006 Christian Couder
   9 *
  10 *  This program is free software; you can redistribute it and/or modify
  11 *  it under the terms of the GNU General Public License as published by
  12 *  the Free Software Foundation; either version 2 of the License, or
  13 *  (at your option) any later version.
  14 *
  15 *  This program is distributed in the hope that it will be useful,
  16 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 *  GNU General Public License for more details.
  19 *
  20 *  You should have received a copy of the GNU General Public License
  21 *  along with this program; if not, write to the Free Software
  22 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23 */
  24
  25#include "cache.h"
  26#include "quote.h"
  27
  28/* Get a trace file descriptor from "key" env variable. */
  29static int get_trace_fd(const char *key, int *need_close)
  30{
  31        char *trace = getenv(key);
  32
  33        if (!trace || !strcmp(trace, "") ||
  34            !strcmp(trace, "0") || !strcasecmp(trace, "false"))
  35                return 0;
  36        if (!strcmp(trace, "1") || !strcasecmp(trace, "true"))
  37                return STDERR_FILENO;
  38        if (strlen(trace) == 1 && isdigit(*trace))
  39                return atoi(trace);
  40        if (is_absolute_path(trace)) {
  41                int fd = open(trace, O_WRONLY | O_APPEND | O_CREAT, 0666);
  42                if (fd == -1) {
  43                        fprintf(stderr,
  44                                "Could not open '%s' for tracing: %s\n"
  45                                "Defaulting to tracing on stderr...\n",
  46                                trace, strerror(errno));
  47                        return STDERR_FILENO;
  48                }
  49                *need_close = 1;
  50                return fd;
  51        }
  52
  53        fprintf(stderr, "What does '%s' for %s mean?\n", trace, key);
  54        fprintf(stderr, "If you want to trace into a file, "
  55                "then please set %s to an absolute pathname "
  56                "(starting with /).\n", key);
  57        fprintf(stderr, "Defaulting to tracing on stderr...\n");
  58
  59        return STDERR_FILENO;
  60}
  61
  62static const char err_msg[] = "Could not trace into fd given by "
  63        "GIT_TRACE environment variable";
  64
  65void trace_vprintf(const char *key, const char *fmt, va_list ap)
  66{
  67        struct strbuf buf = STRBUF_INIT;
  68        int fd, need_close = 0;
  69
  70        fd = get_trace_fd(key, &need_close);
  71        if (!fd)
  72                return;
  73
  74        set_try_to_free_routine(NULL);  /* is never reset */
  75        strbuf_vaddf(&buf, fmt, ap);
  76        write_or_whine_pipe(fd, buf.buf, buf.len, err_msg);
  77        strbuf_release(&buf);
  78
  79        if (need_close)
  80                close(fd);
  81}
  82
  83void trace_printf_key(const char *key, const char *fmt, ...)
  84{
  85        va_list ap;
  86        va_start(ap, fmt);
  87        trace_vprintf(key, fmt, ap);
  88        va_end(ap);
  89}
  90
  91void trace_printf(const char *fmt, ...)
  92{
  93        va_list ap;
  94        va_start(ap, fmt);
  95        trace_vprintf("GIT_TRACE", fmt, ap);
  96        va_end(ap);
  97}
  98
  99void trace_argv_printf(const char **argv, const char *fmt, ...)
 100{
 101        struct strbuf buf = STRBUF_INIT;
 102        va_list ap;
 103        int fd, need_close = 0;
 104
 105        fd = get_trace_fd("GIT_TRACE", &need_close);
 106        if (!fd)
 107                return;
 108
 109        set_try_to_free_routine(NULL);  /* is never reset */
 110        va_start(ap, fmt);
 111        strbuf_vaddf(&buf, fmt, ap);
 112        va_end(ap);
 113
 114        sq_quote_argv(&buf, argv, 0);
 115        strbuf_addch(&buf, '\n');
 116        write_or_whine_pipe(fd, buf.buf, buf.len, err_msg);
 117        strbuf_release(&buf);
 118
 119        if (need_close)
 120                close(fd);
 121}
 122
 123static const char *quote_crnl(const char *path)
 124{
 125        static char new_path[PATH_MAX];
 126        const char *p2 = path;
 127        char *p1 = new_path;
 128
 129        if (!path)
 130                return NULL;
 131
 132        while (*p2) {
 133                switch (*p2) {
 134                case '\\': *p1++ = '\\'; *p1++ = '\\'; break;
 135                case '\n': *p1++ = '\\'; *p1++ = 'n'; break;
 136                case '\r': *p1++ = '\\'; *p1++ = 'r'; break;
 137                default:
 138                        *p1++ = *p2;
 139                }
 140                p2++;
 141        }
 142        *p1 = '\0';
 143        return new_path;
 144}
 145
 146/* FIXME: move prefix to startup_info struct and get rid of this arg */
 147void trace_repo_setup(const char *prefix)
 148{
 149        const char *git_work_tree;
 150        char cwd[PATH_MAX];
 151        char *trace = getenv("GIT_TRACE");
 152
 153        if (!trace || !strcmp(trace, "") ||
 154            !strcmp(trace, "0") || !strcasecmp(trace, "false"))
 155                return;
 156
 157        if (!getcwd(cwd, PATH_MAX))
 158                die("Unable to get current working directory");
 159
 160        if (!(git_work_tree = get_git_work_tree()))
 161                git_work_tree = "(null)";
 162
 163        if (!prefix)
 164                prefix = "(null)";
 165
 166        trace_printf("setup: git_dir: %s\n", quote_crnl(get_git_dir()));
 167        trace_printf("setup: worktree: %s\n", quote_crnl(git_work_tree));
 168        trace_printf("setup: cwd: %s\n", quote_crnl(cwd));
 169        trace_printf("setup: prefix: %s\n", quote_crnl(prefix));
 170}