8298416: Console should be declared sealed
Reviewed-by: jpai, alanb
This commit is contained in:
parent
831b35fad3
commit
0ef353925e
src/java.base
@ -33,8 +33,6 @@ import jdk.internal.access.JavaIOAccess;
|
||||
import jdk.internal.access.SharedSecrets;
|
||||
import jdk.internal.io.JdkConsoleProvider;
|
||||
import jdk.internal.util.StaticProperty;
|
||||
import sun.nio.cs.StreamDecoder;
|
||||
import sun.nio.cs.StreamEncoder;
|
||||
import sun.security.action.GetPropertyAction;
|
||||
|
||||
/**
|
||||
@ -82,7 +80,7 @@ import sun.security.action.GetPropertyAction;
|
||||
* manually zero the returned character array after processing to minimize the
|
||||
* lifetime of sensitive data in memory.
|
||||
*
|
||||
* <blockquote><pre>{@code
|
||||
* {@snippet lang=java :
|
||||
* Console cons;
|
||||
* char[] passwd;
|
||||
* if ((cons = System.console()) != null &&
|
||||
@ -90,301 +88,232 @@ import sun.security.action.GetPropertyAction;
|
||||
* ...
|
||||
* java.util.Arrays.fill(passwd, ' ');
|
||||
* }
|
||||
* }</pre></blockquote>
|
||||
* }
|
||||
*
|
||||
* @author Xueming Shen
|
||||
* @since 1.6
|
||||
*/
|
||||
public sealed class Console implements Flushable permits ConsoleImpl, ProxyingConsole {
|
||||
/**
|
||||
* Package private no-arg constructor.
|
||||
*/
|
||||
Console() {}
|
||||
|
||||
public class Console implements Flushable
|
||||
{
|
||||
/**
|
||||
* Retrieves the unique {@link java.io.PrintWriter PrintWriter} object
|
||||
* associated with this console.
|
||||
*
|
||||
* @return The printwriter associated with this console
|
||||
*/
|
||||
/**
|
||||
* Retrieves the unique {@link java.io.PrintWriter PrintWriter} object
|
||||
* associated with this console.
|
||||
*
|
||||
* @return The printwriter associated with this console
|
||||
*/
|
||||
public PrintWriter writer() {
|
||||
return pw;
|
||||
throw newUnsupportedOperationException();
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the unique {@link java.io.Reader Reader} object associated
|
||||
* with this console.
|
||||
* <p>
|
||||
* This method is intended to be used by sophisticated applications, for
|
||||
* example, a {@link java.util.Scanner} object which utilizes the rich
|
||||
* parsing/scanning functionality provided by the {@code Scanner}:
|
||||
* <blockquote><pre>
|
||||
* Console con = System.console();
|
||||
* if (con != null) {
|
||||
* Scanner sc = new Scanner(con.reader());
|
||||
* ...
|
||||
* }
|
||||
* </pre></blockquote>
|
||||
* <p>
|
||||
* For simple applications requiring only line-oriented reading, use
|
||||
* {@link #readLine}.
|
||||
* <p>
|
||||
* The bulk read operations {@link java.io.Reader#read(char[]) read(char[]) },
|
||||
* {@link java.io.Reader#read(char[], int, int) read(char[], int, int) } and
|
||||
* {@link java.io.Reader#read(java.nio.CharBuffer) read(java.nio.CharBuffer)}
|
||||
* on the returned object will not read in characters beyond the line
|
||||
* bound for each invocation, even if the destination buffer has space for
|
||||
* more characters. The {@code Reader}'s {@code read} methods may block if a
|
||||
* line bound has not been entered or reached on the console's input device.
|
||||
* A line bound is considered to be any one of a line feed ({@code '\n'}),
|
||||
* a carriage return ({@code '\r'}), a carriage return followed immediately
|
||||
* by a linefeed, or an end of stream.
|
||||
*
|
||||
* @return The reader associated with this console
|
||||
*/
|
||||
/**
|
||||
* Retrieves the unique {@link java.io.Reader Reader} object associated
|
||||
* with this console.
|
||||
* <p>
|
||||
* This method is intended to be used by sophisticated applications, for
|
||||
* example, a {@link java.util.Scanner} object which utilizes the rich
|
||||
* parsing/scanning functionality provided by the {@code Scanner}:
|
||||
* <blockquote><pre>
|
||||
* Console con = System.console();
|
||||
* if (con != null) {
|
||||
* Scanner sc = new Scanner(con.reader());
|
||||
* ...
|
||||
* }
|
||||
* </pre></blockquote>
|
||||
* <p>
|
||||
* For simple applications requiring only line-oriented reading, use
|
||||
* {@link #readLine}.
|
||||
* <p>
|
||||
* The bulk read operations {@link java.io.Reader#read(char[]) read(char[]) },
|
||||
* {@link java.io.Reader#read(char[], int, int) read(char[], int, int) } and
|
||||
* {@link java.io.Reader#read(java.nio.CharBuffer) read(java.nio.CharBuffer)}
|
||||
* on the returned object will not read in characters beyond the line
|
||||
* bound for each invocation, even if the destination buffer has space for
|
||||
* more characters. The {@code Reader}'s {@code read} methods may block if a
|
||||
* line bound has not been entered or reached on the console's input device.
|
||||
* A line bound is considered to be any one of a line feed ({@code '\n'}),
|
||||
* a carriage return ({@code '\r'}), a carriage return followed immediately
|
||||
* by a linefeed, or an end of stream.
|
||||
*
|
||||
* @return The reader associated with this console
|
||||
*/
|
||||
public Reader reader() {
|
||||
return reader;
|
||||
throw newUnsupportedOperationException();
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes a formatted string to this console's output stream using
|
||||
* the specified format string and arguments.
|
||||
*
|
||||
* @param fmt
|
||||
* A format string as described in <a
|
||||
* href="../util/Formatter.html#syntax">Format string syntax</a>
|
||||
*
|
||||
* @param args
|
||||
* Arguments referenced by the format specifiers in the format
|
||||
* string. If there are more arguments than format specifiers, the
|
||||
* extra arguments are ignored. The number of arguments is
|
||||
* variable and may be zero. The maximum number of arguments is
|
||||
* limited by the maximum dimension of a Java array as defined by
|
||||
* <cite>The Java Virtual Machine Specification</cite>.
|
||||
* The behaviour on a
|
||||
* {@code null} argument depends on the <a
|
||||
* href="../util/Formatter.html#syntax">conversion</a>.
|
||||
*
|
||||
* @throws IllegalFormatException
|
||||
* If a format string contains an illegal syntax, a format
|
||||
* specifier that is incompatible with the given arguments,
|
||||
* insufficient arguments given the format string, or other
|
||||
* illegal conditions. For specification of all possible
|
||||
* formatting errors, see the <a
|
||||
* href="../util/Formatter.html#detail">Details</a> section
|
||||
* of the formatter class specification.
|
||||
*
|
||||
* @return This console
|
||||
*/
|
||||
/**
|
||||
* Writes a formatted string to this console's output stream using
|
||||
* the specified format string and arguments.
|
||||
*
|
||||
* @param fmt
|
||||
* A format string as described in <a
|
||||
* href="../util/Formatter.html#syntax">Format string syntax</a>
|
||||
*
|
||||
* @param args
|
||||
* Arguments referenced by the format specifiers in the format
|
||||
* string. If there are more arguments than format specifiers, the
|
||||
* extra arguments are ignored. The number of arguments is
|
||||
* variable and may be zero. The maximum number of arguments is
|
||||
* limited by the maximum dimension of a Java array as defined by
|
||||
* <cite>The Java Virtual Machine Specification</cite>.
|
||||
* The behaviour on a
|
||||
* {@code null} argument depends on the <a
|
||||
* href="../util/Formatter.html#syntax">conversion</a>.
|
||||
*
|
||||
* @throws IllegalFormatException
|
||||
* If a format string contains an illegal syntax, a format
|
||||
* specifier that is incompatible with the given arguments,
|
||||
* insufficient arguments given the format string, or other
|
||||
* illegal conditions. For specification of all possible
|
||||
* formatting errors, see the <a
|
||||
* href="../util/Formatter.html#detail">Details</a> section
|
||||
* of the formatter class specification.
|
||||
*
|
||||
* @return This console
|
||||
*/
|
||||
public Console format(String fmt, Object ...args) {
|
||||
formatter.format(fmt, args).flush();
|
||||
return this;
|
||||
throw newUnsupportedOperationException();
|
||||
}
|
||||
|
||||
/**
|
||||
* A convenience method to write a formatted string to this console's
|
||||
* output stream using the specified format string and arguments.
|
||||
*
|
||||
* <p> An invocation of this method of the form
|
||||
* {@code con.printf(format, args)} behaves in exactly the same way
|
||||
* as the invocation of
|
||||
* <pre>con.format(format, args)</pre>.
|
||||
*
|
||||
* @param format
|
||||
* A format string as described in <a
|
||||
* href="../util/Formatter.html#syntax">Format string syntax</a>.
|
||||
*
|
||||
* @param args
|
||||
* Arguments referenced by the format specifiers in the format
|
||||
* string. If there are more arguments than format specifiers, the
|
||||
* extra arguments are ignored. The number of arguments is
|
||||
* variable and may be zero. The maximum number of arguments is
|
||||
* limited by the maximum dimension of a Java array as defined by
|
||||
* <cite>The Java Virtual Machine Specification</cite>.
|
||||
* The behaviour on a
|
||||
* {@code null} argument depends on the <a
|
||||
* href="../util/Formatter.html#syntax">conversion</a>.
|
||||
*
|
||||
* @throws IllegalFormatException
|
||||
* If a format string contains an illegal syntax, a format
|
||||
* specifier that is incompatible with the given arguments,
|
||||
* insufficient arguments given the format string, or other
|
||||
* illegal conditions. For specification of all possible
|
||||
* formatting errors, see the <a
|
||||
* href="../util/Formatter.html#detail">Details</a> section of the
|
||||
* formatter class specification.
|
||||
*
|
||||
* @return This console
|
||||
*/
|
||||
/**
|
||||
* A convenience method to write a formatted string to this console's
|
||||
* output stream using the specified format string and arguments.
|
||||
*
|
||||
* <p> An invocation of this method of the form
|
||||
* {@code con.printf(format, args)} behaves in exactly the same way
|
||||
* as the invocation of
|
||||
* <pre>con.format(format, args)</pre>.
|
||||
*
|
||||
* @param format
|
||||
* A format string as described in <a
|
||||
* href="../util/Formatter.html#syntax">Format string syntax</a>.
|
||||
*
|
||||
* @param args
|
||||
* Arguments referenced by the format specifiers in the format
|
||||
* string. If there are more arguments than format specifiers, the
|
||||
* extra arguments are ignored. The number of arguments is
|
||||
* variable and may be zero. The maximum number of arguments is
|
||||
* limited by the maximum dimension of a Java array as defined by
|
||||
* <cite>The Java Virtual Machine Specification</cite>.
|
||||
* The behaviour on a
|
||||
* {@code null} argument depends on the <a
|
||||
* href="../util/Formatter.html#syntax">conversion</a>.
|
||||
*
|
||||
* @throws IllegalFormatException
|
||||
* If a format string contains an illegal syntax, a format
|
||||
* specifier that is incompatible with the given arguments,
|
||||
* insufficient arguments given the format string, or other
|
||||
* illegal conditions. For specification of all possible
|
||||
* formatting errors, see the <a
|
||||
* href="../util/Formatter.html#detail">Details</a> section of the
|
||||
* formatter class specification.
|
||||
*
|
||||
* @return This console
|
||||
*/
|
||||
public Console printf(String format, Object ... args) {
|
||||
return format(format, args);
|
||||
throw newUnsupportedOperationException();
|
||||
}
|
||||
|
||||
/**
|
||||
* Provides a formatted prompt, then reads a single line of text from the
|
||||
* console.
|
||||
*
|
||||
* @param fmt
|
||||
* A format string as described in <a
|
||||
* href="../util/Formatter.html#syntax">Format string syntax</a>.
|
||||
*
|
||||
* @param args
|
||||
* Arguments referenced by the format specifiers in the format
|
||||
* string. If there are more arguments than format specifiers, the
|
||||
* extra arguments are ignored. The maximum number of arguments is
|
||||
* limited by the maximum dimension of a Java array as defined by
|
||||
* <cite>The Java Virtual Machine Specification</cite>.
|
||||
*
|
||||
* @throws IllegalFormatException
|
||||
* If a format string contains an illegal syntax, a format
|
||||
* specifier that is incompatible with the given arguments,
|
||||
* insufficient arguments given the format string, or other
|
||||
* illegal conditions. For specification of all possible
|
||||
* formatting errors, see the <a
|
||||
* href="../util/Formatter.html#detail">Details</a> section
|
||||
* of the formatter class specification.
|
||||
*
|
||||
* @throws IOError
|
||||
* If an I/O error occurs.
|
||||
*
|
||||
* @return A string containing the line read from the console, not
|
||||
* including any line-termination characters, or {@code null}
|
||||
* if an end of stream has been reached.
|
||||
*/
|
||||
/**
|
||||
* Provides a formatted prompt, then reads a single line of text from the
|
||||
* console.
|
||||
*
|
||||
* @param fmt
|
||||
* A format string as described in <a
|
||||
* href="../util/Formatter.html#syntax">Format string syntax</a>.
|
||||
*
|
||||
* @param args
|
||||
* Arguments referenced by the format specifiers in the format
|
||||
* string. If there are more arguments than format specifiers, the
|
||||
* extra arguments are ignored. The maximum number of arguments is
|
||||
* limited by the maximum dimension of a Java array as defined by
|
||||
* <cite>The Java Virtual Machine Specification</cite>.
|
||||
*
|
||||
* @throws IllegalFormatException
|
||||
* If a format string contains an illegal syntax, a format
|
||||
* specifier that is incompatible with the given arguments,
|
||||
* insufficient arguments given the format string, or other
|
||||
* illegal conditions. For specification of all possible
|
||||
* formatting errors, see the <a
|
||||
* href="../util/Formatter.html#detail">Details</a> section
|
||||
* of the formatter class specification.
|
||||
*
|
||||
* @throws IOError
|
||||
* If an I/O error occurs.
|
||||
*
|
||||
* @return A string containing the line read from the console, not
|
||||
* including any line-termination characters, or {@code null}
|
||||
* if an end of stream has been reached.
|
||||
*/
|
||||
public String readLine(String fmt, Object ... args) {
|
||||
String line = null;
|
||||
synchronized (writeLock) {
|
||||
synchronized(readLock) {
|
||||
if (!fmt.isEmpty())
|
||||
pw.format(fmt, args);
|
||||
try {
|
||||
char[] ca = readline(false);
|
||||
if (ca != null)
|
||||
line = new String(ca);
|
||||
} catch (IOException x) {
|
||||
throw new IOError(x);
|
||||
}
|
||||
}
|
||||
}
|
||||
return line;
|
||||
throw newUnsupportedOperationException();
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads a single line of text from the console.
|
||||
*
|
||||
* @throws IOError
|
||||
* If an I/O error occurs.
|
||||
*
|
||||
* @return A string containing the line read from the console, not
|
||||
* including any line-termination characters, or {@code null}
|
||||
* if an end of stream has been reached.
|
||||
*/
|
||||
/**
|
||||
* Reads a single line of text from the console.
|
||||
*
|
||||
* @throws IOError
|
||||
* If an I/O error occurs.
|
||||
*
|
||||
* @return A string containing the line read from the console, not
|
||||
* including any line-termination characters, or {@code null}
|
||||
* if an end of stream has been reached.
|
||||
*/
|
||||
public String readLine() {
|
||||
return readLine("");
|
||||
throw newUnsupportedOperationException();
|
||||
}
|
||||
|
||||
/**
|
||||
* Provides a formatted prompt, then reads a password or passphrase from
|
||||
* the console with echoing disabled.
|
||||
*
|
||||
* @param fmt
|
||||
* A format string as described in <a
|
||||
* href="../util/Formatter.html#syntax">Format string syntax</a>
|
||||
* for the prompt text.
|
||||
*
|
||||
* @param args
|
||||
* Arguments referenced by the format specifiers in the format
|
||||
* string. If there are more arguments than format specifiers, the
|
||||
* extra arguments are ignored. The maximum number of arguments is
|
||||
* limited by the maximum dimension of a Java array as defined by
|
||||
* <cite>The Java Virtual Machine Specification</cite>.
|
||||
*
|
||||
* @throws IllegalFormatException
|
||||
* If a format string contains an illegal syntax, a format
|
||||
* specifier that is incompatible with the given arguments,
|
||||
* insufficient arguments given the format string, or other
|
||||
* illegal conditions. For specification of all possible
|
||||
* formatting errors, see the <a
|
||||
* href="../util/Formatter.html#detail">Details</a>
|
||||
* section of the formatter class specification.
|
||||
*
|
||||
* @throws IOError
|
||||
* If an I/O error occurs.
|
||||
*
|
||||
* @return A character array containing the password or passphrase read
|
||||
* from the console, not including any line-termination characters,
|
||||
* or {@code null} if an end of stream has been reached.
|
||||
*/
|
||||
/**
|
||||
* Provides a formatted prompt, then reads a password or passphrase from
|
||||
* the console with echoing disabled.
|
||||
*
|
||||
* @param fmt
|
||||
* A format string as described in <a
|
||||
* href="../util/Formatter.html#syntax">Format string syntax</a>
|
||||
* for the prompt text.
|
||||
*
|
||||
* @param args
|
||||
* Arguments referenced by the format specifiers in the format
|
||||
* string. If there are more arguments than format specifiers, the
|
||||
* extra arguments are ignored. The maximum number of arguments is
|
||||
* limited by the maximum dimension of a Java array as defined by
|
||||
* <cite>The Java Virtual Machine Specification</cite>.
|
||||
*
|
||||
* @throws IllegalFormatException
|
||||
* If a format string contains an illegal syntax, a format
|
||||
* specifier that is incompatible with the given arguments,
|
||||
* insufficient arguments given the format string, or other
|
||||
* illegal conditions. For specification of all possible
|
||||
* formatting errors, see the <a
|
||||
* href="../util/Formatter.html#detail">Details</a>
|
||||
* section of the formatter class specification.
|
||||
*
|
||||
* @throws IOError
|
||||
* If an I/O error occurs.
|
||||
*
|
||||
* @return A character array containing the password or passphrase read
|
||||
* from the console, not including any line-termination characters,
|
||||
* or {@code null} if an end of stream has been reached.
|
||||
*/
|
||||
public char[] readPassword(String fmt, Object ... args) {
|
||||
char[] passwd = null;
|
||||
synchronized (writeLock) {
|
||||
synchronized(readLock) {
|
||||
installShutdownHook();
|
||||
try {
|
||||
restoreEcho = echo(false);
|
||||
} catch (IOException x) {
|
||||
throw new IOError(x);
|
||||
}
|
||||
IOError ioe = null;
|
||||
try {
|
||||
if (!fmt.isEmpty())
|
||||
pw.format(fmt, args);
|
||||
passwd = readline(true);
|
||||
} catch (IOException x) {
|
||||
ioe = new IOError(x);
|
||||
} finally {
|
||||
try {
|
||||
if (restoreEcho)
|
||||
restoreEcho = echo(true);
|
||||
} catch (IOException x) {
|
||||
if (ioe == null)
|
||||
ioe = new IOError(x);
|
||||
else
|
||||
ioe.addSuppressed(x);
|
||||
}
|
||||
if (ioe != null)
|
||||
throw ioe;
|
||||
}
|
||||
pw.println();
|
||||
}
|
||||
}
|
||||
return passwd;
|
||||
throw newUnsupportedOperationException();
|
||||
}
|
||||
|
||||
private void installShutdownHook() {
|
||||
if (shutdownHookInstalled)
|
||||
return;
|
||||
try {
|
||||
// Add a shutdown hook to restore console's echo state should
|
||||
// it be necessary.
|
||||
SharedSecrets.getJavaLangAccess()
|
||||
.registerShutdownHook(0 /* shutdown hook invocation order */,
|
||||
false /* only register if shutdown is not in progress */,
|
||||
new Runnable() {
|
||||
public void run() {
|
||||
try {
|
||||
if (restoreEcho) {
|
||||
echo(true);
|
||||
}
|
||||
} catch (IOException x) { }
|
||||
}
|
||||
});
|
||||
} catch (IllegalStateException e) {
|
||||
// shutdown is already in progress and readPassword is first used
|
||||
// by a shutdown hook
|
||||
}
|
||||
shutdownHookInstalled = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads a password or passphrase from the console with echoing disabled
|
||||
*
|
||||
* @throws IOError
|
||||
* If an I/O error occurs.
|
||||
*
|
||||
* @return A character array containing the password or passphrase read
|
||||
* from the console, not including any line-termination characters,
|
||||
* or {@code null} if an end of stream has been reached.
|
||||
*/
|
||||
/**
|
||||
* Reads a password or passphrase from the console with echoing disabled
|
||||
*
|
||||
* @throws IOError
|
||||
* If an I/O error occurs.
|
||||
*
|
||||
* @return A character array containing the password or passphrase read
|
||||
* from the console, not including any line-termination characters,
|
||||
* or {@code null} if an end of stream has been reached.
|
||||
*/
|
||||
public char[] readPassword() {
|
||||
return readPassword("");
|
||||
throw newUnsupportedOperationException();
|
||||
}
|
||||
|
||||
/**
|
||||
@ -392,10 +321,9 @@ public class Console implements Flushable
|
||||
* immediately .
|
||||
*/
|
||||
public void flush() {
|
||||
pw.flush();
|
||||
throw newUnsupportedOperationException();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Returns the {@link java.nio.charset.Charset Charset} object used for
|
||||
* the {@code Console}.
|
||||
@ -410,171 +338,16 @@ public class Console implements Flushable
|
||||
* @since 17
|
||||
*/
|
||||
public Charset charset() {
|
||||
assert CHARSET != null : "charset() should not return null";
|
||||
return CHARSET;
|
||||
throw newUnsupportedOperationException();
|
||||
}
|
||||
|
||||
private static UnsupportedOperationException newUnsupportedOperationException() {
|
||||
return new UnsupportedOperationException(
|
||||
"Console class itself does not provide implementation");
|
||||
}
|
||||
|
||||
private Object readLock;
|
||||
private Object writeLock;
|
||||
private Reader reader;
|
||||
private Writer out;
|
||||
private PrintWriter pw;
|
||||
private Formatter formatter;
|
||||
private char[] rcb;
|
||||
private boolean restoreEcho;
|
||||
private boolean shutdownHookInstalled;
|
||||
private static native String encoding();
|
||||
/*
|
||||
* Sets the console echo status to {@code on} and returns the previous
|
||||
* console on/off status.
|
||||
* @param on the echo status to set to. {@code true} for echo on and
|
||||
* {@code false} for echo off
|
||||
* @return true if the previous console echo status is on
|
||||
*/
|
||||
private static native boolean echo(boolean on) throws IOException;
|
||||
|
||||
private char[] readline(boolean zeroOut) throws IOException {
|
||||
int len = reader.read(rcb, 0, rcb.length);
|
||||
if (len < 0)
|
||||
return null; //EOL
|
||||
if (rcb[len-1] == '\r')
|
||||
len--; //remove CR at end;
|
||||
else if (rcb[len-1] == '\n') {
|
||||
len--; //remove LF at end;
|
||||
if (len > 0 && rcb[len-1] == '\r')
|
||||
len--; //remove the CR, if there is one
|
||||
}
|
||||
char[] b = new char[len];
|
||||
if (len > 0) {
|
||||
System.arraycopy(rcb, 0, b, 0, len);
|
||||
if (zeroOut) {
|
||||
Arrays.fill(rcb, 0, len, ' ');
|
||||
}
|
||||
}
|
||||
return b;
|
||||
}
|
||||
|
||||
private char[] grow() {
|
||||
assert Thread.holdsLock(readLock);
|
||||
char[] t = new char[rcb.length * 2];
|
||||
System.arraycopy(rcb, 0, t, 0, rcb.length);
|
||||
rcb = t;
|
||||
return rcb;
|
||||
}
|
||||
|
||||
class LineReader extends Reader {
|
||||
private Reader in;
|
||||
private char[] cb;
|
||||
private int nChars, nextChar;
|
||||
boolean leftoverLF;
|
||||
LineReader(Reader in) {
|
||||
this.in = in;
|
||||
cb = new char[1024];
|
||||
nextChar = nChars = 0;
|
||||
leftoverLF = false;
|
||||
}
|
||||
public void close () {}
|
||||
public boolean ready() throws IOException {
|
||||
//in.ready synchronizes on readLock already
|
||||
return in.ready();
|
||||
}
|
||||
|
||||
public int read(char[] cbuf, int offset, int length)
|
||||
throws IOException
|
||||
{
|
||||
int off = offset;
|
||||
int end = offset + length;
|
||||
if (offset < 0 || offset > cbuf.length || length < 0 ||
|
||||
end < 0 || end > cbuf.length) {
|
||||
throw new IndexOutOfBoundsException();
|
||||
}
|
||||
synchronized(readLock) {
|
||||
boolean eof = false;
|
||||
char c = 0;
|
||||
for (;;) {
|
||||
if (nextChar >= nChars) { //fill
|
||||
int n = 0;
|
||||
do {
|
||||
n = in.read(cb, 0, cb.length);
|
||||
} while (n == 0);
|
||||
if (n > 0) {
|
||||
nChars = n;
|
||||
nextChar = 0;
|
||||
if (n < cb.length &&
|
||||
cb[n-1] != '\n' && cb[n-1] != '\r') {
|
||||
/*
|
||||
* we're in canonical mode so each "fill" should
|
||||
* come back with an eol. if there no lf or nl at
|
||||
* the end of returned bytes we reached an eof.
|
||||
*/
|
||||
eof = true;
|
||||
}
|
||||
} else { /*EOF*/
|
||||
if (off - offset == 0)
|
||||
return -1;
|
||||
return off - offset;
|
||||
}
|
||||
}
|
||||
if (leftoverLF && cbuf == rcb && cb[nextChar] == '\n') {
|
||||
/*
|
||||
* if invoked by our readline, skip the leftover, otherwise
|
||||
* return the LF.
|
||||
*/
|
||||
nextChar++;
|
||||
}
|
||||
leftoverLF = false;
|
||||
while (nextChar < nChars) {
|
||||
c = cbuf[off++] = cb[nextChar];
|
||||
cb[nextChar++] = 0;
|
||||
if (c == '\n') {
|
||||
return off - offset;
|
||||
} else if (c == '\r') {
|
||||
if (off == end) {
|
||||
/* no space left even the next is LF, so return
|
||||
* whatever we have if the invoker is not our
|
||||
* readLine()
|
||||
*/
|
||||
if (cbuf == rcb) {
|
||||
cbuf = grow();
|
||||
end = cbuf.length;
|
||||
} else {
|
||||
leftoverLF = true;
|
||||
return off - offset;
|
||||
}
|
||||
}
|
||||
if (nextChar == nChars && in.ready()) {
|
||||
/*
|
||||
* we have a CR and we reached the end of
|
||||
* the read in buffer, fill to make sure we
|
||||
* don't miss a LF, if there is one, it's possible
|
||||
* that it got cut off during last round reading
|
||||
* simply because the read in buffer was full.
|
||||
*/
|
||||
nChars = in.read(cb, 0, cb.length);
|
||||
nextChar = 0;
|
||||
}
|
||||
if (nextChar < nChars && cb[nextChar] == '\n') {
|
||||
cbuf[off++] = '\n';
|
||||
nextChar++;
|
||||
}
|
||||
return off - offset;
|
||||
} else if (off == end) {
|
||||
if (cbuf == rcb) {
|
||||
cbuf = grow();
|
||||
end = cbuf.length;
|
||||
} else {
|
||||
return off - offset;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (eof)
|
||||
return off - offset;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private static final Charset CHARSET;
|
||||
static final Charset CHARSET;
|
||||
static {
|
||||
Charset cs = null;
|
||||
boolean istty = istty();
|
||||
@ -619,31 +392,15 @@ public class Console implements Flushable
|
||||
.filter(Objects::nonNull)
|
||||
.findAny()
|
||||
.map(jc -> (Console) new ProxyingConsole(jc))
|
||||
.orElse(istty ? new Console() : null);
|
||||
.orElse(istty ? new ConsoleImpl() : null);
|
||||
};
|
||||
return AccessController.doPrivileged(pa);
|
||||
} catch (ServiceConfigurationError ignore) {
|
||||
// default to built-in Console
|
||||
return istty ? new Console() : null;
|
||||
return istty ? new ConsoleImpl() : null;
|
||||
}
|
||||
}
|
||||
|
||||
private static final Console cons;
|
||||
private static native boolean istty();
|
||||
|
||||
Console() {
|
||||
readLock = new Object();
|
||||
writeLock = new Object();
|
||||
out = StreamEncoder.forOutputStreamWriter(
|
||||
new FileOutputStream(FileDescriptor.out),
|
||||
writeLock,
|
||||
CHARSET);
|
||||
pw = new PrintWriter(out, true) { public void close() {} };
|
||||
formatter = new Formatter(out);
|
||||
reader = new LineReader(StreamDecoder.forInputStreamReader(
|
||||
new FileInputStream(FileDescriptor.in),
|
||||
readLock,
|
||||
CHARSET));
|
||||
rcb = new char[1024];
|
||||
}
|
||||
}
|
||||
|
366
src/java.base/share/classes/java/io/ConsoleImpl.java
Normal file
366
src/java.base/share/classes/java/io/ConsoleImpl.java
Normal file
@ -0,0 +1,366 @@
|
||||
/*
|
||||
* Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved.
|
||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
||||
*
|
||||
* This code is free software; you can redistribute it and/or modify it
|
||||
* under the terms of the GNU General Public License version 2 only, as
|
||||
* published by the Free Software Foundation. Oracle designates this
|
||||
* particular file as subject to the "Classpath" exception as provided
|
||||
* by Oracle in the LICENSE file that accompanied this code.
|
||||
*
|
||||
* This code is distributed in the hope that it will be useful, but WITHOUT
|
||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
||||
* version 2 for more details (a copy is included in the LICENSE file that
|
||||
* accompanied this code).
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License version
|
||||
* 2 along with this work; if not, write to the Free Software Foundation,
|
||||
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
*
|
||||
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
||||
* or visit www.oracle.com if you need additional information or have any
|
||||
* questions.
|
||||
*/
|
||||
|
||||
package java.io;
|
||||
|
||||
import java.util.*;
|
||||
import java.nio.charset.Charset;
|
||||
import jdk.internal.access.SharedSecrets;
|
||||
import sun.nio.cs.StreamDecoder;
|
||||
import sun.nio.cs.StreamEncoder;
|
||||
|
||||
/**
|
||||
* Console implementation based on the platform's TTY.
|
||||
*/
|
||||
|
||||
final class ConsoleImpl extends Console {
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
@Override
|
||||
public PrintWriter writer() {
|
||||
return pw;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
@Override
|
||||
public Reader reader() {
|
||||
return reader;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
@Override
|
||||
public Console format(String fmt, Object ...args) {
|
||||
formatter.format(fmt, args).flush();
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
@Override
|
||||
public Console printf(String format, Object ... args) {
|
||||
return format(format, args);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
@Override
|
||||
public String readLine(String fmt, Object ... args) {
|
||||
String line = null;
|
||||
synchronized (writeLock) {
|
||||
synchronized(readLock) {
|
||||
if (!fmt.isEmpty())
|
||||
pw.format(fmt, args);
|
||||
try {
|
||||
char[] ca = readline(false);
|
||||
if (ca != null)
|
||||
line = new String(ca);
|
||||
} catch (IOException x) {
|
||||
throw new IOError(x);
|
||||
}
|
||||
}
|
||||
}
|
||||
return line;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
@Override
|
||||
public String readLine() {
|
||||
return readLine("");
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
@Override
|
||||
public char[] readPassword(String fmt, Object ... args) {
|
||||
char[] passwd = null;
|
||||
synchronized (writeLock) {
|
||||
synchronized(readLock) {
|
||||
installShutdownHook();
|
||||
try {
|
||||
restoreEcho = echo(false);
|
||||
} catch (IOException x) {
|
||||
throw new IOError(x);
|
||||
}
|
||||
IOError ioe = null;
|
||||
try {
|
||||
if (!fmt.isEmpty())
|
||||
pw.format(fmt, args);
|
||||
passwd = readline(true);
|
||||
} catch (IOException x) {
|
||||
ioe = new IOError(x);
|
||||
} finally {
|
||||
try {
|
||||
if (restoreEcho)
|
||||
restoreEcho = echo(true);
|
||||
} catch (IOException x) {
|
||||
if (ioe == null)
|
||||
ioe = new IOError(x);
|
||||
else
|
||||
ioe.addSuppressed(x);
|
||||
}
|
||||
if (ioe != null)
|
||||
throw ioe;
|
||||
}
|
||||
pw.println();
|
||||
}
|
||||
}
|
||||
return passwd;
|
||||
}
|
||||
|
||||
private void installShutdownHook() {
|
||||
if (shutdownHookInstalled)
|
||||
return;
|
||||
try {
|
||||
// Add a shutdown hook to restore console's echo state should
|
||||
// it be necessary.
|
||||
SharedSecrets.getJavaLangAccess()
|
||||
.registerShutdownHook(0 /* shutdown hook invocation order */,
|
||||
false /* only register if shutdown is not in progress */,
|
||||
new Runnable() {
|
||||
public void run() {
|
||||
try {
|
||||
if (restoreEcho) {
|
||||
echo(true);
|
||||
}
|
||||
} catch (IOException x) { }
|
||||
}
|
||||
});
|
||||
} catch (IllegalStateException e) {
|
||||
// shutdown is already in progress and readPassword is first used
|
||||
// by a shutdown hook
|
||||
}
|
||||
shutdownHookInstalled = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
@Override
|
||||
public char[] readPassword() {
|
||||
return readPassword("");
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
@Override
|
||||
public void flush() {
|
||||
pw.flush();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
@Override
|
||||
public Charset charset() {
|
||||
assert CHARSET != null : "charset() should not return null";
|
||||
return CHARSET;
|
||||
}
|
||||
|
||||
private final Object readLock;
|
||||
private final Object writeLock;
|
||||
private final Reader reader;
|
||||
private final Writer out;
|
||||
private final PrintWriter pw;
|
||||
private final Formatter formatter;
|
||||
private char[] rcb;
|
||||
private boolean restoreEcho;
|
||||
private boolean shutdownHookInstalled;
|
||||
|
||||
private char[] readline(boolean zeroOut) throws IOException {
|
||||
int len = reader.read(rcb, 0, rcb.length);
|
||||
if (len < 0)
|
||||
return null; //EOL
|
||||
if (rcb[len-1] == '\r')
|
||||
len--; //remove CR at end;
|
||||
else if (rcb[len-1] == '\n') {
|
||||
len--; //remove LF at end;
|
||||
if (len > 0 && rcb[len-1] == '\r')
|
||||
len--; //remove the CR, if there is one
|
||||
}
|
||||
char[] b = new char[len];
|
||||
if (len > 0) {
|
||||
System.arraycopy(rcb, 0, b, 0, len);
|
||||
if (zeroOut) {
|
||||
Arrays.fill(rcb, 0, len, ' ');
|
||||
}
|
||||
}
|
||||
return b;
|
||||
}
|
||||
|
||||
private char[] grow() {
|
||||
assert Thread.holdsLock(readLock);
|
||||
char[] t = new char[rcb.length * 2];
|
||||
System.arraycopy(rcb, 0, t, 0, rcb.length);
|
||||
rcb = t;
|
||||
return rcb;
|
||||
}
|
||||
|
||||
/*
|
||||
* Sets the console echo status to {@code on} and returns the previous
|
||||
* console on/off status.
|
||||
* @param on the echo status to set to. {@code true} for echo on and
|
||||
* {@code false} for echo off
|
||||
* @return true if the previous console echo status is on
|
||||
*/
|
||||
private static native boolean echo(boolean on) throws IOException;
|
||||
|
||||
class LineReader extends Reader {
|
||||
private final Reader in;
|
||||
private final char[] cb;
|
||||
private int nChars, nextChar;
|
||||
boolean leftoverLF;
|
||||
LineReader(Reader in) {
|
||||
this.in = in;
|
||||
cb = new char[1024];
|
||||
nextChar = nChars = 0;
|
||||
leftoverLF = false;
|
||||
}
|
||||
public void close () {}
|
||||
public boolean ready() throws IOException {
|
||||
//in.ready synchronizes on readLock already
|
||||
return in.ready();
|
||||
}
|
||||
|
||||
public int read(char[] cbuf, int offset, int length)
|
||||
throws IOException
|
||||
{
|
||||
int off = offset;
|
||||
int end = offset + length;
|
||||
if (offset < 0 || offset > cbuf.length || length < 0 ||
|
||||
end < 0 || end > cbuf.length) {
|
||||
throw new IndexOutOfBoundsException();
|
||||
}
|
||||
synchronized(readLock) {
|
||||
boolean eof = false;
|
||||
char c;
|
||||
for (;;) {
|
||||
if (nextChar >= nChars) { //fill
|
||||
int n;
|
||||
do {
|
||||
n = in.read(cb, 0, cb.length);
|
||||
} while (n == 0);
|
||||
if (n > 0) {
|
||||
nChars = n;
|
||||
nextChar = 0;
|
||||
if (n < cb.length &&
|
||||
cb[n-1] != '\n' && cb[n-1] != '\r') {
|
||||
/*
|
||||
* we're in canonical mode so each "fill" should
|
||||
* come back with an eol. if there is no lf or nl at
|
||||
* the end of returned bytes we reached an eof.
|
||||
*/
|
||||
eof = true;
|
||||
}
|
||||
} else { /*EOF*/
|
||||
if (off - offset == 0)
|
||||
return -1;
|
||||
return off - offset;
|
||||
}
|
||||
}
|
||||
if (leftoverLF && cbuf == rcb && cb[nextChar] == '\n') {
|
||||
/*
|
||||
* if invoked by our readline, skip the leftover, otherwise
|
||||
* return the LF.
|
||||
*/
|
||||
nextChar++;
|
||||
}
|
||||
leftoverLF = false;
|
||||
while (nextChar < nChars) {
|
||||
c = cbuf[off++] = cb[nextChar];
|
||||
cb[nextChar++] = 0;
|
||||
if (c == '\n') {
|
||||
return off - offset;
|
||||
} else if (c == '\r') {
|
||||
if (off == end) {
|
||||
/* no space left even the next is LF, so return
|
||||
* whatever we have if the invoker is not our
|
||||
* readLine()
|
||||
*/
|
||||
if (cbuf == rcb) {
|
||||
cbuf = grow();
|
||||
} else {
|
||||
leftoverLF = true;
|
||||
return off - offset;
|
||||
}
|
||||
}
|
||||
if (nextChar == nChars && in.ready()) {
|
||||
/*
|
||||
* we have a CR and we reached the end of
|
||||
* the read in buffer, fill to make sure we
|
||||
* don't miss a LF, if there is one, it's possible
|
||||
* that it got cut off during last round reading
|
||||
* simply because the read in buffer was full.
|
||||
*/
|
||||
nChars = in.read(cb, 0, cb.length);
|
||||
nextChar = 0;
|
||||
}
|
||||
if (nextChar < nChars && cb[nextChar] == '\n') {
|
||||
cbuf[off++] = '\n';
|
||||
nextChar++;
|
||||
}
|
||||
return off - offset;
|
||||
} else if (off == end) {
|
||||
if (cbuf == rcb) {
|
||||
cbuf = grow();
|
||||
end = cbuf.length;
|
||||
} else {
|
||||
return off - offset;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (eof)
|
||||
return off - offset;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
ConsoleImpl() {
|
||||
readLock = new Object();
|
||||
writeLock = new Object();
|
||||
out = StreamEncoder.forOutputStreamWriter(
|
||||
new FileOutputStream(FileDescriptor.out),
|
||||
writeLock,
|
||||
CHARSET);
|
||||
pw = new PrintWriter(out, true) { public void close() {} };
|
||||
formatter = new Formatter(out);
|
||||
reader = new LineReader(StreamDecoder.forInputStreamReader(
|
||||
new FileInputStream(FileDescriptor.in),
|
||||
readLock,
|
||||
CHARSET));
|
||||
rcb = new char[1024];
|
||||
}
|
||||
}
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2005, 2022, Oracle and/or its affiliates. All rights reserved.
|
||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
||||
*
|
||||
* This code is free software; you can redistribute it and/or modify it
|
||||
@ -27,6 +27,7 @@
|
||||
#include "jni_util.h"
|
||||
#include "jvm.h"
|
||||
#include "java_io_Console.h"
|
||||
#include "java_io_ConsoleImpl.h"
|
||||
|
||||
#include <stdlib.h>
|
||||
#include <unistd.h>
|
||||
@ -45,7 +46,7 @@ Java_java_io_Console_encoding(JNIEnv *env, jclass cls)
|
||||
}
|
||||
|
||||
JNIEXPORT jboolean JNICALL
|
||||
Java_java_io_Console_echo(JNIEnv *env,
|
||||
Java_java_io_ConsoleImpl_echo(JNIEnv *env,
|
||||
jclass cls,
|
||||
jboolean on)
|
||||
{
|
||||
|
Loading…
x
Reference in New Issue
Block a user