3d02bcc2393ae58e3af23c7566555ad04208ea49
   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(struct trace_key *key)
  30{
  31        static struct trace_key trace_default = { "GIT_TRACE" };
  32        const char *trace;
  33
  34        /* use default "GIT_TRACE" if NULL */
  35        if (!key)
  36                key = &trace_default;
  37
  38        /* don't open twice */
  39        if (key->initialized)
  40                return key->fd;
  41
  42        trace = getenv(key->key);
  43
  44        if (!trace || !strcmp(trace, "") ||
  45            !strcmp(trace, "0") || !strcasecmp(trace, "false"))
  46                key->fd = 0;
  47        else if (!strcmp(trace, "1") || !strcasecmp(trace, "true"))
  48                key->fd = STDERR_FILENO;
  49        else if (strlen(trace) == 1 && isdigit(*trace))
  50                key->fd = atoi(trace);
  51        else if (is_absolute_path(trace)) {
  52                int fd = open(trace, O_WRONLY | O_APPEND | O_CREAT, 0666);
  53                if (fd == -1) {
  54                        fprintf(stderr,
  55                                "Could not open '%s' for tracing: %s\n"
  56                                "Defaulting to tracing on stderr...\n",
  57                                trace, strerror(errno));
  58                        key->fd = STDERR_FILENO;
  59                } else {
  60                        key->fd = fd;
  61                        key->need_close = 1;
  62                }
  63        } else {
  64                fprintf(stderr, "What does '%s' for %s mean?\n"
  65                        "If you want to trace into a file, then please set "
  66                        "%s to an absolute pathname (starting with /).\n"
  67                        "Defaulting to tracing on stderr...\n",
  68                        trace, key->key, key->key);
  69                key->fd = STDERR_FILENO;
  70        }
  71
  72        key->initialized = 1;
  73        return key->fd;
  74}
  75
  76void trace_disable(struct trace_key *key)
  77{
  78        if (key->need_close)
  79                close(key->fd);
  80        key->fd = 0;
  81        key->initialized = 1;
  82        key->need_close = 0;
  83}
  84
  85static const char err_msg[] = "Could not trace into fd given by "
  86        "GIT_TRACE environment variable";
  87
  88static int prepare_trace_line(struct trace_key *key, struct strbuf *buf)
  89{
  90        if (!trace_want(key))
  91                return 0;
  92
  93        set_try_to_free_routine(NULL);  /* is never reset */
  94
  95        /* add line prefix here */
  96
  97        return 1;
  98}
  99
 100static void print_trace_line(struct trace_key *key, struct strbuf *buf)
 101{
 102        /* append newline if missing */
 103        if (buf->len && buf->buf[buf->len - 1] != '\n')
 104                strbuf_addch(buf, '\n');
 105
 106        write_or_whine_pipe(get_trace_fd(key), buf->buf, buf->len, err_msg);
 107        strbuf_release(buf);
 108}
 109
 110static void trace_vprintf(struct trace_key *key, const char *format, va_list ap)
 111{
 112        struct strbuf buf = STRBUF_INIT;
 113
 114        if (!prepare_trace_line(key, &buf))
 115                return;
 116
 117        strbuf_vaddf(&buf, format, ap);
 118        print_trace_line(key, &buf);
 119}
 120
 121void trace_printf_key(struct trace_key *key, const char *format, ...)
 122{
 123        va_list ap;
 124        va_start(ap, format);
 125        trace_vprintf(key, format, ap);
 126        va_end(ap);
 127}
 128
 129void trace_printf(const char *format, ...)
 130{
 131        va_list ap;
 132        va_start(ap, format);
 133        trace_vprintf(NULL, format, ap);
 134        va_end(ap);
 135}
 136
 137void trace_strbuf(struct trace_key *key, const struct strbuf *data)
 138{
 139        struct strbuf buf = STRBUF_INIT;
 140
 141        if (!prepare_trace_line(key, &buf))
 142                return;
 143
 144        strbuf_addbuf(&buf, data);
 145        print_trace_line(key, &buf);
 146}
 147
 148void trace_argv_printf(const char **argv, const char *format, ...)
 149{
 150        struct strbuf buf = STRBUF_INIT;
 151        va_list ap;
 152
 153        if (!prepare_trace_line(NULL, &buf))
 154                return;
 155
 156        va_start(ap, format);
 157        strbuf_vaddf(&buf, format, ap);
 158        va_end(ap);
 159
 160        sq_quote_argv(&buf, argv, 0);
 161        print_trace_line(NULL, &buf);
 162}
 163
 164static const char *quote_crnl(const char *path)
 165{
 166        static char new_path[PATH_MAX];
 167        const char *p2 = path;
 168        char *p1 = new_path;
 169
 170        if (!path)
 171                return NULL;
 172
 173        while (*p2) {
 174                switch (*p2) {
 175                case '\\': *p1++ = '\\'; *p1++ = '\\'; break;
 176                case '\n': *p1++ = '\\'; *p1++ = 'n'; break;
 177                case '\r': *p1++ = '\\'; *p1++ = 'r'; break;
 178                default:
 179                        *p1++ = *p2;
 180                }
 181                p2++;
 182        }
 183        *p1 = '\0';
 184        return new_path;
 185}
 186
 187/* FIXME: move prefix to startup_info struct and get rid of this arg */
 188void trace_repo_setup(const char *prefix)
 189{
 190        static struct trace_key key = TRACE_KEY_INIT(SETUP);
 191        const char *git_work_tree;
 192        char cwd[PATH_MAX];
 193
 194        if (!trace_want(&key))
 195                return;
 196
 197        if (!getcwd(cwd, PATH_MAX))
 198                die("Unable to get current working directory");
 199
 200        if (!(git_work_tree = get_git_work_tree()))
 201                git_work_tree = "(null)";
 202
 203        if (!prefix)
 204                prefix = "(null)";
 205
 206        trace_printf_key(&key, "setup: git_dir: %s\n", quote_crnl(get_git_dir()));
 207        trace_printf_key(&key, "setup: worktree: %s\n", quote_crnl(git_work_tree));
 208        trace_printf_key(&key, "setup: cwd: %s\n", quote_crnl(cwd));
 209        trace_printf_key(&key, "setup: prefix: %s\n", quote_crnl(prefix));
 210}
 211
 212int trace_want(struct trace_key *key)
 213{
 214        return !!get_trace_fd(key);
 215}