Line | Count | Source (jump to first uncovered line) |
1 | | #include "git-compat-util.h" |
2 | | #include "config.h" |
3 | | #include "editor.h" |
4 | | #include "pager.h" |
5 | | #include "run-command.h" |
6 | | #include "sigchain.h" |
7 | | #include "alias.h" |
8 | | |
9 | | int pager_use_color = 1; |
10 | | |
11 | | #ifndef DEFAULT_PAGER |
12 | 0 | #define DEFAULT_PAGER "less" |
13 | | #endif |
14 | | |
15 | | static struct child_process pager_process; |
16 | | static char *pager_program; |
17 | | static int old_fd1 = -1, old_fd2 = -1; |
18 | | |
19 | | /* Is the value coming back from term_columns() just a guess? */ |
20 | | static int term_columns_guessed; |
21 | | |
22 | | |
23 | | static void close_pager_fds(void) |
24 | 0 | { |
25 | | /* signal EOF to pager */ |
26 | 0 | close(1); |
27 | 0 | if (old_fd2 != -1) |
28 | 0 | close(2); |
29 | 0 | } |
30 | | |
31 | | static void finish_pager(void) |
32 | 0 | { |
33 | 0 | fflush(stdout); |
34 | 0 | fflush(stderr); |
35 | 0 | close_pager_fds(); |
36 | 0 | finish_command(&pager_process); |
37 | 0 | } |
38 | | |
39 | | static void wait_for_pager_atexit(void) |
40 | 0 | { |
41 | 0 | if (old_fd1 == -1) |
42 | 0 | return; |
43 | | |
44 | 0 | finish_pager(); |
45 | 0 | } |
46 | | |
47 | | void wait_for_pager(void) |
48 | 0 | { |
49 | 0 | if (old_fd1 == -1) |
50 | 0 | return; |
51 | | |
52 | 0 | finish_pager(); |
53 | 0 | sigchain_pop_common(); |
54 | 0 | unsetenv("GIT_PAGER_IN_USE"); |
55 | 0 | dup2(old_fd1, 1); |
56 | 0 | close(old_fd1); |
57 | 0 | old_fd1 = -1; |
58 | 0 | if (old_fd2 != -1) { |
59 | 0 | dup2(old_fd2, 2); |
60 | 0 | close(old_fd2); |
61 | 0 | old_fd2 = -1; |
62 | 0 | } |
63 | 0 | } |
64 | | |
65 | | static void wait_for_pager_signal(int signo) |
66 | 0 | { |
67 | 0 | if (old_fd1 == -1) |
68 | 0 | return; |
69 | | |
70 | 0 | close_pager_fds(); |
71 | 0 | finish_command_in_signal(&pager_process); |
72 | 0 | sigchain_pop(signo); |
73 | 0 | raise(signo); |
74 | 0 | } |
75 | | |
76 | | static int core_pager_config(const char *var, const char *value, |
77 | | const struct config_context *ctx UNUSED, |
78 | | void *data UNUSED) |
79 | 0 | { |
80 | 0 | if (!strcmp(var, "core.pager")) |
81 | 0 | return git_config_string(&pager_program, var, value); |
82 | 0 | return 0; |
83 | 0 | } |
84 | | |
85 | | const char *git_pager(int stdout_is_tty) |
86 | 0 | { |
87 | 0 | const char *pager; |
88 | |
|
89 | 0 | if (!stdout_is_tty) |
90 | 0 | return NULL; |
91 | | |
92 | 0 | pager = getenv("GIT_PAGER"); |
93 | 0 | if (!pager) { |
94 | 0 | if (!pager_program) |
95 | 0 | read_early_config(core_pager_config, NULL); |
96 | 0 | pager = pager_program; |
97 | 0 | } |
98 | 0 | if (!pager) |
99 | 0 | pager = getenv("PAGER"); |
100 | 0 | if (!pager) |
101 | 0 | pager = DEFAULT_PAGER; |
102 | 0 | if (!*pager || !strcmp(pager, "cat")) |
103 | 0 | pager = NULL; |
104 | |
|
105 | 0 | return pager; |
106 | 0 | } |
107 | | |
108 | | static void setup_pager_env(struct strvec *env) |
109 | 0 | { |
110 | 0 | const char **argv; |
111 | 0 | int i; |
112 | 0 | char *pager_env = xstrdup(PAGER_ENV); |
113 | 0 | int n = split_cmdline(pager_env, &argv); |
114 | |
|
115 | 0 | if (n < 0) |
116 | 0 | die("malformed build-time PAGER_ENV: %s", |
117 | 0 | split_cmdline_strerror(n)); |
118 | | |
119 | 0 | for (i = 0; i < n; i++) { |
120 | 0 | char *cp = strchr(argv[i], '='); |
121 | |
|
122 | 0 | if (!cp) |
123 | 0 | die("malformed build-time PAGER_ENV"); |
124 | | |
125 | 0 | *cp = '\0'; |
126 | 0 | if (!getenv(argv[i])) { |
127 | 0 | *cp = '='; |
128 | 0 | strvec_push(env, argv[i]); |
129 | 0 | } |
130 | 0 | } |
131 | 0 | free(pager_env); |
132 | 0 | free(argv); |
133 | 0 | } |
134 | | |
135 | | void prepare_pager_args(struct child_process *pager_process, const char *pager) |
136 | 0 | { |
137 | 0 | strvec_push(&pager_process->args, pager); |
138 | 0 | pager_process->use_shell = 1; |
139 | 0 | setup_pager_env(&pager_process->env); |
140 | 0 | pager_process->trace2_child_class = "pager"; |
141 | 0 | } |
142 | | |
143 | | void setup_pager(void) |
144 | 0 | { |
145 | 0 | static int once = 0; |
146 | 0 | const char *pager = git_pager(isatty(1)); |
147 | |
|
148 | 0 | if (!pager) |
149 | 0 | return; |
150 | | |
151 | | /* |
152 | | * After we redirect standard output, we won't be able to use an ioctl |
153 | | * to get the terminal size. Let's grab it now, and then set $COLUMNS |
154 | | * to communicate it to any sub-processes. |
155 | | */ |
156 | 0 | { |
157 | 0 | char buf[64]; |
158 | 0 | xsnprintf(buf, sizeof(buf), "%d", term_columns()); |
159 | 0 | if (!term_columns_guessed) |
160 | 0 | setenv("COLUMNS", buf, 0); |
161 | 0 | } |
162 | |
|
163 | 0 | setenv("GIT_PAGER_IN_USE", "true", 1); |
164 | |
|
165 | 0 | child_process_init(&pager_process); |
166 | | |
167 | | /* spawn the pager */ |
168 | 0 | prepare_pager_args(&pager_process, pager); |
169 | 0 | pager_process.in = -1; |
170 | 0 | strvec_push(&pager_process.env, "GIT_PAGER_IN_USE"); |
171 | 0 | if (start_command(&pager_process)) |
172 | 0 | die("unable to execute pager '%s'", pager); |
173 | | |
174 | | /* original process continues, but writes to the pipe */ |
175 | 0 | old_fd1 = dup(1); |
176 | 0 | dup2(pager_process.in, 1); |
177 | 0 | if (isatty(2)) { |
178 | 0 | old_fd2 = dup(2); |
179 | 0 | dup2(pager_process.in, 2); |
180 | 0 | } |
181 | 0 | close(pager_process.in); |
182 | |
|
183 | 0 | sigchain_push_common(wait_for_pager_signal); |
184 | |
|
185 | 0 | if (!once) { |
186 | 0 | once++; |
187 | 0 | atexit(wait_for_pager_atexit); |
188 | 0 | } |
189 | 0 | } |
190 | | |
191 | | int pager_in_use(void) |
192 | 0 | { |
193 | 0 | return git_env_bool("GIT_PAGER_IN_USE", 0); |
194 | 0 | } |
195 | | |
196 | | /* |
197 | | * Return cached value (if set) or $COLUMNS environment variable (if |
198 | | * set and positive) or ioctl(1, TIOCGWINSZ).ws_col (if positive), |
199 | | * and default to 80 if all else fails. |
200 | | */ |
201 | | int term_columns(void) |
202 | 0 | { |
203 | 0 | static int term_columns_at_startup; |
204 | |
|
205 | 0 | char *col_string; |
206 | 0 | int n_cols; |
207 | |
|
208 | 0 | if (term_columns_at_startup) |
209 | 0 | return term_columns_at_startup; |
210 | | |
211 | 0 | term_columns_at_startup = 80; |
212 | 0 | term_columns_guessed = 1; |
213 | |
|
214 | 0 | col_string = getenv("COLUMNS"); |
215 | 0 | if (col_string && (n_cols = atoi(col_string)) > 0) { |
216 | 0 | term_columns_at_startup = n_cols; |
217 | 0 | term_columns_guessed = 0; |
218 | 0 | } |
219 | 0 | #ifdef TIOCGWINSZ |
220 | 0 | else { |
221 | 0 | struct winsize ws; |
222 | 0 | if (!ioctl(1, TIOCGWINSZ, &ws) && ws.ws_col) { |
223 | 0 | term_columns_at_startup = ws.ws_col; |
224 | 0 | term_columns_guessed = 0; |
225 | 0 | } |
226 | 0 | } |
227 | 0 | #endif |
228 | |
|
229 | 0 | return term_columns_at_startup; |
230 | 0 | } |
231 | | |
232 | | /* |
233 | | * Clear the entire line, leave cursor in first column. |
234 | | */ |
235 | | void term_clear_line(void) |
236 | 0 | { |
237 | 0 | if (!isatty(2)) |
238 | 0 | return; |
239 | 0 | if (is_terminal_dumb()) |
240 | | /* |
241 | | * Fall back to print a terminal width worth of space |
242 | | * characters (hoping that the terminal is still as wide |
243 | | * as it was upon the first call to term_columns()). |
244 | | */ |
245 | 0 | fprintf(stderr, "\r%*s\r", term_columns(), ""); |
246 | 0 | else |
247 | | /* |
248 | | * On non-dumb terminals use an escape sequence to clear |
249 | | * the whole line, no matter how wide the terminal. |
250 | | */ |
251 | 0 | fputs("\r\033[K", stderr); |
252 | 0 | } |
253 | | |
254 | | /* |
255 | | * How many columns do we need to show this number in decimal? |
256 | | */ |
257 | | int decimal_width(uintmax_t number) |
258 | 0 | { |
259 | 0 | int width; |
260 | |
|
261 | 0 | for (width = 1; number >= 10; width++) |
262 | 0 | number /= 10; |
263 | 0 | return width; |
264 | 0 | } |
265 | | |
266 | | struct pager_command_config_data { |
267 | | const char *cmd; |
268 | | int want; |
269 | | char *value; |
270 | | }; |
271 | | |
272 | | static int pager_command_config(const char *var, const char *value, |
273 | | const struct config_context *ctx UNUSED, |
274 | | void *vdata) |
275 | 0 | { |
276 | 0 | struct pager_command_config_data *data = vdata; |
277 | 0 | const char *cmd; |
278 | |
|
279 | 0 | if (skip_prefix(var, "pager.", &cmd) && !strcmp(cmd, data->cmd)) { |
280 | 0 | int b = git_parse_maybe_bool(value); |
281 | 0 | if (b >= 0) |
282 | 0 | data->want = b; |
283 | 0 | else { |
284 | 0 | data->want = 1; |
285 | 0 | data->value = xstrdup(value); |
286 | 0 | } |
287 | 0 | } |
288 | |
|
289 | 0 | return 0; |
290 | 0 | } |
291 | | |
292 | | /* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */ |
293 | | int check_pager_config(const char *cmd) |
294 | 0 | { |
295 | 0 | struct pager_command_config_data data; |
296 | |
|
297 | 0 | data.cmd = cmd; |
298 | 0 | data.want = -1; |
299 | 0 | data.value = NULL; |
300 | |
|
301 | 0 | read_early_config(pager_command_config, &data); |
302 | |
|
303 | 0 | if (data.value) |
304 | 0 | pager_program = data.value; |
305 | 0 | return data.want; |
306 | 0 | } |