java - 确定 Java 程序是否已从交互式 shell 启动

Question

我曾经以为

System.console() != null

是确定启动我的 Java 应用程序的 shell 是否为交互式的可靠方法。这让我可以使用 ANSI escape sequences在交互模式和纯 System.out/System.err 每当程序的输出被重定向到文件或通过管道传输到其他进程的标准输入时，类似于 --color=auto许多 GNU 实用程序的模式。

但是，

System.console() 行为在 Windows 中有所不同。当 JVM 从 cmd.exe 启动时，方法确实返回一个非null值(这对我来说没用，因为cmd.exe 不理解转义序列)，返回值是always null 当我从 < em>Cygwin -- xterm、mintty 或 cygwin(最后一个只是一个 cmd.exe 运行一个 bash 子进程)。

如何在不读取 shell 脚本中的 $- 并将命令行参数传递到我的 Java 程序的情况下，在 Java 中测试交互式 shell？从 Java 测试 PS1 环境变量不是一个选项，因为 Java 是从 shell 脚本启动的，所以父进程是一个非交互式 shell，并且 PS1 未设置.

Answer 1

有一个conversation Cygwin 的维护者 (Corinna Vinschen) 解释说 Cygwin 伪 TTY 看起来像 Microsoft Visual C 运行时库 (MSVCRT) 的管道。她还建议围绕识别 Cygwin 伪 TTY 的 isatty() 函数实现包装器。

这个想法是获取与给定文件描述符关联的管道名称。 NtQueryInformationFile函数获取 FILE_NAME_INFORMATION结构，其中 FileName 成员包含管道名称。如果管道名称与以下模式匹配，则很可能该命令以交互模式运行:

\cygwin-%16llx-pty%d-{to,from}-master

对话很老了，但是管道名称的格式还是一样的: "\\\\.\\pipe\\cygwin-" + "%S-" + + "pty%d-from-master" ，其中 "\\\\.\\pipe\\" 是命名管道的约定前缀(参见 CreateNamedPipe )。

所以 Cygwin 部分已经被黑了。下一步是从 C 代码创建 Java 函数。

例子

以下代码创建了 ttyjni.TestApp 类，其中包含通过 Java native 接口(interface) (JNI) 实现的 istty() 方法。该代码在 GNU/Linux (x86_64) 和 Windows 7(64 位)上的 Cygwin 上进行了测试。代码可以很容易地移植到 Windows (cmd.exe)，甚至可以按原样运行。

必需的组件

• 带有 x86_64-w64-mingw32-gcc 编译器的 Cygwin
• 带有 JDK 的 Windows

布局

├── Makefile
├── TestApp.c
├── test.sh
├── ttyjni
│   └── TestApp.java
└── ttyjni_TestApp.h

生成文件

# Input: $JAVA_HOME

FINAL_TARGETS := TestApp.class

ifeq ($(OS),Windows_NT)
  CC=x86_64-w64-mingw32-gcc
  FINAL_TARGETS += testapp.dll
else
  CC=gcc
  FINAL_TARGETS += libtestapp.so
endif

all: $(FINAL_TARGETS)

TestApp.class: ttyjni/TestApp.java
  javac $<

testapp.dll: TestApp.c TestApp.class
  $(CC) \
    -Wl,--add-stdcall-alias \
    -D__int64="long long" \
    -D_isatty=isatty -D_fileno=fileno \
    -I"$(JAVA_HOME)/include" \
    -I"$(JAVA_HOME)/include/win32" \
    -shared -o $@ $<

libtestapp.so: TestApp.c
  $(CC) \
    -I"$(JAVA_HOME)/include" \
    -I"$(JAVA_HOME)/include/linux" \
    -fPIC \
    -o $@ -shared -Wl,-soname,testapp.so $<  \
    -z noexecstack

clean:
  rm -f *.o $(FINAL_TARGETS) ttyjni/*.class

TestApp.c

#include <jni.h>
#include <stdio.h>
#include "ttyjni_TestApp.h"

#if defined __CYGWIN__ || defined __MINGW32__ || defined __MINGW64__
#include <io.h>
#include <errno.h>
#include <wchar.h>
#include <windows.h>
#include <winternl.h>
#include <unistd.h>


/* vvvvvvvvvv From http://cygwin.com/ml/cygwin/2012-11/txt00003.txt vvvvvvvv */

#ifndef __MINGW64_VERSION_MAJOR
/* MS winternl.h defines FILE_INFORMATION_CLASS, but with only a
   different single member. */
enum FILE_INFORMATION_CLASSX
{
  FileNameInformation = 9
};

typedef struct _FILE_NAME_INFORMATION
{
  ULONG FileNameLength;
  WCHAR FileName[1];
} FILE_NAME_INFORMATION, *PFILE_NAME_INFORMATION;

NTSTATUS (NTAPI *pNtQueryInformationFile) (HANDLE, PIO_STATUS_BLOCK, PVOID,
    ULONG, FILE_INFORMATION_CLASSX);
#else
NTSTATUS (NTAPI *pNtQueryInformationFile) (HANDLE, PIO_STATUS_BLOCK, PVOID,
    ULONG, FILE_INFORMATION_CLASS);
#endif

