Repository navigation
Expand file tree
/
Copy pathConsole.java
More file actions
623 lines (597 loc) · 26.4 KB
/
Copy pathConsole.java
File metadata and controls
623 lines (597 loc) · 26.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
/*
* Copyright (c) 2005, 2025, 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.lang.annotation.Native;
import java.util.*;
import java.nio.charset.Charset;
import jdk.internal.access.JavaIOAccess;
import jdk.internal.access.SharedSecrets;
import jdk.internal.io.JdkConsoleImpl;
import jdk.internal.io.JdkConsoleProvider;
import jdk.internal.util.StaticProperty;
import sun.nio.cs.UTF_8;
/**
* Methods to access the character-based console device, if any, associated
* with the current Java virtual machine.
*
* <p> Whether a virtual machine's console exists is dependent upon the
* underlying platform and also upon the manner in which the virtual
* machine is invoked. If the virtual machine is started from an
* interactive command line without redirecting the standard input and
* output streams, then its console will generally exist and will be
* connected to the keyboard and display from which the virtual machine
* was launched. If the standard input or standard output have been
* redirected (for example, to a file or to a pipe), or if the virtual
* machine was started from a background job scheduler, the console
* will not exist.
* <p>
* If the console exists, then it is represented by a unique instance of this
* class which can be obtained by invoking the {@link System#console()} method.
* If the console does not exist, that method will return {@code null}.
* <p>
* Read and write operations are synchronized to guarantee the atomic
* completion of critical operations; therefore invoking methods
* {@link #readLine()}, {@link #readPassword()}, {@link #format format()},
* {@link #printf printf()} as well as the read, format and write operations
* on the objects returned by {@link #reader()} and {@link #writer()} may
* block in multithreaded scenarios.
* <p>
* Read and write operations use the {@code Charset}s specified by
* {@link System##stdin.encoding stdin.encoding} and {@link
* System##stdout.encoding stdout.encoding}, respectively. The
* {@code Charset} used for write operations can also be retrieved using
* the {@link #charset()} method. Since {@code Console} is intended for
* interactive use on a terminal, these charsets are typically the same.
* <p>
* Operations that format strings are locale sensitive, using either the
* specified {@code Locale}, or the
* {@link Locale##default_locale default format Locale} to produce localized
* formatted strings.
* <p>
* Invoking {@code close()} on the objects returned by the {@link #reader()}
* and the {@link #writer()} will not close the underlying stream of those
* objects.
* <p>
* The console-read methods return {@code null} when the end of the
* console input stream is reached, for example by typing control-D on
* Unix or control-Z on Windows. Subsequent read operations will succeed
* if additional characters are later entered on the console's input
* device.
* <p>
* Unless otherwise specified, passing a {@code null} argument to any method
* in this class will cause a {@link NullPointerException} to be thrown.
* <p>
* <b>Security note:</b>
* If an application needs to read a password or other secure data, it should
* use {@link #readPassword()} or {@link #readPassword(String, Object...)} and
* manually zero the returned character array after processing to minimize the
* lifetime of sensitive data in memory.
*
* {@snippet lang=java :
* Console cons;
* char[] passwd;
* if ((cons = System.console()) != null &&
* (passwd = cons.readPassword("[%s]", "Password:")) != null) {
* ...
* java.util.Arrays.fill(passwd, ' ');
* }
* }
*
* @author Xueming Shen
* @since 1.6
*/
public sealed class Console implements Flushable permits ProxyingConsole {
/**
* Package private no-arg constructor.
*/
Console() {}
/**
* Retrieves the unique {@link java.io.PrintWriter PrintWriter} object
* associated with this console.
*
* @return The printwriter associated with this console
*/
public PrintWriter writer() {
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}:
* {@snippet lang=java :
* Console con = System.console();
* if (con != null) {
* Scanner sc = new Scanner(con.reader());
* code: // @replace substring="code:" replacement="..."
* }
* }
* <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() {
throw newUnsupportedOperationException();
}
/**
* Writes a formatted string to this console's output stream using
* the specified format string and arguments with the
* {@link Locale##default_locale default format locale}.
*
* @param format
* A format string as described in {@link
* Formatter##syntax Format string syntax}.
*
* @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 behavior on a
* {@code null} argument depends on the {@link
* Formatter##syntax conversion}.
*
* @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 {@link
* Formatter##detail Details} section
* of the formatter class specification.
*
* @return This console
*/
public Console format(String format, Object ... args) {
throw newUnsupportedOperationException();
}
/**
* Writes a formatted string to this console's output stream using
* the specified format string and arguments with the specified
* {@code locale}.
*
* @param locale The {@linkplain Locale locale} to apply during
* formatting. If {@code locale} is {@code null} then no localization
* is applied.
*
* @param format
* A format string as described in {@link
* Formatter##syntax Format string syntax}.
*
* @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 behavior on a
* {@code null} argument depends on the {@link
* Formatter##syntax conversion}.
*
* @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 {@link
* Formatter##detail Details} section
* of the formatter class specification.
*
* @return This console
* @since 23
*/
public Console format(Locale locale, String format, Object ... args) {
throw newUnsupportedOperationException();
}
/**
* A convenience method to write a formatted string to this console's
* output stream using the specified format string and arguments with
* the {@link Locale##default_locale default format locale}.
*
* @implSpec This is the same as calling {@code format(format, args)}.
*
* @param format
* A format string as described in {@link
* Formatter##syntax Format string syntax}.
*
* @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 behavior on a
* {@code null} argument depends on the {@link
* Formatter##syntax conversion}.
*
* @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 {@link
* Formatter##detail Details} section of the
* formatter class specification.
*
* @return This console
*/
public Console printf(String format, Object ... args) {
throw newUnsupportedOperationException();
}
/**
* A convenience method to write a formatted string to this console's
* output stream using the specified format string and arguments with
* the specified {@code locale}.
*
* @implSpec This is the same as calling
* {@code format(locale, format, args)}.
*
* @param locale The {@linkplain Locale locale} to apply during
* formatting. If {@code locale} is {@code null} then no localization
* is applied.
*
* @param format
* A format string as described in {@link
* Formatter##syntax Format string syntax}.
*
* @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 behavior on a
* {@code null} argument depends on the {@link
* Formatter##syntax conversion}.
*
* @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 {@link
* Formatter##detail Details} section of the
* formatter class specification.
*
* @return This console
* @since 23
*/
public Console printf(Locale locale, String format, Object ... args) {
throw newUnsupportedOperationException();
}
/**
* Provides a formatted prompt using the
* {@link Locale##default_locale default format locale}, then reads a
* single line of text from the console.
*
* @param format
* A format string as described in {@link
* Formatter##syntax Format string syntax}.
*
* @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 behavior on a
* {@code null} argument depends on the {@link
* Formatter##syntax conversion}.
*
* @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 {@link
* Formatter##detail Details} 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 format, Object ... args) {
throw newUnsupportedOperationException();
}
/**
* Provides a formatted prompt using the specified {@code locale}, then
* reads a single line of text from the console.
*
* @param locale The {@linkplain Locale locale} to apply during
* formatting. If {@code locale} is {@code null} then no localization
* is applied.
*
* @param format
* A format string as described in {@link
* Formatter##syntax Format string syntax}.
*
* @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 behavior on a
* {@code null} argument depends on the {@link
* Formatter##syntax conversion}.
*
* @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 {@link
* Formatter##detail Details} 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.
* @since 23
*/
public String readLine(Locale locale, String format, Object ... args) {
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.
*/
public String readLine() {
throw newUnsupportedOperationException();
}
/**
* Provides a formatted prompt using the
* {@link Locale##default_locale default format locale}, then reads a
* password or passphrase from the console with echoing disabled.
*
* @param format
* A format string as described in {@link
* Formatter##syntax Format string syntax}
* 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 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 behavior on a
* {@code null} argument depends on the {@link
* Formatter##syntax conversion}.
*
* @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 {@link
* Formatter##detail Details} 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 format, Object ... args) {
throw newUnsupportedOperationException();
}
/**
* Provides a formatted prompt using the specified {@code locale}, then
* reads a password or passphrase from the console with echoing disabled.
*
* @param locale The {@linkplain Locale locale} to apply during
* formatting. If {@code locale} is {@code null} then no localization
* is applied.
*
* @param format
* A format string as described in {@link
* Formatter##syntax Format string syntax}
* 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 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 behavior on a
* {@code null} argument depends on the {@link
* Formatter##syntax conversion}.
*
* @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 {@link
* Formatter##detail Details} 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.
* @since 23
*/
public char[] readPassword(Locale locale, String format, Object ... args) {
throw newUnsupportedOperationException();
}
/**
* 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() {
throw newUnsupportedOperationException();
}
/**
* Flushes the console and forces any buffered output to be written
* immediately.
*/
public void flush() {
throw newUnsupportedOperationException();
}
/**
* {@return the {@link java.nio.charset.Charset Charset} object used for
* the write operations on this {@code Console}}
* <p>
* The returned charset is used for encoding the data that is sent to
* the output (e.g., display), specified by the host environment or user.
* It defaults to the one based on {@link System##stdout.encoding stdout.encoding},
* and may not necessarily be the same as the default charset returned from
* {@link java.nio.charset.Charset#defaultCharset() Charset.defaultCharset()}.
*
* @since 17
*/
public Charset charset() {
throw newUnsupportedOperationException();
}
/**
* {@return {@code true} if the {@code Console} instance is a terminal}
* <p>
* This method always returns {@code true}, since {@link System#console()}
* provides a {@code Console} instance only when both standard input and
* output are unredirected, that is, when running in an interactive terminal.
*
* @since 22
*/
public boolean isTerminal() {
return true;
}
private static UnsupportedOperationException newUnsupportedOperationException() {
return new UnsupportedOperationException(
"Console class itself does not provide implementation");
}
@Native static final int TTY_STDIN_MASK = 0x00000001;
@Native static final int TTY_STDOUT_MASK = 0x00000002;
@Native static final int TTY_STDERR_MASK = 0x00000004;
// ttyStatus() returns bit patterns above, a bit is set if the corresponding file
// descriptor is a character device
private static final int ttyStatus = ttyStatus();
private static final Charset STDIN_CHARSET =
Charset.forName(StaticProperty.stdinEncoding(), UTF_8.INSTANCE);
private static final Charset STDOUT_CHARSET =
Charset.forName(StaticProperty.stdoutEncoding(), UTF_8.INSTANCE);
private static final Console cons = instantiateConsole();
static {
// Set up JavaIOAccess in SharedSecrets
SharedSecrets.setJavaIOAccess(new JavaIOAccess() {
public Console console() {
return cons;
}
public boolean isStdinTty() {
return Console.isStdinTty();
}
});
}
private static Console instantiateConsole() {
Console c = null;
try {
/*
* The JdkConsole provider used for Console instantiation can be specified
* with the system property "jdk.console", whose value designates the module
* name of the implementation, and which defaults to the value of
* {@code JdkConsoleProvider.DEFAULT_PROVIDER_MODULE_NAME}. If multiple
* provider implementations exist in that module, the first one found is used.
* If no providers are available, or instantiation failed, java.base built-in
* Console implementation is used.
*/
var consModName = System.getProperty("jdk.console",
JdkConsoleProvider.DEFAULT_PROVIDER_MODULE_NAME);
for (var jcp : ServiceLoader.load(ModuleLayer.boot(), JdkConsoleProvider.class)) {
if (consModName.equals(jcp.getClass().getModule().getName())) {
var jc = jcp.console(isStdinTty() && isStdoutTty(), STDIN_CHARSET, STDOUT_CHARSET);
if (jc != null) {
c = new ProxyingConsole(jc);
}
break;
}
}
} catch (ServiceConfigurationError _) {
}
// If not found, default to built-in Console
if (isStdinTty() && isStdoutTty() && c == null) {
c = new ProxyingConsole(new JdkConsoleImpl(STDIN_CHARSET, STDOUT_CHARSET));
}
return c;
}
private static boolean isStdinTty() {
return (ttyStatus & TTY_STDIN_MASK) != 0;
}
private static boolean isStdoutTty() {
return (ttyStatus & TTY_STDOUT_MASK) != 0;
}
private static boolean isStderrTty() {
return (ttyStatus & TTY_STDERR_MASK) != 0;
}
private static native int ttyStatus();
}