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 <sys/types.h>
  23 #include <fcntl.h>
  24 #include <stdlib.h>
  25 #include <unistd.h>
  26 #include <string.h>
  27 #include <sys/prctl.h>
  28
  29 #include "pager.h"
  30 #include "util.h"
  31 #include "macro.h"
  32
  33 static pid_t pager_pid = 0;
  34
  35 _noreturn_ static void pager_fallback(void) {
  36         ssize_t n;
  37         do {
  38                 n = splice(STDIN_FILENO, NULL, STDOUT_FILENO, NULL, 64*1024, 0);
  39         } while (n > 0);
  40         if (n < 0) {
  41                 log_error("Internal pager failed: %m");
  42                 _exit(EXIT_FAILURE);
  43         }
  44         _exit(EXIT_SUCCESS);
  45 }
  46
  47 int pager_open(void) {
  48         int fd[2];
  49         const char *pager;
  50         pid_t parent_pid;
  51         int r;
  52
  53         if (pager_pid > 0)
  54                 return 1;
  55
  56         if ((pager = getenv("SYSTEMD_PAGER")) || (pager = getenv("PAGER")))
  57                 if (!*pager || streq(pager, "cat"))
  58                         return 0;
  59
  60         if (isatty(STDOUT_FILENO) <= 0)
  61                 return 0;
  62
  63         /* Determine and cache number of columns before we spawn the
  64          * pager so that we get the value from the actual tty */
  65         columns();
  66
  67         if (pipe(fd) < 0) {
  68                 log_error("Failed to create pager pipe: %m");
  69                 return -errno;
  70         }
  71
  72         parent_pid = getpid();
  73
  74         pager_pid = fork();
  75         if (pager_pid < 0) {
  76                 r = -errno;
  77                 log_error("Failed to fork pager: %m");
  78                 close_pipe(fd);
  79                 return r;
  80         }
  81
  82         /* In the child start the pager */
  83         if (pager_pid == 0) {
  84
  85                 dup2(fd[0], STDIN_FILENO);
  86                 close_pipe(fd);
  87
  88                 setenv("LESS", "FRSX", 0);
  89
  90                 /* Make sure the pager goes away when the parent dies */
  91                 if (prctl(PR_SET_PDEATHSIG, SIGTERM) < 0)
  92                         _exit(EXIT_FAILURE);
  93
  94                 /* Check whether our parent died before we were able
  95                  * to set the death signal */
  96                 if (getppid() != parent_pid)
  97                         _exit(EXIT_SUCCESS);
  98
  99                 if (pager) {
 100                         execlp(pager, pager, NULL);
 101                         execl("/bin/sh", "sh", "-c", pager, NULL);
 102                 }
 103
 104                 /* Debian's alternatives command for pagers is
 105                  * called 'pager'. Note that we do not call
 106                  * sensible-pagers here, since that is just a
 107                  * shell script that implements a logic that
 108                  * is similar to this one anyway, but is
 109                  * Debian-specific. */
 110                 execlp("pager", "pager", NULL);
 111
 112                 execlp("less", "less", NULL);
 113                 execlp("more", "more", NULL);
 114
 115                 pager_fallback();
 116                 /* not reached */
 117         }
 118
 119         /* Return in the parent */
 120         if (dup2(fd[1], STDOUT_FILENO) < 0) {
 121                 log_error("Failed to duplicate pager pipe: %m");
 122                 return -errno;
 123         }
 124
 125         close_pipe(fd);
 126         return 1;
 127 }
 128
 129 void pager_close(void) {
 130
 131         if (pager_pid <= 0)
 132                 return;
 133
 134         /* Inform pager that we are done */
 135         fclose(stdout);
 136         kill(pager_pid, SIGCONT);
 137         wait_for_terminate(pager_pid, NULL);
 138         pager_pid = 0;
 139 }
 140
 141 bool pager_have(void) {
 142         return pager_pid > 0;
 143 }