package be.nikiroo.utils.serial.server;
-import java.io.BufferedReader;
import java.io.IOException;
-import java.io.InputStreamReader;
-import java.io.OutputStreamWriter;
+import java.io.InputStream;
+import java.io.OutputStream;
import java.net.Socket;
-import be.nikiroo.utils.Version;
+import javax.net.ssl.SSLException;
+
+import be.nikiroo.utils.CryptUtils;
+import be.nikiroo.utils.IOUtils;
+import be.nikiroo.utils.StringUtils;
import be.nikiroo.utils.serial.Exporter;
import be.nikiroo.utils.serial.Importer;
+import be.nikiroo.utils.streams.BufferedOutputStream;
+import be.nikiroo.utils.streams.NextableInputStream;
+import be.nikiroo.utils.streams.NextableInputStreamStep;
+import be.nikiroo.utils.streams.ReplaceInputStream;
+import be.nikiroo.utils.streams.ReplaceOutputStream;
/**
* Base class used for the client/server basic handling.
abstract class ConnectAction {
private Socket s;
private boolean server;
- private Version version;
- private Version clientVersion;
+
+ private CryptUtils crypt;
private Object lock = new Object();
- private BufferedReader in;
- private OutputStreamWriter out;
+ private NextableInputStream in;
+ private BufferedOutputStream out;
private boolean contentToSend;
/**
* Method that will be called when an action is performed on either the
* client or server this {@link ConnectAction} represent.
*
- * @param version
- * the counter part version
- *
* @throws Exception
* in case of I/O error
*/
- abstract protected void action(Version version) throws Exception;
-
- /**
- * Method called when we negotiate the version with the client.
- * <p>
- * Thus, it is only called on the server.
- * <p>
- * Will return the actual server version by default.
- *
- * @param clientVersion
- * the client version
- *
- * @return the version to send to the client
- */
- abstract protected Version negotiateVersion(Version clientVersion);
+ abstract protected void action() throws Exception;
/**
* Handler called when an unexpected error occurs in the code.
*
* @param e
- * the exception that occurred
+ * the exception that occurred, SSLException usually denotes a
+ * crypt error
*/
abstract protected void onError(Exception e);
* @param server
* TRUE for a server action, FALSE for a client action (will
* impact the process)
- * @param version
- * the version of this client-or-server
+ * @param key
+ * an optional key to encrypt all the communications (if NULL,
+ * everything will be sent in clear text)
*/
- protected ConnectAction(Socket s, boolean server, Version version) {
+ protected ConnectAction(Socket s, boolean server, String key) {
this.s = s;
this.server = server;
-
- if (version == null) {
- this.version = new Version();
- } else {
- this.version = version;
+ if (key != null) {
+ crypt = new CryptUtils(key);
}
+ }
- clientVersion = new Version();
+ /**
+ * The total amount of bytes received.
+ *
+ * @return the amount of bytes received
+ */
+ public long getBytesReceived() {
+ return in.getBytesRead();
}
/**
- * The version of this client-or-server.
+ * The total amount of bytes sent.
*
- * @return the version
+ * @return the amount of bytes sent
*/
- public Version getVersion() {
- return version;
+ public long getBytesWritten() {
+ return out.getBytesWritten();
}
/**
*/
public void connect() {
try {
- in = new BufferedReader(new InputStreamReader(s.getInputStream(),
- "UTF-8"));
- try {
- out = new OutputStreamWriter(s.getOutputStream(), "UTF-8");
- try {
- if (server) {
- String line = in.readLine();
- if (line != null && line.startsWith("VERSION ")) {
- // "VERSION client-version" (VERSION 1.0.0)
- Version clientVersion = new Version(
- line.substring("VERSION ".length()));
- this.clientVersion = clientVersion;
- Version v = negotiateVersion(clientVersion);
- if (v == null) {
- v = new Version();
- }
-
- sendString("VERSION " + v.toString());
- }
+ // TODO: assure that \b is never used, make sure \n usage is OK
+ in = new NextableInputStream(s.getInputStream(),
+ new NextableInputStreamStep('\b'));
- action(clientVersion);
- } else {
- String v = sendString("VERSION " + version.toString());
- if (v != null && v.startsWith("VERSION ")) {
- v = v.substring("VERSION ".length());
- }
+ try {
+ out = new BufferedOutputStream(s.getOutputStream());
- action(new Version(v));
- }
+ try {
+ action();
} finally {
out.close();
- out = null;
}
} finally {
in.close();
- in = null;
}
} catch (Exception e) {
onError(e);
* @param data
* the data to send
*
- * @return the answer (which can be NULL) if this action is a client, always
- * NULL if it is a server
+ * @return the answer (which can be NULL if no answer, or NULL for an answer
+ * which is NULL) if this action is a client, always NULL if it is a
+ * server
*
* @throws IOException
* in case of I/O error
*/
protected Object sendObject(Object data) throws IOException,
NoSuchFieldException, NoSuchMethodException, ClassNotFoundException {
- synchronized (lock) {
- String rep = sendString(new Exporter().append(data).toString(true));
- if (rep != null) {
- return new Importer().read(rep).getValue();
- }
-
- return null;
- }
+ return send(out, data, false);
}
/**
protected Object recObject() throws IOException, NoSuchFieldException,
NoSuchMethodException, ClassNotFoundException,
java.lang.NullPointerException {
- String str = recString();
- if (str == null) {
- throw new NullPointerException("No more data available");
- }
-
- return new Importer().read(str).getValue();
+ return rec(false);
}
/**
*
* @throws IOException
* in case of I/O error
+ * @throws SSLException
+ * in case of crypt error
*/
protected String sendString(String line) throws IOException {
+ try {
+ return (String) send(out, line, true);
+ } catch (NoSuchFieldException e) {
+ // Cannot happen
+ e.printStackTrace();
+ } catch (NoSuchMethodException e) {
+ // Cannot happen
+ e.printStackTrace();
+ } catch (ClassNotFoundException e) {
+ // Cannot happen
+ e.printStackTrace();
+ }
+
+ return null;
+ }
+
+ /**
+ * Reserved for the server (externally): flush the data to the client and
+ * retrieve its answer.
+ * <p>
+ * Also used internally for the client (only do something if there is
+ * contentToSend).
+ * <p>
+ * Will only flush the data if there is contentToSend.
+ *
+ * @return the answer (which can be NULL if no more content)
+ *
+ * @throws IOException
+ * in case of I/O error
+ * @throws SSLException
+ * in case of crypt error
+ */
+ protected String recString() throws IOException {
+ try {
+ return (String) rec(true);
+ } catch (NoSuchFieldException e) {
+ // Cannot happen
+ e.printStackTrace();
+ } catch (NoSuchMethodException e) {
+ // Cannot happen
+ e.printStackTrace();
+ } catch (ClassNotFoundException e) {
+ // Cannot happen
+ e.printStackTrace();
+ } catch (NullPointerException e) {
+ // Should happen
+ e.printStackTrace();
+ }
+
+ return null;
+ }
+
+ /**
+ * Serialise and send the given object to the counter part (and, only for
+ * client, return the deserialised answer -- the server will always receive
+ * NULL).
+ *
+ * @param out
+ * the stream to write to
+ * @param data
+ * the data to write
+ * @param asString
+ * TRUE to write it as a String, FALSE to write it as an Object
+ *
+ * @return the answer (which can be NULL if no answer, or NULL for an answer
+ * which is NULL) if this action is a client, always NULL if it is a
+ * server
+ *
+ * @throws IOException
+ * in case of I/O error
+ * @throws SSLException
+ * in case of crypt error
+ * @throws IOException
+ * in case of I/O error
+ * @throws NoSuchFieldException
+ * if the serialised data contains information about a field
+ * which does actually not exist in the class we know of
+ * @throws NoSuchMethodException
+ * if a class described in the serialised data cannot be created
+ * because it is not compatible with this code
+ * @throws ClassNotFoundException
+ * if a class described in the serialised data cannot be found
+ */
+ private Object send(BufferedOutputStream out, Object data, boolean asString)
+ throws IOException, NoSuchFieldException, NoSuchMethodException,
+ ClassNotFoundException, java.lang.NullPointerException {
+
synchronized (lock) {
- out.write(line);
- out.write("\n");
+ OutputStream sub;
+ if (crypt != null) {
+ sub = crypt.encrypt64(out.open());
+ } else {
+ sub = out.open();
+ }
+
+ // TODO: could be possible to check for non-crypt and only
+ // do it for crypt
+ sub = new ReplaceOutputStream(sub, //
+ new String[] { "\\", "\b" }, //
+ new String[] { "\\\\", "\\b" });
+
+ try {
+ if (asString) {
+ sub.write(StringUtils.getBytes(data.toString()));
+ } else {
+ new Exporter(sub).append(data);
+ }
+ } finally {
+ sub.close();
+ }
+
+ out.write('\b');
if (server) {
out.flush();
}
contentToSend = true;
- return recString();
+ try {
+ return rec(asString);
+ } catch (NullPointerException e) {
+ // We accept no data here for Objects
+ }
+
+ return null;
}
}
/**
- * Reserved for the server (externally): flush the data to the client and
- * retrieve its answer.
+ * Reserved for the server: flush the data to the client and retrieve its
+ * answer.
* <p>
* Also used internally for the client (only do something if there is
* contentToSend).
* <p>
* Will only flush the data if there is contentToSend.
+ * <p>
+ * Note that the behaviour is slightly different for String and Object
+ * reading regarding exceptions:
+ * <ul>
+ * <li>NULL means that the counter part has no more data to send</li>
+ * <li>All the exceptions except {@link IOException} are there for Object
+ * conversion</li>
+ * </ul>
+ *
+ * @param asString
+ * TRUE for String reading, FALSE for Object reading (which can
+ * still be a String)
*
- * @return the answer (which can be NULL)
+ * @return the deserialised answer (which can actually be NULL)
*
* @throws IOException
* in case of I/O error
+ * @throws NoSuchFieldException
+ * if the serialised data contains information about a field
+ * which does actually not exist in the class we know of
+ * @throws NoSuchMethodException
+ * if a class described in the serialised data cannot be created
+ * because it is not compatible with this code
+ * @throws ClassNotFoundException
+ * if a class described in the serialised data cannot be found
+ * @throws java.lang.NullPointerException
+ * for Objects only: if the counter part has no data to send
*/
- protected String recString() throws IOException {
+ @SuppressWarnings("resource")
+ private Object rec(boolean asString) throws IOException,
+ NoSuchFieldException, NoSuchMethodException,
+ ClassNotFoundException, java.lang.NullPointerException {
+
synchronized (lock) {
if (server || contentToSend) {
if (contentToSend) {
contentToSend = false;
}
- return in.readLine();
+ if (in.next()) {
+ // TODO: could be possible to check for non-crypt and only
+ // do it for crypt
+ InputStream read = new ReplaceInputStream(in.open(), //
+ new String[] { "\\\\", "\\b" }, //
+ new String[] { "\\", "\b" });
+
+ try {
+ if (crypt != null) {
+ read = crypt.decrypt64(read);
+ }
+
+ if (asString) {
+ return IOUtils.readSmallStream(read);
+ }
+
+ return new Importer().read(read).getValue();
+ } finally {
+ read.close();
+ }
+ }
+
+ if (!asString) {
+ throw new NullPointerException();
+ }
}
return null;
git://git.nikiroo.be / nikiroo-utils.git / blobdiff