-/**
+/*
* Jexer - Java Text User Interface
*
- * License: LGPLv3 or later
- *
- * This module is licensed under the GNU Lesser General Public License
- * Version 3. Please see the file "COPYING" in this directory for more
- * information about the GNU Lesser General Public License Version 3.
+ * The MIT License (MIT)
*
- * Copyright (C) 2015 Kevin Lamonte
+ * Copyright (C) 2019 Kevin Lamonte
*
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 3 of
- * the License, or (at your option) any later version.
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
*
- * This program 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 for more details.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
*
- * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, see
- * http://www.gnu.org/licenses/, or write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
- * 02110-1301 USA
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
*
* @author Kevin Lamonte [kevin.lamonte@gmail.com]
* @version 1
import java.util.Map;
import java.util.TreeMap;
-import jexer.session.SessionInfo;
+import jexer.backend.SessionInfo;
import static jexer.net.TelnetSocket.*;
/**
* TelnetInputStream works with TelnetSocket to perform the telnet protocol.
*/
-public final class TelnetInputStream extends InputStream
- implements SessionInfo {
+public class TelnetInputStream extends InputStream implements SessionInfo {
+
+ // ------------------------------------------------------------------------
+ // Constants --------------------------------------------------------------
+ // ------------------------------------------------------------------------
+
+ // ------------------------------------------------------------------------
+ // Variables --------------------------------------------------------------
+ // ------------------------------------------------------------------------
/**
* The root TelnetSocket that has my telnet protocol state.
*/
private int readBufferStart;
+ /**
+ * User name.
+ */
+ private String username = "";
+
+ /**
+ * Language.
+ */
+ private String language = "en_US";
+
+ /**
+ * Text window width.
+ */
+ private int windowWidth = 80;
+
+ /**
+ * Text window height.
+ */
+ private int windowHeight = 24;
+
+ /**
+ * When true, the last read byte from the remote side was IAC.
+ */
+ private boolean iac = false;
+
+ /**
+ * When true, we are in the middle of a DO/DONT/WILL/WONT negotiation.
+ */
+ private boolean dowill = false;
+
+ /**
+ * The telnet option being negotiated.
+ */
+ private int dowillType = 0;
+
+ /**
+ * When true, we are waiting to see the end of the sub-negotiation
+ * sequence.
+ */
+ private boolean subnegEnd = false;
+
+ /**
+ * When true, the last byte read from the remote side was CR.
+ */
+ private boolean readCR = false;
+
+ /**
+ * The subnegotiation buffer.
+ */
+ private ArrayList<Byte> subnegBuffer;
+
+ // ------------------------------------------------------------------------
+ // Constructors -----------------------------------------------------------
+ // ------------------------------------------------------------------------
+
/**
* Package private constructor.
*
subnegBuffer = new ArrayList<Byte>();
}
- // SessionInfo interface --------------------------------------------------
-
- /**
- * User name.
- */
- private String username = "";
-
- /**
- * Language.
- */
- private String language = "en_US";
-
- /**
- * Text window width.
- */
- private int windowWidth = 80;
-
- /**
- * Text window height.
- */
- private int windowHeight = 24;
+ // ------------------------------------------------------------------------
+ // SessionInfo ------------------------------------------------------------
+ // ------------------------------------------------------------------------
/**
* Username getter.
this.language = language;
}
+ /**
+ * Get the terminal type as reported by the telnet Terminal Type option.
+ *
+ * @return the terminal type
+ */
+ public String getTerminalType() {
+ return master.terminalType;
+ }
+
/**
* Text window width getter.
*
// NOP
}
- // InputStream interface --------------------------------------------------
+ // ------------------------------------------------------------------------
+ // InputStream ------------------------------------------------------------
+ // ------------------------------------------------------------------------
/**
* Returns an estimate of the number of bytes that can be read (or
// If we got something, return it.
if (rc > 0) {
+ readBufferEnd += rc;
readBufferStart++;
return readBuffer[readBufferStart - 1];
}
return n;
}
- // Telnet protocol --------------------------------------------------------
-
-
- /**
- * When true, the last read byte from the remote side was IAC.
- */
- private boolean iac = false;
-
- /**
- * When true, we are in the middle of a DO/DONT/WILL/WONT negotiation.
- */
- private boolean dowill = false;
-
- /**
- * The telnet option being negotiated.
- */
- private int dowillType = 0;
-
- /**
- * When true, we are waiting to see the end of the sub-negotiation
- * sequence.
- */
- private boolean subnegEnd = false;
-
- /**
- * When true, the last byte read from the remote side was CR.
- */
- private boolean readCR = false;
-
- /**
- * The subnegotiation buffer.
- */
- private ArrayList<Byte> subnegBuffer;
+ // ------------------------------------------------------------------------
+ // TelnetInputStream ------------------------------------------------------
+ // ------------------------------------------------------------------------
/**
* For debugging, return a descriptive string for this telnet option.
* @param option the telnet option byte
* @return a string describing the telnet option code
*/
+ @SuppressWarnings("unused")
private String optionString(final int option) {
switch (option) {
case 0: return "Binary Transmission";
final int option) throws IOException {
byte [] buffer = new byte[3];
- buffer[0] = (byte)TELNET_IAC;
- buffer[1] = (byte)response;
- buffer[2] = (byte)option;
+ buffer[0] = (byte) TELNET_IAC;
+ buffer[1] = (byte) response;
+ buffer[2] = (byte) option;
output.rawWrite(buffer);
}
final byte [] response) throws IOException {
byte [] buffer = new byte[response.length + 5];
- buffer[0] = (byte)TELNET_IAC;
- buffer[1] = (byte)TELNET_SB;
- buffer[2] = (byte)option;
+ buffer[0] = (byte) TELNET_IAC;
+ buffer[1] = (byte) TELNET_SB;
+ buffer[2] = (byte) option;
System.arraycopy(response, 0, buffer, 3, response.length);
- buffer[response.length + 3] = (byte)TELNET_IAC;
- buffer[response.length + 4] = (byte)TELNET_SE;
+ buffer[response.length + 3] = (byte) TELNET_IAC;
+ buffer[response.length + 4] = (byte) TELNET_SE;
output.rawWrite(buffer);
}
* fails to handle ESC as defined in RFC 1572.
*/
private void handleNewEnvironment() {
- Map<StringBuilder, StringBuilder> newEnv =
- new TreeMap<StringBuilder, StringBuilder>();
+ Map<String, String> newEnv = new TreeMap<String, String>();
EnvState state = EnvState.INIT;
StringBuilder name = new StringBuilder();
StringBuilder value = new StringBuilder();
- for (int i = 0; i < subnegBuffer.size(); i++) {
+ /*
+ System.err.printf("handleNewEnvironment() %d bytes\n",
+ subnegBuffer.size());
+ */
+
+ for (int i = 1; i < subnegBuffer.size(); i++) {
Byte b = subnegBuffer.get(i);
+ /*
+ System.err.printf(" b: %c %d 0x%02x\n", (char)b.byteValue(),
+ b, b);
+ */
switch (state) {
// VAR
state = EnvState.NAME;
if (value.length() > 0) {
- newEnv.put(name, value);
+ /*
+ System.err.printf("NAME: '%s' VALUE: '%s'\n",
+ name, value);
+ */
+ newEnv.put(name.toString(), value.toString());
}
name = new StringBuilder();
} else if (b == 3) {
// USERVAR
state = EnvState.NAME;
if (value.length() > 0) {
- newEnv.put(name, value);
+ /*
+ System.err.printf("NAME: '%s' VALUE: '%s'\n",
+ name, value);
+ */
+ newEnv.put(name.toString(), value.toString());
}
name = new StringBuilder();
} else {
}
if ((name.length() > 0) && (value.length() > 0)) {
- newEnv.put(name, value);
+ /*
+ System.err.printf("NAME: '%s' VALUE: '%s'\n", name, value);
+ */
+ newEnv.put(name.toString(), value.toString());
}
- for (StringBuilder key: newEnv.keySet()) {
+ for (String key: newEnv.keySet()) {
if (key.equals("LANG")) {
- language = newEnv.get(key).toString();
+ language = newEnv.get(key);
}
if (key.equals("LOGNAME")) {
- username = newEnv.get(key).toString();
+ username = newEnv.get(key);
}
if (key.equals("USER")) {
- username = newEnv.get(key).toString();
+ username = newEnv.get(key);
}
}
}
get(i).byteValue());
}
master.terminalType = terminalString.toString();
+ /*
+ System.err.printf("terminal type: '%s'\n",
+ master.terminalType);
+ */
}
break;
for (int i = 2; i < subnegBuffer.size(); i++) {
speedString.append((char)subnegBuffer.get(i).byteValue());
}
- String termSpeed = speedString.toString();
master.terminalSpeed = speedString.toString();
+ /*
+ System.err.printf("terminal speed: '%s'\n",
+ master.terminalSpeed);
+ */
}
break;
int i = 0;
i++;
- if (subnegBuffer.get(i) == (byte)TELNET_IAC) {
+ if (subnegBuffer.get(i) == (byte) TELNET_IAC) {
i++;
}
- windowWidth = subnegBuffer.get(i) * 256;
+ int width = subnegBuffer.get(i);
+ if (width < 0) {
+ width += 256;
+ }
+ windowWidth = width * 256;
i++;
- if (subnegBuffer.get(i) == (byte)TELNET_IAC) {
+ if (subnegBuffer.get(i) == (byte) TELNET_IAC) {
i++;
}
- windowWidth += subnegBuffer.get(i);
+ width = subnegBuffer.get(i);
+ windowWidth += width;
+ if (width < 0) {
+ windowWidth += 256;
+ }
i++;
- if (subnegBuffer.get(i) == (byte)TELNET_IAC) {
+ if (subnegBuffer.get(i) == (byte) TELNET_IAC) {
i++;
}
- windowHeight = subnegBuffer.get(i) * 256;
+ int height = subnegBuffer.get(i);
+ if (height < 0) {
+ height += 256;
+ }
+ windowHeight = height * 256;
i++;
- if (subnegBuffer.get(i) == (byte)TELNET_IAC) {
+ if (subnegBuffer.get(i) == (byte) TELNET_IAC) {
i++;
}
- windowHeight += subnegBuffer.get(i);
+ height = subnegBuffer.get(i);
+ windowHeight += height;
+ if (height < 0) {
+ windowHeight += 256;
+ }
}
break;
assert (len > 0);
// The current writing position in buf.
- int bufN = 0;
+ int bufN = off;
// We will keep trying to read() until we have something to return.
do {
- // Read up to len bytes
- byte [] buffer = new byte[len];
+ byte [] buffer = null;
+ if (master.binaryMode) {
+ // Binary mode: read up to len bytes. There will never be
+ // more bytes to pass upstream than there are bytes on the
+ // wire.
+ buffer = new byte[len];
+ } else {
+ // ASCII mode: read up to len - 2 bytes. There may have been
+ // some combination of IAC, CR, and NUL from a previous
+ // readImpl() that could result in more bytes to pass up than
+ // are on the wire.
+ buffer = new byte[len - 2];
+ }
+
int bufferN = 0;
// Read some data from the other end
if (subnegEnd == true) {
// Looking for IAC SE to end this subnegotiation
- if (b == (byte)TELNET_SE) {
+ if (b == (byte) TELNET_SE) {
if (iac == true) {
iac = false;
subnegEnd = false;
handleSubneg();
}
- } else if (b == (byte)TELNET_IAC) {
+ } else if (b == (byte) TELNET_IAC) {
if (iac == true) {
// An argument to the subnegotiation option
- subnegBuffer.add((byte)TELNET_IAC);
+ subnegBuffer.add((byte) TELNET_IAC);
} else {
iac = true;
}
case 0:
// Binary Transmission
- if (dowillType == (byte)TELNET_WILL) {
+ if (dowillType == (byte) TELNET_WILL) {
// Server will use binary transmission, yay.
master.binaryMode = true;
- } else if (dowillType == (byte)TELNET_DO) {
+ } else if (dowillType == (byte) TELNET_DO) {
// Server asks for binary transmission.
WILL(b);
master.binaryMode = true;
- } else if (dowillType == (byte)TELNET_WONT) {
+ } else if (dowillType == (byte) TELNET_WONT) {
// We're screwed, server won't do binary
// transmission.
master.binaryMode = false;
case 1:
// Echo
- if (dowillType == (byte)TELNET_WILL) {
+ if (dowillType == (byte) TELNET_WILL) {
// Server will use echo, yay.
master.echoMode = true;
- } else if (dowillType == (byte)TELNET_DO) {
+ } else if (dowillType == (byte) TELNET_DO) {
// Server asks for echo.
WILL(b);
master.echoMode = true;
- } else if (dowillType == (byte)TELNET_WONT) {
+ } else if (dowillType == (byte) TELNET_WONT) {
// We're screwed, server won't do echo.
master.echoMode = false;
} else {
case 3:
// Suppress Go Ahead
- if (dowillType == (byte)TELNET_WILL) {
+ if (dowillType == (byte) TELNET_WILL) {
// Server will use suppress go-ahead, yay.
master.goAhead = false;
- } else if (dowillType == (byte)TELNET_DO) {
+ } else if (dowillType == (byte) TELNET_DO) {
// Server asks for suppress go-ahead.
WILL(b);
master.goAhead = false;
- } else if (dowillType == (byte)TELNET_WONT) {
+ } else if (dowillType == (byte) TELNET_WONT) {
// We're screwed, server won't do suppress
// go-ahead.
master.goAhead = true;
case 24:
// Terminal Type - send what's in TERM
- if (dowillType == (byte)TELNET_WILL) {
+ if (dowillType == (byte) TELNET_WILL) {
// Server will use terminal type, yay.
if (master.isServer
&& master.doTermType
} else if (!master.isServer) {
master.doTermType = true;
}
- } else if (dowillType == (byte)TELNET_DO) {
+ } else if (dowillType == (byte) TELNET_DO) {
// Server asks for terminal type.
WILL(b);
master.doTermType = true;
- } else if (dowillType == (byte)TELNET_WONT) {
+ } else if (dowillType == (byte) TELNET_WONT) {
// We're screwed, server won't do terminal type.
master.doTermType = false;
} else {
case 31:
// NAWS
- if (dowillType == (byte)TELNET_WILL) {
+ if (dowillType == (byte) TELNET_WILL) {
// Server will use NAWS, yay.
master.doNAWS = true;
// NAWS cannot be requested by the server, it is
// only sent by the client.
- } else if (dowillType == (byte)TELNET_DO) {
+ } else if (dowillType == (byte) TELNET_DO) {
// Server asks for NAWS.
WILL(b);
master.doNAWS = true;
- } else if (dowillType == (byte)TELNET_WONT) {
+ } else if (dowillType == (byte) TELNET_WONT) {
// Server won't do NAWS.
master.doNAWS = false;
} else {
case 32:
// Terminal Speed
- if (dowillType == (byte)TELNET_WILL) {
+ if (dowillType == (byte) TELNET_WILL) {
// Server will use terminal speed, yay.
if (master.isServer
&& master.doTermSpeed
} else if (!master.isServer) {
master.doTermSpeed = true;
}
- } else if (dowillType == (byte)TELNET_DO) {
+ } else if (dowillType == (byte) TELNET_DO) {
// Server asks for terminal speed.
WILL(b);
master.doTermSpeed = true;
- } else if (dowillType == (byte)TELNET_WONT) {
+ } else if (dowillType == (byte) TELNET_WONT) {
// We're screwed, server won't do terminal speed.
master.doTermSpeed = false;
} else {
case 39:
// New Environment
- if (dowillType == (byte)TELNET_WILL) {
+ if (dowillType == (byte) TELNET_WILL) {
// Server will use NewEnvironment, yay.
if (master.isServer
&& master.doEnvironment
} else if (!master.isServer) {
master.doEnvironment = true;
}
- } else if (dowillType == (byte)TELNET_DO) {
+ } else if (dowillType == (byte) TELNET_DO) {
// Server asks for NewEnvironment.
WILL(b);
master.doEnvironment = true;
- } else if (dowillType == (byte)TELNET_WONT) {
+ } else if (dowillType == (byte) TELNET_WONT) {
// Server won't do NewEnvironment.
master.doEnvironment = false;
} else {
} // if (dowill == true)
// Perform read processing
- if (b == (byte)TELNET_IAC) {
+ if (b == (byte) TELNET_IAC) {
// Telnet command
if (iac == true) {
// IAC IAC -> IAC
- buf[bufN++] = (byte)TELNET_IAC;
+ buf[bufN++] = (byte) TELNET_IAC;
iac = false;
} else {
iac = true;
switch (b) {
- case (byte)TELNET_SE:
- // log.debug1(" END Sub-Negotiation");
+ case (byte) TELNET_SE:
+ // END Sub-Negotiation
break;
- case (byte)TELNET_NOP:
- // log.debug1(" NOP");
+ case (byte) TELNET_NOP:
+ // NOP
break;
- case (byte)TELNET_DM:
- // log.debug1(" Data Mark");
+ case (byte) TELNET_DM:
+ // Data Mark
break;
- case (byte)TELNET_BRK:
- // log.debug1(" Break");
+ case (byte) TELNET_BRK:
+ // Break
break;
- case (byte)TELNET_IP:
- // log.debug1(" Interrupt Process");
+ case (byte) TELNET_IP:
+ // Interrupt Process
break;
- case (byte)TELNET_AO:
- // log.debug1(" Abort Output");
+ case (byte) TELNET_AO:
+ // Abort Output
break;
- case (byte)TELNET_AYT:
- // log.debug1(" Are You There?");
+ case (byte) TELNET_AYT:
+ // Are You There?
break;
- case (byte)TELNET_EC:
- // log.debug1(" Erase Character");
+ case (byte) TELNET_EC:
+ // Erase Character
break;
- case (byte)TELNET_EL:
- // log.debug1(" Erase Line");
+ case (byte) TELNET_EL:
+ // Erase Line
break;
- case (byte)TELNET_GA:
- // log.debug1(" Go Ahead");
+ case (byte) TELNET_GA:
+ // Go Ahead
break;
- case (byte)TELNET_SB:
- // log.debug1(" START Sub-Negotiation");
+ case (byte) TELNET_SB:
+ // START Sub-Negotiation
// From here we wait for the IAC SE
subnegEnd = true;
subnegBuffer.clear();
break;
- case (byte)TELNET_WILL:
- // log.debug1(" WILL");
+ case (byte) TELNET_WILL:
+ // WILL
dowill = true;
dowillType = b;
break;
- case (byte)TELNET_WONT:
- // log.debug1(" WON'T");
+ case (byte) TELNET_WONT:
+ // WON'T
dowill = true;
dowillType = b;
break;
- case (byte)TELNET_DO:
- // log.debug1(" DO");
+ case (byte) TELNET_DO:
+ // DO
dowill = true;
dowillType = b;
-
- if (master.binaryMode == true) {
- // log.debug1("Telnet DO in binary mode");
- }
-
break;
- case (byte)TELNET_DONT:
- // log.debug1(" DON'T");
+ case (byte) TELNET_DONT:
+ // DON'T
dowill = true;
dowillType = b;
break;
default:
// This should be equivalent to IAC NOP
- // log.debug1("Will treat as IAC NOP");
break;
}
iac = false;
return bufN;
}
-
}