src/shared/pager.c

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