src/shared/pager.c

   1 /***
   2   This file is part of systemd.
   3
   4   Copyright 2010 Lennart Poettering
   5
   6   systemd is free software; you can redistribute it and/or modify it
   7   under the terms of the GNU Lesser General Public License as published by
   8   the Free Software Foundation; either version 2.1 of the License, or
   9   (at your option) any later version.
  10
  11   systemd is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   Lesser General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  18 ***/
  19
  20 #include <errno.h>
  21 #include <signal.h>
  22 #include <stddef.h>
  23 #include <stdint.h>
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include <sys/prctl.h>
  28 #include <unistd.h>
  29
  30 #include "copy.h"
  31 #include "fd-util.h"
  32 #include "locale-util.h"
  33 #include "log.h"
  34 #include "macro.h"
  35 #include "pager.h"
  36 #include "process-util.h"
  37 #include "signal-util.h"
  38 #include "string-util.h"
  39 #include "strv.h"
  40 #include "terminal-util.h"
  41
  42 static pid_t pager_pid = 0;
  43
  44 noreturn static void pager_fallback(void) {
  45         int r;
  46
  47         r = copy_bytes(STDIN_FILENO, STDOUT_FILENO, (uint64_t) -1, 0);
  48         if (r < 0) {
  49                 log_error_errno(r, "Internal pager failed: %m");
  50                 _exit(EXIT_FAILURE);
  51         }
  52
  53         _exit(EXIT_SUCCESS);
  54 }
  55
  56 int pager_open(bool no_pager, bool jump_to_end) {
  57         _cleanup_close_pair_ int fd[2] = { -1, -1 };
  58         const char *pager;
  59         pid_t parent_pid;
  60
  61         if (no_pager)
  62                 return 0;
  63
  64         if (pager_pid > 0)
  65                 return 1;
  66
  67         if (terminal_is_dumb())
  68                 return 0;
  69
  70         pager = getenv("SYSTEMD_PAGER");
  71         if (!pager)
  72                 pager = getenv("PAGER");
  73
  74         /* If the pager is explicitly turned off, honour it */
  75         if (pager && STR_IN_SET(pager, "", "cat"))
  76                 return 0;
  77
  78         /* Determine and cache number of columns before we spawn the
  79          * pager so that we get the value from the actual tty */
  80         (void) columns();
  81
  82         if (pipe(fd) < 0)
  83                 return log_error_errno(errno, "Failed to create pager pipe: %m");
  84
  85         parent_pid = getpid();
  86
  87         pager_pid = fork();
  88         if (pager_pid < 0)
  89                 return log_error_errno(errno, "Failed to fork pager: %m");
  90
  91         /* In the child start the pager */
  92         if (pager_pid == 0) {
  93                 const char* less_opts, *less_charset;
  94
  95                 (void) reset_all_signal_handlers();
  96                 (void) reset_signal_mask();
  97
  98                 (void) dup2(fd[0], STDIN_FILENO);
  99                 safe_close_pair(fd);
 100
 101                 /* Initialize a good set of less options */
 102                 less_opts = getenv("SYSTEMD_LESS");
 103                 if (!less_opts)
 104                         less_opts = "FRSXMK";
 105                 if (jump_to_end)
 106                         less_opts = strjoina(less_opts, " +G");
 107                 if (setenv("LESS", less_opts, 1) < 0)
 108                         _exit(EXIT_FAILURE);
 109
 110                 /* Initialize a good charset for less. This is
 111                  * particularly important if we output UTF-8
 112                  * characters. */
 113                 less_charset = getenv("SYSTEMD_LESSCHARSET");
 114                 if (!less_charset && is_locale_utf8())
 115                         less_charset = "utf-8";
 116                 if (less_charset &&
 117                     setenv("LESSCHARSET", less_charset, 1) < 0)
 118                         _exit(EXIT_FAILURE);
 119
 120                 /* Make sure the pager goes away when the parent dies */
 121                 if (prctl(PR_SET_PDEATHSIG, SIGTERM) < 0)
 122                         _exit(EXIT_FAILURE);
 123
 124                 /* Check whether our parent died before we were able
 125                  * to set the death signal */
 126                 if (getppid() != parent_pid)
 127                         _exit(EXIT_SUCCESS);
 128
 129                 if (pager) {
 130                         execlp(pager, pager, NULL);
 131                         execl("/bin/sh", "sh", "-c", pager, NULL);
 132                 }
 133
 134                 /* Debian's alternatives command for pagers is
 135                  * called 'pager'. Note that we do not call
 136                  * sensible-pagers here, since that is just a
 137                  * shell script that implements a logic that
 138                  * is similar to this one anyway, but is
 139                  * Debian-specific. */
 140                 execlp("pager", "pager", NULL);
 141
 142                 execlp("less", "less", NULL);
 143                 execlp("more", "more", NULL);
 144
 145                 pager_fallback();
 146                 /* not reached */
 147         }
 148
 149         /* Return in the parent */
 150         if (dup2(fd[1], STDOUT_FILENO) < 0)
 151                 return log_error_errno(errno, "Failed to duplicate pager pipe: %m");
 152         if (dup2(fd[1], STDERR_FILENO) < 0)
 153                 return log_error_errno(errno, "Failed to duplicate pager pipe: %m");
 154
 155         return 1;
 156 }
 157
 158 void pager_close(void) {
 159
 160         if (pager_pid <= 0)
 161                 return;
 162
 163         /* Inform pager that we are done */
 164 #ifdef __GLIBC__
 165         stdout = safe_fclose(stdout);
 166         stderr = safe_fclose(stderr);
 167 #else
 168         safe_fclose(stdout);
 169         safe_fclose(stderr);
 170 #endif // __GLIBC__
 171
 172         (void) kill(pager_pid, SIGCONT);
 173         (void) wait_for_terminate(pager_pid, NULL);
 174         pager_pid = 0;
 175 }
 176
 177 bool pager_have(void) {
 178         return pager_pid > 0;
 179 }
 180
 181 #if 0 /// UNNEEDED by elogind
 182 int show_man_page(const char *desc, bool null_stdio) {
 183         const char *args[4] = { "man", NULL, NULL, NULL };
 184         char *e = NULL;
 185         pid_t pid;
 186         size_t k;
 187         int r;
 188         siginfo_t status;
 189
 190         k = strlen(desc);
 191
 192         if (desc[k-1] == ')')
 193                 e = strrchr(desc, '(');
 194
 195         if (e) {
 196                 char *page = NULL, *section = NULL;
 197
 198                 page = strndupa(desc, e - desc);
 199                 section = strndupa(e + 1, desc + k - e - 2);
 200
 201                 args[1] = section;
 202                 args[2] = page;
 203         } else
 204                 args[1] = desc;
 205
 206         pid = fork();
 207         if (pid < 0)
 208                 return log_error_errno(errno, "Failed to fork: %m");
 209
 210         if (pid == 0) {
 211                 /* Child */
 212
 213                 (void) reset_all_signal_handlers();
 214                 (void) reset_signal_mask();
 215
 216                 if (null_stdio) {
 217                         r = make_null_stdio();
 218                         if (r < 0) {
 219                                 log_error_errno(r, "Failed to kill stdio: %m");
 220                                 _exit(EXIT_FAILURE);
 221                         }
 222                 }
 223
 224                 execvp(args[0], (char**) args);
 225                 log_error_errno(errno, "Failed to execute man: %m");
 226                 _exit(EXIT_FAILURE);
 227         }
 228
 229         r = wait_for_terminate(pid, &status);
 230         if (r < 0)
 231                 return r;
 232
 233         log_debug("Exit code %i status %i", status.si_code, status.si_status);
 234         return status.si_status;
 235 }
 236 #endif // 0