jint
testapp_isatty(jint fd)
{
  HANDLE fh;
  NTSTATUS status;
  IO_STATUS_BLOCK io;
  long buf[66]; /* NAME_MAX + 1 + sizeof ULONG */
  PFILE_NAME_INFORMATION pfni = (PFILE_NAME_INFORMATION) buf;
  PWCHAR cp;


  /* First check using _isatty.

     Note that this returns the wrong result for NUL, for instance!
     Workaround is not to use _isatty at all, but rather GetFileType
     plus object name checking. */
  if (_isatty(fd))
    return 1;

  /* Now fetch the underlying HANDLE. */
  fh = (HANDLE)_get_osfhandle(fd);
  if (!fh || fh == INVALID_HANDLE_VALUE) {
    errno = EBADF;
    return 0;
  }

  /* Must be a pipe. */
  if (GetFileType (fh) != FILE_TYPE_PIPE)
    goto no_tty;

  /* Calling the native NT function NtQueryInformationFile is required to
     support pre-Vista systems.  If that's of no concern, Vista introduced
     the GetFileInformationByHandleEx call with the FileNameInfo info class,
     which can be used instead. */
  if (!pNtQueryInformationFile) {
    pNtQueryInformationFile = (NTSTATUS (NTAPI *)(HANDLE, PIO_STATUS_BLOCK,
          PVOID, ULONG, FILE_INFORMATION_CLASS))
      GetProcAddress(GetModuleHandle("ntdll.dll"), "NtQueryInformationFile");
    if (!pNtQueryInformationFile)
      goto no_tty;
  }
  if (!NT_SUCCESS (pNtQueryInformationFile (fh, &io, pfni, sizeof buf,
          FileNameInformation)))
    goto no_tty;

  /* The filename is not guaranteed to be NUL-terminated. */
  pfni->FileName[pfni->FileNameLength / sizeof (WCHAR)] = L'\0';

  /* Now check the name pattern.  The filename of a Cygwin pseudo tty pipe
     looks like this:

     \cygwin-%16llx-pty%d-{to,from}-master

     %16llx is the hash of the Cygwin installation, (to support multiple
     parallel installations), %d id the pseudo tty number, "to" or "from"
     differs the pipe direction. "from" is a stdin, "to" a stdout-like
     pipe. */
  cp = pfni->FileName;
  if (!wcsncmp(cp, L"\\cygwin-", 8)
      && !wcsncmp (cp + 24, L"-pty", 4))
  {
    cp = wcschr(cp + 28, '-');
    if (!cp)
      goto no_tty;
    if (!wcscmp (cp, L"-from-master") || !wcscmp (cp, L"-to-master"))
      return 1;
  }
no_tty:
  errno = EINVAL;
  return 0;
}

/* ^^^^^^^^^^ From http://cygwin.com/ml/cygwin/2012-11/txt00003.txt ^^^^^^^^ */

#elif _WIN32
#include <io.h>

static jint
testapp_isatty(jint fd)
{
  return _isatty(fd);
}
#elif defined __linux__ || defined __sun || defined __FreeBSD__
#include <unistd.h>

static jint
testapp_isatty(jint fd)
{
  return isatty(fd);
}
#else
#error Unsupported platform
#endif /* __CYGWIN__ */

JNIEXPORT jboolean JNICALL Java_ttyjni_TestApp_istty
(JNIEnv *env, jobject obj)
{
  return testapp_isatty(fileno(stdin)) &&
    testapp_isatty(fileno(stdout)) ?
    JNI_TRUE : JNI_FALSE;
}

ttyjni_TestApp.h

/* DO NOT EDIT THIS FILE - it is machine generated */
#include <jni.h>
/* Header for class ttyjni_TestApp */

#ifndef _Included_ttyjni_TestApp
#define _Included_ttyjni_TestApp
#ifdef __cplusplus
extern "C" {
#endif
/*
 * Class:     ttyjni_TestApp
 * Method:    istty
 * Signature: ()Z
 */
JNIEXPORT jboolean JNICALL Java_ttyjni_TestApp_istty
  (JNIEnv *, jobject);

#ifdef __cplusplus
}
#endif
#endif

ttyjni/TestApp.java

package ttyjni;

import java.io.Console;
import java.lang.reflect.Method;

class TestApp {
    static {
        System.loadLibrary("testapp");
    }
    private native boolean istty();

    private static final String ISTTY_METHOD = "istty";
    private static final String INTERACTIVE = "interactive";
    private static final String NON_INTERACTIVE = "non-interactive";

    protected static boolean isInteractive() {
        try {
            Method method = Console.class.getDeclaredMethod(ISTTY_METHOD);
            method.setAccessible(true);
            return (Boolean) method.invoke(Console.class);
        } catch (Exception e) {
            System.out.println(e.toString());
        }

        return false;
    }

    public static void main(String[] args) {
        // Testing JNI
        TestApp t = new TestApp();
        boolean b = t.istty();
        System.out.format("%s(jni)\n", b ?
                "interactive" : "non-interactive");

        // Testing pure Java
        System.out.format("%s(console)\n", System.console() != null ?
                INTERACTIVE : NON_INTERACTIVE);
        System.out.format("%s(java)\n", isInteractive() ?
                INTERACTIVE : NON_INTERACTIVE);
    }
}

测试.sh

#!/bin/bash -
java -Djava.library.path="$(dirname "$0")" ttyjni.TestApp

编译

make

在 Linux 上测试

$ ./test.sh
interactive(jni)
interactive(console)
interactive(java)

$ ./test.sh > 1
ruslan@pavilion ~/tmp/java $ cat 1
non-interactive(jni)
non-interactive(console)
non-interactive(java)

在 Cygwin 上测试

$ ./test.sh
interactive(jni)
non-interactive(console)
non-interactive(java)

$ ./test.sh > 1
$ cat 1
non-interactive(jni)
non-interactive(console)
non-interactive(java)