src/prompt.c

   1 /* prompt.c -- prompt routines for vlock,
   2  *             the VT locking program for linux
   3  *
   4  * This program is copyright (C) 2007 Frank Benkstein, and is free
   5  * software which is freely distributable under the terms of the
   6  * GNU General Public License version 2, included as the file COPYING in this
   7  * distribution.  It is NOT public domain software, and any
   8  * redistribution not permitted by the GNU General Public License is
   9  * expressly forbidden without prior written permission from
  10  * the author.
  11  *
  12  *
  13  * The prompt functions (prompt and prompt_echo_off) were
  14  * inspired by/copied from openpam's openpam_ttyconv.c:
  15  *
  16  * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
  17  *
  18  * Redistribution and use in source and binary forms, with or without
  19  * modification, are permitted provided that the following conditions
  20  * are met:
  21  * 1. Redistributions of source code must retain the above copyright
  22  *    notice, this list of conditions and the following disclaimer.
  23  * 2. Redistributions in binary form must reproduce the above copyright
  24  *    notice, this list of conditions and the following disclaimer in the
  25  *    documentation and/or other materials provided with the distribution.
  26  * 3. The name of the author may not be used to endorse or promote
  27  *    products derived from this software without specific prior written
  28  *    permission.
  29  *
  30  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  31  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  32  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  33  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  34  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  35  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  36  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  37  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  38  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  39  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  40  * SUCH DAMAGE.
  41  *
  42  */
  43
  44 #include <stdio.h>
  45 #include <stdlib.h>
  46 #include <string.h>
  47 #include <termios.h>
  48 #include <unistd.h>
  49 #include <sys/select.h>
  50
  51 #include "vlock.h"
  52
  53 #define PROMPT_BUFFER_SIZE 512
  54
  55 char *prompt(const char *msg, const struct timespec *timeout) {
  56   char buffer[PROMPT_BUFFER_SIZE];
  57   char *result;
  58   int len;
  59   struct termios term;
  60   struct timeval timeout_val;
  61   struct timeval *timeout_val_p = NULL;
  62   tcflag_t lflag;
  63   fd_set readfds;
  64
  65   if (timeout != NULL) {
  66     timeout_val.tv_sec = timeout->tv_sec;
  67     timeout_val.tv_usec = timeout->tv_nsec / 1000;
  68     timeout_val_p = &timeout_val;
  69   }
  70
  71   if (msg != NULL) {
  72     /* Write out the prompt. */
  73     (void) fputs(msg, stderr); fflush(stderr);
  74   }
  75
  76   /* Get the current terminal attributes. */
  77   (void) tcgetattr(STDIN_FILENO, &term);
  78   /* Save the lflag value. */
  79   lflag = term.c_lflag;
  80   /* Enable canonical mode.  We're only interested in line buffering. */
  81   term.c_lflag |= ICANON;
  82   /* Disable terminal signals. */
  83   term.c_lflag &= ~ISIG;
  84   /* Set the terminal attributes. */
  85   (void) tcsetattr(STDIN_FILENO, TCSAFLUSH, &term);
  86   /* Discard all unread input characters. */
  87   (void) tcflush(STDIN_FILENO, TCIFLUSH);
  88
  89   /* Initialize file descriptor set. */
  90   FD_ZERO(&readfds);
  91   FD_SET(STDIN_FILENO, &readfds);
  92
  93   /* Wait until a string was entered. */
  94   if (select(STDIN_FILENO+1, &readfds, NULL, NULL, &timeout_val) != 1) {
  95     result = NULL;
  96     goto out;
  97   }
  98
  99   /* Read the string from stdin.  At most buffer length - 1 bytes, to
 100    * leave room for the terminating zero byte. */
 101   if ((len = read(STDIN_FILENO, buffer, sizeof buffer - 1)) < 0) {
 102     result = NULL;
 103     goto out;
 104   }
 105
 106   /* Terminate the string. */
 107   buffer[len] = '\0';
 108
 109   /* Strip trailing newline characters. */
 110   for (len = strlen(buffer); len > 0; --len) {
 111     if (buffer[len-1] != '\r' && buffer[len-1] != '\n')
 112       break;
 113   }
 114
 115   /* Terminate the string, again. */
 116   buffer[len] = '\0';
 117
 118   /* Copy the string. */
 119   result = strdup(buffer);
 120
 121   /* Clear our buffer. */
 122   memset(buffer, 0, sizeof buffer);
 123
 124 out:
 125   /* Restore original terminal attributes. */
 126   term.c_lflag = lflag;
 127   (void) tcsetattr(STDIN_FILENO, TCSAFLUSH, &term);
 128
 129   return result;
 130 }
 131
 132 char *prompt_echo_off(const char *msg, const struct timespec *timeout) {
 133   struct termios term;
 134   tcflag_t lflag;
 135   char *result;
 136
 137   (void) tcgetattr(STDIN_FILENO, &term);
 138   lflag = term.c_lflag;
 139   term.c_lflag &= ~ECHO;
 140   (void) tcsetattr(STDIN_FILENO, TCSAFLUSH, &term);
 141
 142   result = prompt(msg, timeout);
 143
 144   term.c_lflag = lflag;
 145   (void) tcsetattr(STDIN_FILENO, TCSAFLUSH, &term);
 146
 147   if (result != NULL)
 148     fputc('\n', stderr);
 149
 150   return result;
 151 }