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 "macro.h"
  31
  32 static pid_t pager_pid = 0;
  33
  34 noreturn static void pager_fallback(void) {
  35         ssize_t n;
  36
  37         do {
  38                 n = splice(STDIN_FILENO, NULL, STDOUT_FILENO, NULL, 64*1024, 0);
  39         } while (n > 0);
  40
  41         if (n < 0) {
  42                 log_error_errno(errno, "Internal pager failed: %m");
  43                 _exit(EXIT_FAILURE);
  44         }
  45
  46         _exit(EXIT_SUCCESS);
  47 }
  48
  49 int pager_open(bool jump_to_end) {
  50         int fd[2];
  51         const char *pager;
  52         pid_t parent_pid;
  53         int r;
  54
  55         if (pager_pid > 0)
  56                 return 1;
  57
  58         if ((pager = getenv("SYSTEMD_PAGER")) || (pager = getenv("PAGER")))
  59                 if (!*pager || streq(pager, "cat"))
  60                         return 0;
  61
  62         if (!on_tty())
  63                 return 0;
  64
  65         /* Determine and cache number of columns before we spawn the
  66          * pager so that we get the value from the actual tty */
  67         columns();
  68
  69         if (pipe(fd) < 0)
  70                 return log_error_errno(errno, "Failed to create pager pipe: %m");
  71
  72         parent_pid = getpid();
  73
  74         pager_pid = fork();
  75         if (pager_pid < 0) {
  76                 r = -errno;
  77                 log_error_errno(errno, "Failed to fork pager: %m");
  78                 safe_close_pair(fd);
  79                 return r;
  80         }
  81
  82         /* In the child start the pager */
  83         if (pager_pid == 0) {
  84                 const char* less_opts;
  85
  86                 dup2(fd[0], STDIN_FILENO);
  87                 safe_close_pair(fd);
  88
  89                 less_opts = getenv("SYSTEMD_LESS");
  90                 if (!less_opts)
  91                         less_opts = "FRSXMK";
  92                 if (jump_to_end)
  93                         less_opts = strjoina(less_opts, " +G");
  94                 setenv("LESS", less_opts, 1);
  95
  96                 /* Make sure the pager goes away when the parent dies */
  97                 if (prctl(PR_SET_PDEATHSIG, SIGTERM) < 0)
  98                         _exit(EXIT_FAILURE);
  99
 100                 /* Check whether our parent died before we were able
 101                  * to set the death signal */
 102                 if (getppid() != parent_pid)
 103                         _exit(EXIT_SUCCESS);
 104
 105                 if (pager) {
 106                         execlp(pager, pager, NULL);
 107                         execl("/bin/sh", "sh", "-c", pager, NULL);
 108                 }
 109
 110                 /* Debian's alternatives command for pagers is
 111                  * called 'pager'. Note that we do not call
 112                  * sensible-pagers here, since that is just a
 113                  * shell script that implements a logic that
 114                  * is similar to this one anyway, but is
 115                  * Debian-specific. */
 116                 execlp("pager", "pager", NULL);
 117
 118                 execlp("less", "less", NULL);
 119                 execlp("more", "more", NULL);
 120
 121                 pager_fallback();
 122                 /* not reached */
 123         }
 124
 125         /* Return in the parent */
 126         if (dup2(fd[1], STDOUT_FILENO) < 0)
 127                 return log_error_errno(errno, "Failed to duplicate pager pipe: %m");
 128
 129         safe_close_pair(fd);
 130         return 1;
 131 }
 132
 133 void pager_close(void) {
 134
 135         if (pager_pid <= 0)
 136                 return;
 137
 138         /* Inform pager that we are done */
 139         fclose(stdout);
 140         kill(pager_pid, SIGCONT);
 141         (void) wait_for_terminate(pager_pid, NULL);
 142         pager_pid = 0;
 143 }
 144
 145 bool pager_have(void) {
 146         return pager_pid > 0;
 147 }
 148
 149 int show_man_page(const char *desc, bool null_stdio) {
 150         const char *args[4] = { "man", NULL, NULL, NULL };
 151         char *e = NULL;
 152         pid_t pid;
 153         size_t k;
 154         int r;
 155         siginfo_t status;
 156
 157         k = strlen(desc);
 158
 159         if (desc[k-1] == ')')
 160                 e = strrchr(desc, '(');
 161
 162         if (e) {
 163                 char *page = NULL, *section = NULL;
 164
 165                 page = strndupa(desc, e - desc);
 166                 section = strndupa(e + 1, desc + k - e - 2);
 167
 168                 args[1] = section;
 169                 args[2] = page;
 170         } else
 171                 args[1] = desc;
 172
 173         pid = fork();
 174         if (pid < 0)
 175                 return log_error_errno(errno, "Failed to fork: %m");
 176
 177         if (pid == 0) {
 178                 /* Child */
 179                 if (null_stdio) {
 180                         r = make_null_stdio();
 181                         if (r < 0) {
 182                                 log_error_errno(r, "Failed to kill stdio: %m");
 183                                 _exit(EXIT_FAILURE);
 184                         }
 185                 }
 186
 187                 execvp(args[0], (char**) args);
 188                 log_error_errno(errno, "Failed to execute man: %m");
 189                 _exit(EXIT_FAILURE);
 190         }
 191
 192         r = wait_for_terminate(pid, &status);
 193         if (r < 0)
 194                 return r;
 195
 196         log_debug("Exit code %i status %i", status.si_code, status.si_status);
 197         return status.si_status;
 198 }