From 12bd4df6397a198aeea22f0fb76de8d321973e2c Mon Sep 17 00:00:00 2001 From: Yoann PIGNE Date: Fri, 20 Apr 2012 15:31:24 +0200 Subject: [PATCH] Add a java Sender with not dependences not even to gs-core --- .../src/org/netstream/NetStreamConstants.java | 806 +++++++ java/src/org/netstream/NetStreamSender.java | 1016 ++++++++ java/src/org/netstream/packing/Base64.java | 2093 +++++++++++++++++ .../org/netstream/packing/Base64Packer.java | 68 + .../netstream/packing/NetStreamPacker.java | 63 + 5 files changed, 4046 insertions(+) create mode 100644 java/src/org/netstream/NetStreamConstants.java create mode 100644 java/src/org/netstream/NetStreamSender.java create mode 100644 java/src/org/netstream/packing/Base64.java create mode 100644 java/src/org/netstream/packing/Base64Packer.java create mode 100644 java/src/org/netstream/packing/NetStreamPacker.java diff --git a/java/src/org/netstream/NetStreamConstants.java b/java/src/org/netstream/NetStreamConstants.java new file mode 100644 index 0000000..ff900be --- /dev/null +++ b/java/src/org/netstream/NetStreamConstants.java @@ -0,0 +1,806 @@ +/* + * Copyright 2006 - 2012 + * Stefan Balev + * Julien Baudry + * Antoine Dutot + * Yoann Pigné + * Guilhelm Savin + * + * GraphStream is a library whose purpose is to handle static or dynamic + * graph, create them from scratch, file or any source and display them. + * + * This program is free software distributed under the terms of two licenses, the + * CeCILL-C license that fits European law, and the GNU Lesser General Public + * License. You can use, modify and/ or redistribute the software under the terms + * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following + * URL or under the terms of the GNU LGPL as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * 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 Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program. If not, see . + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms. + */ +package org.netstream; + +/** + *

NetStream

+ * + *

+ * The NetStream framework allows to export the idea of "streams of graph + * events" to other languages than Java, through a network interface. The + * aim is mainly to allow the use of GraphStream with other projects written in + * other languages. However, since it is a network interface it also allows the + * use of several machines. The protocol is optimized to be have as low overhead + * as possible. + *

+ *

+ * If you are looking for a Java-to-Java network link between GraphStream and + * some other project, you may prefer GraphStream's RMI facilities. + *

+ *

+ * This document is organized in 3 sections. The first one details the + * Receiver's mechanisms. The second section describes the Sender. The last + * section details the NetStream Protocol. + *

+ *

Receiver

+ *

+ * This one is responsible for receiving graph events from the network following + * the "NetStream" protocol. Events are then dispatched to pipes + * according to a given names. Here we consider that several stream of events + * (independent one another) can be handled by the receiver. We thus introduce + * the idea of stream ID where a stream is identified by an ID. + *

+ *

+ * The Receiver is composed of: + *

+ *
    + *
  • A socket server that handles multiples connections directed to multiple + * streams (pipes). That part is mostly a copy/past from Antoine's "MBox + * Receiver" code.
    • + *
  • An implementation of the NetStream Protocol (see below) that parses the + * received byte arrays and creates/sends graph events to specified pipes.
    • + *
  • a set of streams (ThreadProxyPipes) identified by an ID. From + * GraphStream's point of view, the NetStreamReceriver provides sources + * (actually pipes) on which sinks (or other pipes) can connect to, to receive + * graph events.
    • + *
+ *

+ * The Receiver's general behavior is: + *

+ *
    + *
  • Wait for messages from any sender received data is stored separately for + * each sender until a message is completely received. The receiver knows about + * a complete message because the first 4 bytes of the messages are an integer + * that gives the size of the message.
    • + *
  • A complete message is decoded (according to the NetStream Protocol), an + * event is created and sent to the specified stream (pipe)
    • + *
+ *

+ * The graph event receiver listens at a given address and port. It runs on its + * own thread. Several senders can connect to it, the receiver will demultiplex + * the data flow and dispatch incoming events to specified pipes. No extra + * thread are created when client connect. + *

+ *

+ * From the graph event stream point of view, the NetStream receiver can be seen + * as a set of pipes identified by an id. When an event is received is is + * directed to one specific stream. By default, senders not willing to handle + * different streams may send to the stream called "default". + *

+ *

+ * The only way to receive events from the network is to ask for a stream by + * means of a ThreadProxyPipe to the Receiver. The + * getStream() and + * getDefaultStream() give access to such + * pipe. Asking a non-existing stream (with an unknown id) will create it, so + * those functions always return a pipe. On the opposite, any new stream + * introduced by a sender will be created by the receiver. + *

+ * + *

+ * Example

+ * + * 
+ * import java.io.IOException;
+ * import java.net.UnknownHostException;
+ * 
+ * import org.graphstream.graph.Graph;
+ * import org.graphstream.graph.implementations.MultiGraph;
+ * import org.graphstream.stream.thread.ThreadProxyPipe;
+ * 
+ * // A simple example of use of the NetStream receiver.
+ * 
+ * public class ReceiverExample {
+ * 
+ * 	public static void main(String[] args) throws UnknownHostException,
+ * 			IOException, InterruptedException {
+ * 		// ----- On the receiver side -----
+ * 		//
+ * 		// - a graph that will display the received events
+ * 		Graph g = new MultiGraph("G");
+ * 		g.display();
+ * 		// - the receiver that waits for events
+ * 		NetStreamReceiver net = new NetStreamReceiver(2001);
+ * 		// - received events end up in the "default" pipe
+ * 		ThreadProxyPipe pipe = net.getDefaultStream();
+ * 		// - plug the pipe to the sink of the graph
+ * 		pipe.addSink(g);
+ * 		// -The receiver pro-actively checks for events on the ThreadProxyPipe
+ * 		while (true) {
+ * 			pipe.pump();
+ * 			Thread.sleep(100);
+ * 		}
+ * 	}
+ * }
+ *
+ * + *

Sender

+ *

+ * A sender, from the GraphStream API, is first of all a sink where one can plug + * sources so that it can receive events. Receiving these events the sender will + * pack them into messages according to the NetStream Protocol and then send + * those messages to a defined receiver through a given port, + * host and stream ID. + *

+ *

Example

+ * + * 
+ * import java.io.IOException;
+ * import java.net.UnknownHostException;
+ * 
+ * import org.graphstream.graph.Graph;
+ * import org.graphstream.graph.implementations.MultiGraph;
+ * 
+ * // A simple example of use of the NetStream sender.
+ * 
+ * public class SenderExample {
+ * 
+ * 	public static void main(String[] args) {
+ * 		Graph g = new MultiGraph("G");
+ * 		// - the sender
+ * 		NetStreamSender nsc = null;
+ * 		try {
+ * 			nsc = new NetStreamSender(2001);
+ * 		} catch (UnknownHostException e) {
+ * 			e.printStackTrace();
+ * 		} catch (IOException e) {
+ * 			e.printStackTrace();
+ * 		}
+ * 		// - plug the graph to the sender so that graph events can be
+ * 		// sent automatically
+ * 		g.addSink(nsc);
+ * 		// - generate some events on the client side
+ * 		String style = "node{fill-mode:plain;fill-color:#567;size:6px;}";
+ * 		g.addAttribute("stylesheet", style);
+ * 		g.addAttribute("ui.antialias", true);
+ * 		g.addAttribute("layout.stabilization-limit", 0);
+ * 		for (int i = 0; i < 500; i++) {
+ * 			g.addNode(i + "");
+ * 			if (i > 0) {
+ * 				g.addEdge(i + "-" + (i - 1), i + "", (i - 1) + "");
+ * 				g.addEdge(i + "--" + (i / 2), i + "", (i / 2) + "");
+ * 			}
+ * 		}
+ * 	}
+ * 
+ * }
+ *
+ * + *

The + * NetStream Protocol

+ *

+ * Messages in the NetStream protocol are specified a the byte level. It is + * different than an XML-based protocols like client/server REST approaches. + * Here the content and different formats constituting a message are optimize as + * much as possible, so as to reduce the network payload. + *

+ *

+ * A message, as it is created by a sender, is composed of three main parts: + *

    + *
  1. A 4 bytes integer that indicates the size (in bytes) of the remaining of + * this message (not including those 4 bytes).
    2. + *
  2. A string, encoded using the NetStream protocol (see + * TYPE_STRING below), that identifies the + * stream targeted by this event.
    3. + *
  3. The event itself, that can be decoded, according to the NetStream + * protocol.
    4. + *
+ *
+ *

Data Types

+ *

+ * Before sending a value whose type is unknown (integer, double, string, + * array...) one have to specify its type (and if applicable, its length) to the + * server. Value types are defined to allow the server to recognize the type of + * a value. When applicable (strings, tables, raw data) types are followed by a + * length. This length is always coded with a 16-bits signed short and usually + * represents the number of elements (for arrays). + *

+ *
    + *
  • + *

    + * TYPE_BOOLEAN [0x50] + *

    + *

    + * Announces a boolean value. Followed by a byte whose value is 0 (false) or 1 + * (true). + *

    + *
    • + *
  • + *

    + * TYPE_BOOLEAN_ARRAY [0X51] + *

    + *

    + * Announces an array of boolean values. Followed by first, a 32-bit integer + * that indicates the length of this array, and then, by the actual sequence of + * booleans. + *

    + *
    • + *
  • + *

    + * TYPE_BYTE [0x52] + *

    + *

    + * Announces a byte. Followed by a 8-bit signed byte. + *

    + *
    • + *
  • + *

    + * TYPE_INT_BYTE [0x53] + *

    + *

    + * Announces an array of bytes. Followed by first, a 32-bit integer that + * indicates the length in number of elements of this array, and then, by the + * actual sequence of 8-bit signed bytes. + *

    + *
    • + *
  • + *

    + * TYPE_SHORT [0x54] + *

    + *

    + * Announces a short. Followed by a 16-bit signed short. + *

    + *
    • + *
  • + *

    + * TYPE_SHORT_ARRAY [0x55] + *

    + *

    + * Announces an array of shorts. Followed by first, a 32-bit integer that + * indicates the length in number of elements of this array, and then, by the + * actual sequence of 16-bit signed shorts. + *

    + *
    • + *
  • + *

    + * TYPE_INT [0x56] + *

    + *

    + * Announces an integer. Followed by a 32-bit signed integer. + *

    + *
    • + *
  • + *

    + * TYPE_INT_ARRAY [0x57] + *

    + *

    + * Announces an array of integers. Followed by first, a 32-bit integer that + * indicates the length in number of elements of this array, and then, the + * actual sequence of 32-bit signed integers. + *

    + *
    • + *
  • + *

    + * TYPE_LONG [0x58] + *

    + *

    + * Announces a long. Followed by a 64-bit signed long. + *

    + *
    • + *
  • + *

    + * TYPE_LONG_ARRAY [0x59] + *

    + *

    + * Announces an array of longs. Followed by first, a 32-bit integer that + * indicates the length in number of elements of this array, and then, by the + * actual sequence of 64-bit signed longs. + *

    + *
    • + *
  • + *

    + * TYPE_FLOAT [0x5A] + *

    + *

    + * Announces a float. Followed by a 32-bit single precision signed floating + * point number. + *

    + *
    • + *
  • + *

    + * TYPE_FLOAT_ARRAY [0x5B] + *

    + *

    + * Announces an array of floats. Followed by first, a 32-bit integer that + * indicates the length in number of elements of this array, and then, by the + * actual sequence of 32-bit double precision signed floating point numbers. + *

    + *
    • + *
  • + *

    + * TYPE_DOUBLE [0x5C] + *

    + *

    + * Announces a double. Followed by a 64-bit double precision signed floating + * point number. + *

    + *
    • + *
  • + *

    + * TYPE_DOUBLE_ARRAY [0x5D] + *

    + *

    + * Announces an array of doubles. Followed by first, a 32-bit integer that + * indicates the length in number of elements of this array, and then, by the + * actual sequence of 64-bit double precision signed floating point numbers. + *

    + *
    • + *
  • + *

    + * TYPE_STRING [0x5E] + *

    + *

    + * Announces an array of characters. Followed by first, a 32-bits integer for + * the size in bytes (not in number of characters) of the string, then by the + * unicode string itself. + *

    + *
    • + *
  • + *

    + * TYPE_RAW [0x5F] + *

    + *

    + * Announces raw data, good for serialization or to exchange data the will then + * be understood in any language (an image, for instance). Followed by first, a + * 16-bits integer indicating the length in bytes of the dataset, and then by + * the data itself, as unsigned bytes. + *

    + *
    • + *
  • + *

    + * TYPE_ARRAY [0x60] + *

    + *

    + * Announces an undefined-type array. Followed by first, a 32-bits integer + * indicating the number of elements, and then, the elements themselves. The + * elements themselves have to give their types. It may contain data of + * different types or even other arrays. + *

    + *
    • + *
+ *

Graph Events

+ *

+ * the graph event, as created by a sender, is the third part of the whole sent + * message. It is made of several parts that differ according the event. The + * common information is the first byte of the event, that identifies the event. + * Then, other data depending on the event follow up. Those event identifiers + * are one byte long. To avoid problems between languages (mainly because of + * java) those bytes are unsigned and only positive values are used. So, any + * event identifier will take a value between 0 and 127. + *

+ *

+ * Here is a list of graph event identifiers followed by the expected + * information to fulfill these events: + *

+ *
    + *
  • + *

    + * EVENT_ADD_NODE [0x10] + *

    + *

    + * Add a node. Followed by a node id ( + * TYPE_STRING format). + *

    + *
    • + *
  • + *

    + * EVENT_DEL_NODE [0x11] + *

    + *

    + * Remove a node. Followed by a node id ( + * TYPE_STRING format) + *

    + *
    • + *
  • + *

    + * EVENT_ADD_EDGE [0x12] + *

    + *

    + * Add an edge. Followed by: + *

    + *
      + *
    • the edge id (TYPE_STRING format),
      • + *
    • the source node id (TYPE_STRING format),
      • + *
    • the target node id (TYPE_STRING format
      • + *
    • a boolean indicating if the edge is directed (is it an arc?) + * (TYPE_BOOLEAN format)
      • + *
    + *
    • + *
  • + *

    + * EVENT_DEL_NODE [0x13] + *

    + *

    + * Remove an edge. Followed by the string id of this edge. + *

    + *
    • + *
  • + *

    + * EVENT_STEP [0x14] + *

    + *

    + * Time step. Followed by a 64-bit double indicating the timestamp. + *

    + *
    • + *
  • + *

    + * EVENT_CLEARED [0x15] + *

    + *

    + * Clear the graph. This event will remove any attribute or element in the + * graph. + *

    + *
    • + *
  • + *

    + * EVENT_ADD_GRAPH_ATTR [0x16] + *

    + *

    + * Add an attribute to the graph. Followed by: + *

    + *
      + *
    • the attribute name (TYPE_STRING format)
      • + *
    • the attribute value type (one of the bytes shown in the "Data + * Types" section)
      • + *
    • the attribute value, encoded according to its value type (see the + * "Data Types" section)
      • + *
    + *
    • + *
  • + *

    + * EVENT_CHG_GRAPH_ATTR [0x17] + *

    + *

    + * Change an existing attribute on the graph. Followed by: + *

    + *
      + *
    • the attribute name (TYPE_STRING format)
      • + *
    • the attribute value type (one of the bytes shown in the "Data + * Types" section)
      • + *
    • the old attribute value, encoded according to its value type (see the + * "Data Types" section)
      • + *
    • the new attribute value, encoded according to its value type (see the + * "Data Types" section)
      • + *
    + *
    • + *
  • + *

    + * EVENT_DEL_GRAPH_ATTR [0x18] + *

    + *

    + * Remove an attribute from the graph. Followed by the attribute name (encoded + * with the TYPE_STRING format). + *

    + *
    • + *
  • + *

    + * EVENT_ADD_NODE_ATTR [0x19] + *

    + *

    + * Add an attribute to a node. Followed by: + *

    + *
      + *
    • the ID of the considered node (TYPE_STRING format)
      • + *
    • the attribute name (TYPE_STRING format)
      • + *
    • the attribute value type (one of the bytes shown in the "Data + * Types" section)
      • + *
    • the attribute value, encoded according to its value type (see the + * "Data Types" section)
      • + *
    + *
    • + *
  • + *

    + * EVENT_CHG_NODE_ATTR [0x1A] + *

    + *

    + * Change an existing attribute on a given node. Followed by: + *

    + *
      + *
    • the ID of the considered node (TYPE_STRING format)
      • + *
    • the attribute name (TYPE_STRING format)
      • + *
    • the attribute value type (one of the bytes shown in the "Data + * Types" section)
      • + *
    • the old attribute value, encoded according to its value type (see the + * "Data Types" section)
      • + *
    • the new attribute value, encoded according to its value type (see the + * "Data Types" section)
      • + *
    + *
    • + *
  • + *

    + * EVENT_DEL_NODE_ATTR [0x1B] + *

    + *

    + * Remove an attribute from a given node. Followed by: + *

    + *
      + *
    • the ID of the considered node (TYPE_STRING format)
      • + *
    • the attribute name (encoded with the TYPE_STRING format).
      • + *
    + *
    • + *
  • + *

    + * EVENT_ADD_EDGE_ATTR [0x1C] + *

    + *

    + * Add an attribute to a node. Followed by: + *

    + *
      + *
    • the ID of the considered node (TYPE_STRING format)
      • + *
    • the attribute name (TYPE_STRING format)
      • + *
    • the attribute value type (one of the bytes shown in the "Data + * Types" section)
      • + *
    • the attribute value, encoded according to its value type (see the + * "Data Types" section)
      • + *
    + *
    • + *
  • + *

    + * EVENT_CHG_EDGE_ATTR [0x1D] + *

    + *

    + * Change an existing attribute on a given node. Followed by: + *

    + *
      + *
    • the ID of the considered node (TYPE_STRING format)
      • + *
    • the attribute name (TYPE_STRING format)
      • + *
    • the attribute value type (one of the bytes shown in the "Data + * Types" section)
      • + *
    • the old attribute value, encoded according to its value type (see the + * "Data Types" section)
      • + *
    • the new attribute value, encoded according to its value type (see the + * "Data Types" section)
      • + *
    + *
    • + *
  • + *

    + * EVENT_DEL_EDGE_ATTR [0x1E] + *

    + *

    + * Remove an attribute from a given node. Followed by: + *

    + *
      + *
    • the ID of the considered node (TYPE_STRING format)
      • + *
    • the attribute name (encoded with the TYPE_STRING format).
      • + *
    + *
    • + *
+ *
+ * + * + * + * Copyright (c) 2010-2012 University of Luxembourg - University of Le Havre + * + * NetStreamConstants.java + * @since Aug 3, 2011 + * + * @author Yoann Pigné + * + */ +public class NetStreamConstants { + /** + * Followed by an 32-bit signed integer for this protocol version. Certainly + * useless. + */ + public static int EVENT_GETVERSION = 0x00; + /** + * Not used. + */ + public static int EVENT_START = 0x01; + + /** + * Constant indicating that the client has disconnected. + */ + public static int EVENT_END = 0x02; + + // + // ---------------------------------- + // GraphStream's graph events + // ---------------------------------- + // + + /** + * Followed by a node id (TYPE_STRING format) + */ + public static int EVENT_ADD_NODE = 0x10; + + /** + * Followed by a node id (TYPE_STRING format) + */ + public static int EVENT_DEL_NODE = 0x11; + + /** + * Followed by - an edge id (TYPE_STRING format), - an source node id + * (TYPE_STRING format), - a target node id (TYPE_STRING format - a boolean + * indicating if directed (TYPE_BOOLEAN format) + */ + public static int EVENT_ADD_EDGE = 0x12; + + /** + * Followed by an edge id (TYPE_STRING format) + */ + public static int EVENT_DEL_EDGE = 0x13; + + /** + * Followed by double (TYPE_DOUBLE format) + */ + public static int EVENT_STEP = 0x14; + /** + * + */ + public static int EVENT_CLEARED = 0x15; + + /** + * Followed by - an attribute id (TYPE_STRING format) - the attribute TYPE - + * the attribute value + */ + public static int EVENT_ADD_GRAPH_ATTR = 0x16; + /** + * Followed by - an attribute id (TYPE_STRING format) - the attribute TYPE - + * the attribute old value - the attribute new value + */ + public static int EVENT_CHG_GRAPH_ATTR = 0x17; + /** + * Followed by - the attribute id (TYPE_STRING format) + */ + public static int EVENT_DEL_GRAPH_ATTR = 0x18; + + /** + * Followed by - an attribute id (TYPE_STRING format) - the attribute TYPE - + * the attribute value + */ + public static int EVENT_ADD_NODE_ATTR = 0x19; + /** + * Followed by - an attribute id (TYPE_STRING format) - the attribute TYPE - + * the attribute old value - the attribute new value + */ + public static int EVENT_CHG_NODE_ATTR = 0x1a; + /** + * Followed by - the node id (TYPE_STRING format) - the attribute id + * (TYPE_STRING format) + */ + public static int EVENT_DEL_NODE_ATTR = 0x1b; + + /** + * Followed by - an attribute id (TYPE_STRING format) - the attribute TYPE - + * the attribute value + */ + public static int EVENT_ADD_EDGE_ATTR = 0x1c; + /** + * Followed by - an attribute id (TYPE_STRING format) - the attribute TYPE - + * the attribute old value - the attribute new value + */ + public static int EVENT_CHG_EDGE_ATTR = 0x1d; + /** + * Followed by - the edge id (TYPE_STRING format) - the attribute id + * (TYPE_STRING format) + */ + public static int EVENT_DEL_EDGE_ATTR = 0x1e; + + // Values types + + /** + * Followed by a byte who's value is 0 or 1 + */ + public static int TYPE_BOOLEAN = 0x50; + /** + * An array of booleans. Followed by first, a 16-bits integer for the number + * of booleans and then, a list of bytes who's value is 0 or 1 + */ + public static int TYPE_BOOLEAN_ARRAY = 0x51; + /** + * Followed by a signed byte [-127,127] + */ + public static int TYPE_BYTE = 0x52; + /** + * An array of bytes. Followed by first, a 16-bits integer for the number of + * integers and then, a list of signed bytes. + */ + public static int TYPE_BYTE_ARRAY = 0x53; + /** + * Followed by an 16-bit signed integer (a short) + */ + public static int TYPE_SHORT = 0x54; + /** + * An array of shorts. Followed by first, a 16-bits integer for the number + * of integers and then, a list of 16-bit signed shorts + */ + public static int TYPE_SHORT_ARRAY = 0x55; + /** + * Followed by an 32-bit signed integer + */ + public static int TYPE_INT = 0x56; + /** + * An array of integers. Followed by first, a 16-bits integer for the number + * of integers and then, a list of 32-bit signed integers + */ + public static int TYPE_INT_ARRAY = 0x57; + /** + * Followed by an 64-bit signed integer + */ + public static int TYPE_LONG = 0x58; + /** + * An array of longs. Followed by first, a 16-bits integer for the number of + * longs and then, a list of 62-bit signed integers + */ + public static int TYPE_LONG_ARRAY = 0x59; + /** + * Followed by a single precision 32-bits floating point number + */ + public static int TYPE_FLOAT = 0x5a; + /** + * Array of double. Followed by first, a 16-bits integer for the number of + * floats and then, a list of 32-bit floats + */ + public static int TYPE_FLOAT_ARRAY = 0x5b; + /** + * Followed by a double precision 64-bits floating point number + */ + public static int TYPE_DOUBLE = 0x5c; + /** + * Array of double. Followed by first, a 16-bits integer for the number of + * doubles and then, a list of 64-bit doubles + */ + public static int TYPE_DOUBLE_ARRAY = 0x5d; + /** + * Array of characters. Followed by first, a 16-bits integer for the size in + * bytes (not in number of characters) of the string, then by the unicode + * string + */ + public static int TYPE_STRING = 0x5e; + /** + * Raw data, good for serialization. Followed by first, a 16-bits integer + * indicating the length in bytes of the dataset, and then the data itself. + */ + public static int TYPE_RAW = 0x5f; + + /** + * An type-unspecified array. Followed by first, a 16-bits integer + * indicating the number of elements, and then, the elements themselves. The + * elements themselves have to give their type. + */ + public static byte TYPE_ARRAY = 0x60; + + + + /** + * Constant that indicates that this message is a COMMAND, not and EVENT. + * + * For now it is followed by a string that has to be parssed at the application level. + * + * THIS IS EXPERIMENTAL AND MAY (WILL) CHANGE ! + */ + public static int COMMAND = 0x70; + + +} \ No newline at end of file diff --git a/java/src/org/netstream/NetStreamSender.java b/java/src/org/netstream/NetStreamSender.java new file mode 100644 index 0000000..6dff4c6 --- /dev/null +++ b/java/src/org/netstream/NetStreamSender.java @@ -0,0 +1,1016 @@ +/* + * Copyright 2006 - 2012 + * Stefan Balev + * Julien Baudry + * Antoine Dutot + * Yoann Pigné + * Guilhelm Savin + * + * GraphStream is a library whose purpose is to handle static or dynamic + * graph, create them from scratch, file or any source and display them. + * + * This program is free software distributed under the terms of two licenses, the + * CeCILL-C license that fits European law, and the GNU Lesser General Public + * License. You can use, modify and/ or redistribute the software under the terms + * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following + * URL or under the terms of the GNU LGPL as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * 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 Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program. If not, see . + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms. + */ +package org.netstream; + +import java.io.BufferedOutputStream; +import java.io.IOException; +import java.net.Socket; +import java.net.UnknownHostException; +import java.nio.ByteBuffer; +import java.nio.charset.Charset; + +import org.netstream.packing.NetStreamPacker; + +/** + *

+ * This class implements a sender according to specifications the NetStream + * protocol, but does not depend on GraphStream's Sink interface. + *

+ * + *

+ * Attention: This class almost a copy of the sender located in the + * gs-core package. The only difference is that it does not depends on + * GraphStream. It's goal is to be integrated in other projects. + *

+ * + *

+ * See {@link NetStreamConstants} for a full description of the protocol, the + * sender and the receiver. + *

+ * + * @see NetStreamConstants + * + * + * NetStreamSender.java + * + * + * @author Yoann Pigné + * + */ +public class NetStreamSender { + protected String stream; + byte[] streamIdArray; + protected String host; + protected int port; + protected Socket socket; + protected BufferedOutputStream out; + + protected String sourceId = ""; + protected byte[] sourceIdBuff; + + class DefaultPacker extends NetStreamPacker { + ByteBuffer sizeBuffer = ByteBuffer.allocate(4); + + @Override + public ByteBuffer packMessage(ByteBuffer buffer, int startIndex, + int endIndex) { + return buffer; + } + + @Override + public ByteBuffer packMessageSize(int capacity) { + sizeBuffer.rewind(); + sizeBuffer.putInt(capacity); + return sizeBuffer; + } + + }; + + protected NetStreamPacker packer = new DefaultPacker(); + + public NetStreamSender(String host, int port) throws UnknownHostException, + IOException { + this("default", host, port); + } + public NetStreamSender(int port) throws UnknownHostException, IOException { + this("default", "localhost", port); + } + + public NetStreamSender(String stream, String host, int port) + throws UnknownHostException, IOException { + this.stream = stream; + this.host = host; + this.port = port; + streamIdArray = stream.getBytes(Charset.forName("UTF-8")); + + connect(); + + } + + /** + * Sets an optional NetStreamPaker whose "pack" method will be called on + * each message. + * + * a Packer can do extra encoding on the all byte array message, it may also + * crypt things. + * + * @param paker + * The packer object + */ + public void setPacker(NetStreamPacker paker) { + this.packer = paker; + } + public void removePacker() { + packer = new DefaultPacker(); + } + + protected void connect() throws UnknownHostException, IOException { + + socket = new Socket(host, port); + out = new BufferedOutputStream(socket.getOutputStream()); + + } + + protected int getType(Object value) { + int valueType = 0; + Class valueClass = value.getClass(); + boolean isArray = valueClass.isArray(); + if (isArray) { + valueClass = ((Object[]) value)[0].getClass(); + } + if (valueClass.equals(Boolean.class)) { + if (isArray) { + valueType = NetStreamConstants.TYPE_BOOLEAN_ARRAY; + } else { + valueType = NetStreamConstants.TYPE_BOOLEAN; + } + } else if (valueClass.equals(Byte.class)) { + if (isArray) { + valueType = NetStreamConstants.TYPE_BYTE_ARRAY; + } else { + valueType = NetStreamConstants.TYPE_BYTE; + } + } else if (valueClass.equals(Short.class)) { + if (isArray) { + valueType = NetStreamConstants.TYPE_SHORT_ARRAY; + } else { + valueType = NetStreamConstants.TYPE_SHORT; + } + } else if (valueClass.equals(Integer.class)) { + if (isArray) { + valueType = NetStreamConstants.TYPE_INT_ARRAY; + } else { + valueType = NetStreamConstants.TYPE_INT; + } + } else if (valueClass.equals(Long.class)) { + if (isArray) { + valueType = NetStreamConstants.TYPE_LONG_ARRAY; + } else { + valueType = NetStreamConstants.TYPE_LONG; + } + } else if (valueClass.equals(Float.class)) { + if (isArray) { + valueType = NetStreamConstants.TYPE_FLOAT_ARRAY; + } else { + valueType = NetStreamConstants.TYPE_FLOAT; + } + } else if (valueClass.equals(Double.class)) { + if (isArray) { + valueType = NetStreamConstants.TYPE_DOUBLE_ARRAY; + } else { + valueType = NetStreamConstants.TYPE_DOUBLE; + } + } else if (valueClass.equals(String.class)) { + if (isArray) { + valueType = NetStreamConstants.TYPE_ARRAY; + } else { + valueType = NetStreamConstants.TYPE_STRING; + } + } + // System.out.println("ValueType="+valueType+" "+value.getClass()); + return valueType; + } + + protected ByteBuffer encodeValue(Object in, int valueType) { + + if (NetStreamConstants.TYPE_BOOLEAN == valueType) { + return encodeBoolean(in); + } else if (NetStreamConstants.TYPE_BOOLEAN_ARRAY == valueType) { + return encodeBooleanArray(in); + } else if (NetStreamConstants.TYPE_BYTE == valueType) { + return encodeByte(in); + } else if (NetStreamConstants.TYPE_BYTE_ARRAY == valueType) { + return encodeByteArray(in); + } else if (NetStreamConstants.TYPE_SHORT == valueType) { + return encodeShort(in); + } else if (NetStreamConstants.TYPE_SHORT_ARRAY == valueType) { + return encodeShortArray(in); + } else if (NetStreamConstants.TYPE_INT == valueType) { + return encodeInt(in); + } else if (NetStreamConstants.TYPE_INT_ARRAY == valueType) { + return encodeIntArray(in); + } else if (NetStreamConstants.TYPE_LONG == valueType) { + return encodeLong(in); + } else if (NetStreamConstants.TYPE_LONG_ARRAY == valueType) { + return encodeLongArray(in); + } else if (NetStreamConstants.TYPE_FLOAT == valueType) { + return encodeFloat(in); + } else if (NetStreamConstants.TYPE_FLOAT_ARRAY == valueType) { + return encodeFloatArray(in); + } else if (NetStreamConstants.TYPE_DOUBLE == valueType) { + return encodeDouble(in); + } else if (NetStreamConstants.TYPE_DOUBLE_ARRAY == valueType) { + return encodeDoubleArray(in); + } else if (NetStreamConstants.TYPE_STRING == valueType) { + return encodeString(in); + } else if (NetStreamConstants.TYPE_ARRAY == valueType) { + return encodeArray(in); + } + return null; + + } + + /** + * @param in + * @return + */ + protected ByteBuffer encodeArray(Object in) { + // TODO... + return null; + } + + /** + * @param in + * @return + */ + protected ByteBuffer encodeString(Object in) { + String s = (String) in; + byte[] data = s.getBytes(Charset.forName("UTF-8")); + return ByteBuffer.allocate(4 + data.length).putInt(data.length) + .put(data); + } + + /** + * @param in + * @return + */ + protected ByteBuffer encodeDoubleArray(Object in) { + Object[] data = (Object[]) in; + + ByteBuffer b = ByteBuffer.allocate(4 + data.length * 8); + + b.putInt(data.length); + + for (int i = 0; i < data.length; i++) { + b.putDouble((Double) data[i]); + } + return b; + } + + /** + * @param in The double to encode + * @return ByteBuffer with encoded double in it + */ + protected ByteBuffer encodeDouble(Object in) { + return ByteBuffer.allocate(8).putDouble((Double) in); + } + + /** + * @param in The float array to encode + * @return ByteBuffer with encoded float array in it + */ + protected ByteBuffer encodeFloatArray(Object in) { + Object[] data = (Object[]) in; + ByteBuffer b = ByteBuffer.allocate(4 + data.length * 4).putInt( + data.length); + + for (int i = 0; i < data.length; i++) { + b.putFloat((Float) data[i]); + } + return b; + } + + /** + * @param in The float to encode + * @return ByteBuffer with encoded float in it + */ + protected ByteBuffer encodeFloat(Object in) { + return ByteBuffer.allocate(4).putFloat(((Float) in)); + } + + /** + * @param in The long array to encode + * @return ByteBuffer with encoded long array in it + */ + protected ByteBuffer encodeLongArray(Object in) { + Object[] data = (Object[]) in; + ByteBuffer b = ByteBuffer.allocate(4 + data.length * 8); + b.putInt(data.length); + + for (int i = 0; i < data.length; i++) { + b.putLong((Long) data[i]); + } + return b; + } + + /** + * @param in The long to encode + * @return ByteBuffer with encoded long in it + */ + protected ByteBuffer encodeLong(Object in) { + return ByteBuffer.allocate(8).putLong((Long) in); + } + + /** + * @param in The integer array to encode + * @return ByteBuffer with encoded integer array in it + */ + protected ByteBuffer encodeIntArray(Object in) { + Object[] data = (Object[]) in; + ByteBuffer b = ByteBuffer.allocate(4 + data.length * 4); + b.putInt(data.length); + + for (Object aData : data) { + b.putInt((Integer) aData); + } + return b; + } + + /** + * @param in The integer to encode + * @return ByteBuffer with encoded integer in it + */ + protected ByteBuffer encodeInt(Object in) { + return ByteBuffer.allocate(4).putInt((Integer) in); + } + + /** + * @param in + * @return + */ + protected ByteBuffer encodeShortArray(Object in) { + Object[] data = (Object[]) in; + ByteBuffer b = ByteBuffer.allocate(4 + data.length * 2); + b.putInt(data.length); + + for (int i = 0; i < data.length; i++) { + b.putShort((Short) data[i]); + } + return b; + } + + /** + * @param in + * @return + */ + protected ByteBuffer encodeShort(Object in) { + return ByteBuffer.allocate(2).putShort((Short) in); + } + + /** + * @param in + * @return + */ + protected ByteBuffer encodeByteArray(Object in) { + Object[] data = (Object[]) in; + ByteBuffer b = ByteBuffer.allocate(4 + data.length); + b.putInt(data.length); + + for (int i = 0; i < data.length; i++) { + b.put((Byte) data[i]); + } + return b; + } + + /** + * @param in + * @return + */ + protected ByteBuffer encodeByte(Object in) { + return ByteBuffer.allocate(1).put((Byte) in); + } + + /** + * @param in + * @return + */ + protected ByteBuffer encodeBooleanArray(Object in) { + Object[] data = (Object[]) in; + ByteBuffer b = ByteBuffer.allocate(4 + data.length); + b.putInt(data.length); + + for (int i = 0; i < data.length; i++) { + b.put((byte) ((Boolean) data[i] == false ? 0 : 1)); + } + return b; + } + + /** + * @param in + * @return + */ + protected ByteBuffer encodeBoolean(Object in) { + return ByteBuffer.allocate(1).put( + (byte) (((Boolean) in) == false ? 0 : 1)); + } + + /** + * @param buff + */ + private void doSend(ByteBuffer buff) { + + if (socket.isClosed()) { + System.err + .println("NetStreamSender : can't send. The socket is closed."); + } else { + ByteBuffer buffer = packer.packMessage(buff); + ByteBuffer sizeBuffer = packer.packMessageSize(buffer.capacity()); + buff.rewind(); + // real sending + try { + out.write(sizeBuffer.array(), 0, sizeBuffer.capacity()); + out.write(buffer.array(), 0, buffer.capacity()); + out.flush(); + } catch (IOException e) { + e.printStackTrace(); + } + } + } + + /* + * (non-Javadoc) + * + * @see + * org.graphstream.stream.AttributeSink#graphAttributeAdded(java.lang.String + * , long, java.lang.String, java.lang.Object) + */ + public void graphAttributeAdded(String sourceId, long timeId, + String attribute, Object value) { + + if (!sourceId.equals(this.sourceId)) { + this.sourceId = sourceId; + sourceIdBuff = sourceId.getBytes(Charset.forName("UTF-8")); + } + byte[] attrArray = attribute.getBytes(Charset.forName("UTF-8")); + int valueType = getType(value); + ByteBuffer bValue = encodeValue(value, valueType); + bValue.flip(); + ByteBuffer buff = ByteBuffer.allocate(4 + streamIdArray.length + // stream + // id + 1 + // CMD + 4 + sourceIdBuff.length + // source id + 8 + // timeId + 4 + attrArray.length + // attribute id + 1 + // attr type + bValue.capacity()); // attr value + + buff.putInt(streamIdArray.length).put(streamIdArray) + .put((byte) NetStreamConstants.EVENT_ADD_GRAPH_ATTR) + .putInt(sourceIdBuff.length).put(sourceIdBuff).putLong(timeId) + .putInt(attrArray.length).put(attrArray).put((byte) valueType) + .put(bValue); + + doSend(buff); + + } + + /* + * (non-Javadoc) + * + * @see + * org.graphstream.stream.AttributeSink#graphAttributeChanged(java.lang. + * String, long, java.lang.String, java.lang.Object, java.lang.Object) + */ + public void graphAttributeChanged(String sourceId, long timeId, + String attribute, Object oldValue, Object newValue) { + + if (!sourceId.equals(this.sourceId)) { + this.sourceId = sourceId; + sourceIdBuff = sourceId.getBytes(Charset.forName("UTF-8")); + } + byte[] attrArray = attribute.getBytes(Charset.forName("UTF-8")); + int valueType = getType(oldValue); + + ByteBuffer bOldValue = encodeValue(oldValue, valueType); + bOldValue.flip(); + ByteBuffer bNewValue = encodeValue(newValue, valueType); + bNewValue.flip(); + + ByteBuffer buff = ByteBuffer.allocate(4 + streamIdArray.length + // Stream + // id + 1 + // CMD + 4 + sourceIdBuff.length + // source id + 8 + // timeId + 4 + attrArray.length + // attr name + 1 + bOldValue.capacity() + bNewValue.capacity()); // values + + buff.putInt(streamIdArray.length).put(streamIdArray) + .put((byte) NetStreamConstants.EVENT_CHG_GRAPH_ATTR) + .putInt(sourceIdBuff.length).put(sourceIdBuff).putLong(timeId) + .putInt(attrArray.length).put(attrArray).put((byte) valueType) + .put(bOldValue).put(bNewValue); + + doSend(buff); + + } + + /* + * (non-Javadoc) + * + * @see + * org.graphstream.stream.AttributeSink#graphAttributeRemoved(java.lang. + * String, long, java.lang.String) + */ + public void graphAttributeRemoved(String sourceId, long timeId, + String attribute) { + + if (!sourceId.equals(this.sourceId)) { + this.sourceId = sourceId; + sourceIdBuff = sourceId.getBytes(Charset.forName("UTF-8")); + } + byte[] attrArray = attribute.getBytes(Charset.forName("UTF-8")); + + ByteBuffer buff = ByteBuffer.allocate(4 + streamIdArray.length + // stream + // id + 1 + // CMD + 4 + sourceIdBuff.length + // source id + 8 + // timeId + 4 + attrArray.length // ATTR name + ); + + buff.putInt(streamIdArray.length).put(streamIdArray) + .put((byte) NetStreamConstants.EVENT_DEL_GRAPH_ATTR) + .putInt(sourceIdBuff.length).put(sourceIdBuff).putLong(timeId) + .putInt(attrArray.length).put(attrArray); + + doSend(buff); + + } + + /* + * (non-Javadoc) + * + * @see + * org.graphstream.stream.AttributeSink#nodeAttributeAdded(java.lang.String, + * long, java.lang.String, java.lang.String, java.lang.Object) + */ + public void nodeAttributeAdded(String sourceId, long timeId, String nodeId, + String attribute, Object value) { + + if (!sourceId.equals(this.sourceId)) { + this.sourceId = sourceId; + sourceIdBuff = sourceId.getBytes(Charset.forName("UTF-8")); + } + byte[] nodeIdArray = nodeId.getBytes(Charset.forName("UTF-8")); + byte[] attrArray = attribute.getBytes(Charset.forName("UTF-8")); + int valueType = getType(value); + ByteBuffer bValue = encodeValue(value, valueType); + bValue.flip(); + ByteBuffer buff = ByteBuffer.allocate(4 + streamIdArray.length + // stream + // ID + 1 + // CMD + 4 + sourceIdBuff.length + // source id + 8 + // timeId + (4 + nodeIdArray.length) + // nodeId + (4 + attrArray.length) + // attribute + 1 + // value type + bValue.capacity() // value + ); + + buff.putInt(streamIdArray.length).put(streamIdArray) + // Stream + .put((byte) NetStreamConstants.EVENT_ADD_NODE_ATTR) + // CMD + .putInt(sourceIdBuff.length).put(sourceIdBuff).putLong(timeId) + .putInt(nodeIdArray.length).put(nodeIdArray) // nodeId + .putInt(attrArray.length).put(attrArray) // attribute + .put((byte) valueType) // value type + .put(bValue); // value + + doSend(buff); + + } + + /* + * (non-Javadoc) + * + * @see + * org.graphstream.stream.AttributeSink#nodeAttributeChanged(java.lang.String + * , long, java.lang.String, java.lang.String, java.lang.Object, + * java.lang.Object) + */ + public void nodeAttributeChanged(String sourceId, long timeId, + String nodeId, String attribute, Object oldValue, Object newValue) { + if (!sourceId.equals(this.sourceId)) { + this.sourceId = sourceId; + sourceIdBuff = sourceId.getBytes(Charset.forName("UTF-8")); + } + byte[] attrArray = attribute.getBytes(Charset.forName("UTF-8")); + byte[] nodeIdArray = nodeId.getBytes(Charset.forName("UTF-8")); + int valueType = getType(oldValue); + + ByteBuffer bOldValue = encodeValue(oldValue, valueType); + bOldValue.flip(); + ByteBuffer bNewValue = encodeValue(newValue, valueType); + bNewValue.flip(); + + ByteBuffer buff = ByteBuffer.allocate(4 + streamIdArray.length + // stream + 1 + // CMD + 4 + sourceIdBuff.length + // source id + 8 + // timeId + (4 + nodeIdArray.length) + // nodeId + (4 + attrArray.length) + // attribute + 1 + // value type + bOldValue.capacity() + // value + bNewValue.capacity() // new value + ); + + buff.putInt(streamIdArray.length).put(streamIdArray) + // Stream id + .put((byte) NetStreamConstants.EVENT_CHG_NODE_ATTR) + // CMD + .putInt(sourceIdBuff.length).put(sourceIdBuff).putLong(timeId) + .putInt(nodeIdArray.length).put(nodeIdArray) // nodeId + .putInt(attrArray.length).put(attrArray) // attribute + .put((byte) valueType) // value type + .put(bOldValue) // value + .put(bNewValue); // value + doSend(buff); + } + + /* + * (non-Javadoc) + * + * @see + * org.graphstream.stream.AttributeSink#nodeAttributeRemoved(java.lang.String + * , long, java.lang.String, java.lang.String) + */ + public void nodeAttributeRemoved(String sourceId, long timeId, + String nodeId, String attribute) { + + if (!sourceId.equals(this.sourceId)) { + this.sourceId = sourceId; + sourceIdBuff = sourceId.getBytes(Charset.forName("UTF-8")); + } + byte[] nodeIdArray = nodeId.getBytes(Charset.forName("UTF-8")); + byte[] attrArray = attribute.getBytes(Charset.forName("UTF-8")); + + ByteBuffer buff = ByteBuffer.allocate(4 + streamIdArray.length + // stream + // id + 1 + // CMD + 4 + sourceIdBuff.length + // source id + 8 + // timeId + (4 + nodeIdArray.length) + // nodeId + (4 + attrArray.length) // attribute + ); + + buff.putInt(streamIdArray.length).put(streamIdArray) + // Stream id + .put((byte) NetStreamConstants.EVENT_DEL_NODE_ATTR) + // CMD + .putInt(sourceIdBuff.length).put(sourceIdBuff).putLong(timeId) + .putInt(nodeIdArray.length).put(nodeIdArray) // nodeId + .putInt(attrArray.length).put(attrArray); // attribute + + doSend(buff); + + } + + /* + * (non-Javadoc) + * + * @see + * org.graphstream.stream.AttributeSink#edgeAttributeAdded(java.lang.String, + * long, java.lang.String, java.lang.String, java.lang.Object) + */ + public void edgeAttributeAdded(String sourceId, long timeId, String edgeId, + String attribute, Object value) { + + if (!sourceId.equals(this.sourceId)) { + this.sourceId = sourceId; + sourceIdBuff = sourceId.getBytes(Charset.forName("UTF-8")); + } + byte[] edgeIdArray = edgeId.getBytes(Charset.forName("UTF-8")); + byte[] attrArray = attribute.getBytes(Charset.forName("UTF-8")); + int valueType = getType(value); + ByteBuffer bValue = encodeValue(value, valueType); + bValue.flip(); + ByteBuffer buff = ByteBuffer.allocate(4 + streamIdArray.length + // stream + 1 + // CMD + 4 + sourceIdBuff.length + // source id + 8 + // timeId + (4 + edgeIdArray.length) + // nodeId + (4 + attrArray.length) + // attribute + 1 + // value type + bValue.capacity() // value + ); + + buff.putInt(streamIdArray.length).put(streamIdArray) + // Stream id + .put((byte) NetStreamConstants.EVENT_ADD_EDGE_ATTR) + // CMD + .putInt(sourceIdBuff.length).put(sourceIdBuff).putLong(timeId) + .putInt(edgeIdArray.length).put(edgeIdArray) // nodeId + .putInt(attrArray.length).put(attrArray) // attribute + .put((byte) valueType) // value type + .put(bValue); // value + + doSend(buff); + } + + /* + * (non-Javadoc) + * + * @see + * org.graphstream.stream.AttributeSink#edgeAttributeChanged(java.lang.String + * , long, java.lang.String, java.lang.String, java.lang.Object, + * java.lang.Object) + */ + public void edgeAttributeChanged(String sourceId, long timeId, + String edgeId, String attribute, Object oldValue, Object newValue) { + + if (!sourceId.equals(this.sourceId)) { + this.sourceId = sourceId; + sourceIdBuff = sourceId.getBytes(Charset.forName("UTF-8")); + } + byte[] edgeIdArray = edgeId.getBytes(Charset.forName("UTF-8")); + byte[] attrArray = attribute.getBytes(Charset.forName("UTF-8")); + int valueType = getType(oldValue); + + ByteBuffer bOldValue = encodeValue(oldValue, valueType); + bOldValue.flip(); + ByteBuffer bNewValue = encodeValue(newValue, valueType); + bNewValue.flip(); + + ByteBuffer buff = ByteBuffer.allocate(4 + streamIdArray.length + // stream + // id + 1 + // CMD + 4 + sourceIdBuff.length + // source id + 8 + // timeId + (4 + edgeIdArray.length) + // nodeId + (4 + attrArray.length) + // attribute + 1 + // value type + bOldValue.capacity() + // value + bNewValue.capacity() // new value + ); + + buff.putInt(streamIdArray.length).put(streamIdArray) + // Stream + .put((byte) NetStreamConstants.EVENT_CHG_EDGE_ATTR) + // CMD + .putInt(sourceIdBuff.length).put(sourceIdBuff).putLong(timeId) + .putInt(edgeIdArray.length).put(edgeIdArray) // nodeId + .putInt(attrArray.length).put(attrArray) // attribute + .put((byte) valueType) // value type + .put(bOldValue) // value + .put(bNewValue); // value + + doSend(buff); + + } + + /* + * (non-Javadoc) + * + * @see + * org.graphstream.stream.AttributeSink#edgeAttributeRemoved(java.lang.String + * , long, java.lang.String, java.lang.String) + */ + public void edgeAttributeRemoved(String sourceId, long timeId, + String edgeId, String attribute) { + + if (!sourceId.equals(this.sourceId)) { + this.sourceId = sourceId; + sourceIdBuff = sourceId.getBytes(Charset.forName("UTF-8")); + } + byte[] edgeIdArray = edgeId.getBytes(Charset.forName("UTF-8")); + byte[] attrArray = attribute.getBytes(Charset.forName("UTF-8")); + + ByteBuffer buff = ByteBuffer.allocate(4 + streamIdArray.length + // stream + // id + 1 + // CMD + 4 + sourceIdBuff.length + // source id + 8 + // timeId + (4 + edgeIdArray.length) + // nodeId + (4 + attrArray.length) // attribute + ); + + buff.putInt(streamIdArray.length).put(streamIdArray) + // Stream id + .put((byte) NetStreamConstants.EVENT_DEL_EDGE_ATTR) + // CMD + .putInt(sourceIdBuff.length).put(sourceIdBuff).putLong(timeId) + .putInt(edgeIdArray.length).put(edgeIdArray) // nodeId + .putInt(attrArray.length).put(attrArray); // attribute + + doSend(buff); + + } + + /* + * (non-Javadoc) + * + * @see org.graphstream.stream.ElementSink#nodeAdded(java.lang.String, long, + * java.lang.String) + */ + public void nodeAdded(String sourceId, long timeId, String nodeId) { + + if (!sourceId.equals(this.sourceId)) { + this.sourceId = sourceId; + sourceIdBuff = sourceId.getBytes(Charset.forName("UTF-8")); + } + byte[] nodeIdArray = nodeId.getBytes(Charset.forName("UTF-8")); + + ByteBuffer buff = ByteBuffer.allocate(4 + streamIdArray.length + // stream + 1 + // CMD + 4 + sourceIdBuff.length + // source id + 8 + // timeId + 4 + nodeIdArray.length // node id + ); + + buff.putInt(streamIdArray.length) + .put(streamIdArray) + // Stream ID + .put((byte) NetStreamConstants.EVENT_ADD_NODE) + .putInt(sourceIdBuff.length).put(sourceIdBuff).putLong(timeId) + .putInt(nodeIdArray.length).put(nodeIdArray); + + doSend(buff); + + } + + /* + * (non-Javadoc) + * + * @see org.graphstream.stream.ElementSink#nodeRemoved(java.lang.String, + * long, java.lang.String) + */ + public void nodeRemoved(String sourceId, long timeId, String nodeId) { + if (!sourceId.equals(this.sourceId)) { + this.sourceId = sourceId; + sourceIdBuff = sourceId.getBytes(Charset.forName("UTF-8")); + } + byte[] nodeIdArray = nodeId.getBytes(Charset.forName("UTF-8")); + + ByteBuffer buff = ByteBuffer.allocate(4 + streamIdArray.length + // stream + // id + 1 + // CMD + 4 + sourceIdBuff.length + // source id + 8 + // timeId + 4 + nodeIdArray.length // node id + ); + buff.putInt(streamIdArray.length) + .put(streamIdArray) + // Stream ID + .put((byte) NetStreamConstants.EVENT_DEL_NODE) + .putInt(sourceIdBuff.length).put(sourceIdBuff).putLong(timeId) + .putInt(nodeIdArray.length).put(nodeIdArray); + + doSend(buff); + } + + /* + * (non-Javadoc) + * + * @see org.graphstream.stream.ElementSink#edgeAdded(java.lang.String, long, + * java.lang.String, java.lang.String, java.lang.String, boolean) + */ + public void edgeAdded(String sourceId, long timeId, String edgeId, + String fromNodeId, String toNodeId, boolean directed) { + + if (!sourceId.equals(this.sourceId)) { + this.sourceId = sourceId; + sourceIdBuff = sourceId.getBytes(Charset.forName("UTF-8")); + } + byte[] edgeIdArray = edgeId.getBytes(Charset.forName("UTF-8")); + byte[] fromNodeIdArray = fromNodeId.getBytes(Charset.forName("UTF-8")); + byte[] toNodeIdArray = toNodeId.getBytes(Charset.forName("UTF-8")); + + ByteBuffer buff = ByteBuffer.allocate(4 + streamIdArray.length + // stream + // id + 1 + // CMD + 4 + sourceIdBuff.length + // source id + 8 + // timeId + 4 + edgeIdArray.length + // edge + 4 + fromNodeIdArray.length + // node from + 4 + toNodeIdArray.length + // node to + 1 // direction + ); + buff.putInt(streamIdArray.length) + .put(streamIdArray) + // Stream ID + .put((byte) NetStreamConstants.EVENT_ADD_EDGE) + .putInt(sourceIdBuff.length).put(sourceIdBuff).putLong(timeId) + .putInt(edgeIdArray.length).put(edgeIdArray) + .putInt(fromNodeIdArray.length).put(fromNodeIdArray) + .putInt(toNodeIdArray.length).put(toNodeIdArray) + .put((byte) (!directed ? 0 : 1)); + + doSend(buff); + + } + + /* + * (non-Javadoc) + * + * @see org.graphstream.stream.ElementSink#edgeRemoved(java.lang.String, + * long, java.lang.String) + */ + public void edgeRemoved(String sourceId, long timeId, String edgeId) { + + if (!sourceId.equals(this.sourceId)) { + this.sourceId = sourceId; + sourceIdBuff = sourceId.getBytes(Charset.forName("UTF-8")); + } + byte[] edgeIdArray = edgeId.getBytes(Charset.forName("UTF-8")); + + ByteBuffer buff = ByteBuffer.allocate(4 + streamIdArray.length + // stream + 1 + // CMD + 4 + sourceIdBuff.length + // source id + 8 + // timeId + 4 + edgeIdArray.length // edge + ); + buff.putInt(streamIdArray.length) + .put(streamIdArray) + // Stream ID + .put((byte) NetStreamConstants.EVENT_DEL_EDGE) + .putInt(sourceIdBuff.length).put(sourceIdBuff).putLong(timeId) + .putInt(edgeIdArray.length).put(edgeIdArray); + + doSend(buff); + + } + + /* + * (non-Javadoc) + * + * @see org.graphstream.stream.ElementSink#graphCleared(java.lang.String, + * long) + */ + public void graphCleared(String sourceId, long timeId) { + + if (!sourceId.equals(this.sourceId)) { + this.sourceId = sourceId; + sourceIdBuff = sourceId.getBytes(Charset.forName("UTF-8")); + } + ByteBuffer buff = ByteBuffer.allocate(4 + streamIdArray.length + // stream + // id + 1 + // CMD + 4 + sourceIdBuff.length + // source id + 8 // timeId + ); + buff.putInt(streamIdArray.length).put(streamIdArray) + // Stream id + .put((byte) NetStreamConstants.EVENT_CLEARED) + .putInt(sourceIdBuff.length).put(sourceIdBuff).putLong(timeId); + + doSend(buff); + + } + + /* + * (non-Javadoc) + * + * @see org.graphstream.stream.ElementSink#stepBegins(java.lang.String, + * long, double) + */ + public void stepBegins(String sourceId, long timeId, double step) { + + if (!sourceId.equals(this.sourceId)) { + this.sourceId = sourceId; + sourceIdBuff = sourceId.getBytes(Charset.forName("UTF-8")); + } + ByteBuffer buff = ByteBuffer.allocate(4 + streamIdArray.length + // stream + // id + 1 + // CMD + 4 + sourceIdBuff.length + // source id + 8 + // timeId + 8 // time + ); + buff.putInt(streamIdArray.length) + .put(streamIdArray) + // Stream + .put((byte) NetStreamConstants.EVENT_STEP) + .putInt(sourceIdBuff.length).put(sourceIdBuff).putLong(timeId) + .putDouble(step); + + doSend(buff); + } + + /** + * Force the connection to close (properly) with the server + * + * @throws IOException + */ + public void close() throws IOException { + socket.close(); + } + +} diff --git a/java/src/org/netstream/packing/Base64.java b/java/src/org/netstream/packing/Base64.java new file mode 100644 index 0000000..c9a0248 --- /dev/null +++ b/java/src/org/netstream/packing/Base64.java @@ -0,0 +1,2093 @@ +/* + * Copyright 2006 - 2012 + * Stefan Balev + * Julien Baudry + * Antoine Dutot + * Yoann Pigné + * Guilhelm Savin + * + * GraphStream is a library whose purpose is to handle static or dynamic + * graph, create them from scratch, file or any source and display them. + * + * This program is free software distributed under the terms of two licenses, the + * CeCILL-C license that fits European law, and the GNU Lesser General Public + * License. You can use, modify and/ or redistribute the software under the terms + * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following + * URL or under the terms of the GNU LGPL as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * 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 Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program. If not, see . + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms. + */ +package org.netstream.packing; +/** + *

Encodes and decodes to and from Base64 notation.

+ *

Homepage: http://iharder.net/base64.

+ * + *

Example:

+ * + * String encoded = Base64.encode( myByteArray ); + *
+ * byte[] myByteArray = Base64.decode( encoded ); + * + *

The options parameter, which appears in a few places, is used to pass + * several pieces of information to the encoder. In the "higher level" methods such as + * encodeBytes( bytes, options ) the options parameter can be used to indicate such + * things as first gzipping the bytes before encoding them, not inserting linefeeds, + * and encoding using the URL-safe and Ordered dialects.

+ * + *

Note, according to RFC3548, + * Section 2.1, implementations should not add line feeds unless explicitly told + * to do so. I've got Base64 set to this behavior now, although earlier versions + * broke lines by default.

+ * + *

The constants defined in Base64 can be OR-ed together to combine options, so you + * might make a call like this:

+ * + * String encoded = Base64.encodeBytes( mybytes, Base64.GZIP | Base64.DO_BREAK_LINES ); + *

to compress the data before encoding it and then making the output have newline characters.

+ *

Also...

+ * String encoded = Base64.encodeBytes( crazyString.getBytes() ); + * + * + * + *

+ * Change Log: + *

+ *
    + *
  • v2.3.7 - Fixed subtle bug when base 64 input stream contained the + * value 01111111, which is an invalid base 64 character but should not + * throw an ArrayIndexOutOfBoundsException either. Led to discovery of + * mishandling (or potential for better handling) of other bad input + * characters. You should now get an IOException if you try decoding + * something that has bad characters in it.
    • + *
  • v2.3.6 - Fixed bug when breaking lines and the final byte of the encoded + * string ended in the last column; the buffer was not properly shrunk and + * contained an extra (null) byte that made it into the string.
    • + *
  • v2.3.5 - Fixed bug in {@link #encodeFromFile} where estimated buffer size + * was wrong for files of size 31, 34, and 37 bytes.
    • + *
  • v2.3.4 - Fixed bug when working with gzipped streams whereby flushing + * the Base64.OutputStream closed the Base64 encoding (by padding with equals + * signs) too soon. Also added an option to suppress the automatic decoding + * of gzipped streams. Also added experimental support for specifying a + * class loader when using the + * {@link #decodeToObject(java.lang.String, int, java.lang.ClassLoader)} + * method.
    • + *
  • v2.3.3 - Changed default char encoding to US-ASCII which reduces the internal Java + * footprint with its CharEncoders and so forth. Fixed some javadocs that were + * inconsistent. Removed imports and specified things like java.io.IOException + * explicitly inline.
    • + *
  • v2.3.2 - Reduced memory footprint! Finally refined the "guessing" of how big the + * final encoded data will be so that the code doesn't have to create two output + * arrays: an oversized initial one and then a final, exact-sized one. Big win + * when using the {@link #encodeBytesToBytes(byte[])} family of methods (and not + * using the gzip options which uses a different mechanism with streams and stuff).
    • + *
  • v2.3.1 - Added {@link #encodeBytesToBytes(byte[], int, int, int)} and some + * similar helper methods to be more efficient with memory by not returning a + * String but just a byte array.
    • + *
  • v2.3 - This is not a drop-in replacement! This is two years of comments + * and bug fixes queued up and finally executed. Thanks to everyone who sent + * me stuff, and I'm sorry I wasn't able to distribute your fixes to everyone else. + * Much bad coding was cleaned up including throwing exceptions where necessary + * instead of returning null values or something similar. Here are some changes + * that may affect you: + *
      + *
    • Does not break lines, by default. This is to keep in compliance with + * RFC3548.
      • + *
    • Throws exceptions instead of returning null values. Because some operations + * (especially those that may permit the GZIP option) use IO streams, there + * is a possiblity of an java.io.IOException being thrown. After some discussion and + * thought, I've changed the behavior of the methods to throw java.io.IOExceptions + * rather than return null if ever there's an error. I think this is more + * appropriate, though it will require some changes to your code. Sorry, + * it should have been done this way to begin with.
      • + *
    • Removed all references to System.out, System.err, and the like. + * Shame on me. All I can say is sorry they were ever there.
      • + *
    • Throws NullPointerExceptions and IllegalArgumentExceptions as needed + * such as when passed arrays are null or offsets are invalid.
      • + *
    • Cleaned up as much javadoc as I could to avoid any javadoc warnings. + * This was especially annoying before for people who were thorough in their + * own projects and then had gobs of javadoc warnings on this file.
      • + *
    + *
  • v2.2.1 - Fixed bug using URL_SAFE and ORDERED encodings. Fixed bug + * when using very small files (~< 40 bytes).
    • + *
  • v2.2 - Added some helper methods for encoding/decoding directly from + * one file to the next. Also added a main() method to support command line + * encoding/decoding from one file to the next. Also added these Base64 dialects: + *
      + *
    1. The default is RFC3548 format.
      2. + *
    2. Calling Base64.setFormat(Base64.BASE64_FORMAT.URLSAFE_FORMAT) generates + * URL and file name friendly format as described in Section 4 of RFC3548. + * http://www.faqs.org/rfcs/rfc3548.html
      3. + *
    3. Calling Base64.setFormat(Base64.BASE64_FORMAT.ORDERED_FORMAT) generates + * URL and file name friendly format that preserves lexical ordering as described + * in http://www.faqs.org/qa/rfcc-1940.html
      4. + *
    + * Special thanks to Jim Kellerman at http://www.powerset.com/ + * for contributing the new Base64 dialects. + *
    • + * + *
  • v2.1 - Cleaned up javadoc comments and unused variables and methods. Added + * some convenience methods for reading and writing to and from files.
    • + *
  • v2.0.2 - Now specifies UTF-8 encoding in places where the code fails on systems + * with other encodings (like EBCDIC).
    • + *
  • v2.0.1 - Fixed an error when decoding a single byte, that is, when the + * encoded data was a single byte.
    • + *
  • v2.0 - I got rid of methods that used booleans to set options. + * Now everything is more consolidated and cleaner. The code now detects + * when data that's being decoded is gzip-compressed and will decompress it + * automatically. Generally things are cleaner. You'll probably have to + * change some method calls that you were making to support the new + * options format (ints that you "OR" together).
    • + *
  • v1.5.1 - Fixed bug when decompressing and decoding to a + * byte[] using decode( String s, boolean gzipCompressed ). + * Added the ability to "suspend" encoding in the Output Stream so + * you can turn on and off the encoding if you need to embed base64 + * data in an otherwise "normal" stream (like an XML file).
    • + *
  • v1.5 - Output stream pases on flush() command but doesn't do anything itself. + * This helps when using GZIP streams. + * Added the ability to GZip-compress objects before encoding them.
    • + *
  • v1.4 - Added helper methods to read/write files.
    • + *
  • v1.3.6 - Fixed OutputStream.flush() so that 'position' is reset.
    • + *
  • v1.3.5 - Added flag to turn on and off line breaks. Fixed bug in input stream + * where last buffer being read, if not completely full, was not returned.
    • + *
  • v1.3.4 - Fixed when "improperly padded stream" error was thrown at the wrong time.
    • + *
  • v1.3.3 - Fixed I/O streams which were totally messed up.
    • + *
+ * + *

+ * I am placing this code in the Public Domain. Do with it as you will. + * This software comes with no guarantees or warranties but with + * plenty of well-wishing instead! + * Please visit http://iharder.net/base64 + * periodically to check for updates or to contribute improvements. + *

+ * + * @author Robert Harder + * @author rob@iharder.net + * @version 2.3.7 + */ +public class Base64 +{ + +/* ******** P U B L I C F I E L D S ******** */ + + + /** No options specified. Value is zero. */ + public final static int NO_OPTIONS = 0; + + /** Specify encoding in first bit. Value is one. */ + public final static int ENCODE = 1; + + + /** Specify decoding in first bit. Value is zero. */ + public final static int DECODE = 0; + + + /** Specify that data should be gzip-compressed in second bit. Value is two. */ + public final static int GZIP = 2; + + /** Specify that gzipped data should not be automatically gunzipped. */ + public final static int DONT_GUNZIP = 4; + + + /** Do break lines when encoding. Value is 8. */ + public final static int DO_BREAK_LINES = 8; + + /** + * Encode using Base64-like encoding that is URL- and Filename-safe as described + * in Section 4 of RFC3548: + * http://www.faqs.org/rfcs/rfc3548.html. + * It is important to note that data encoded this way is not officially valid Base64, + * or at the very least should not be called Base64 without also specifying that is + * was encoded using the URL- and Filename-safe dialect. + */ + public final static int URL_SAFE = 16; + + + /** + * Encode using the special "ordered" dialect of Base64 described here: + * http://www.faqs.org/qa/rfcc-1940.html. + */ + public final static int ORDERED = 32; + + +/* ******** P R I V A T E F I E L D S ******** */ + + + /** Maximum line length (76) of Base64 output. */ + private final static int MAX_LINE_LENGTH = 76; + + + /** The equals sign (=) as a byte. */ + private final static byte EQUALS_SIGN = (byte)'='; + + + /** The new line character (\n) as a byte. */ + private final static byte NEW_LINE = (byte)'\n'; + + + /** Preferred encoding. */ + private final static String PREFERRED_ENCODING = "US-ASCII"; + + + private final static byte WHITE_SPACE_ENC = -5; // Indicates white space in encoding + private final static byte EQUALS_SIGN_ENC = -1; // Indicates equals sign in encoding + + +/* ******** S T A N D A R D B A S E 6 4 A L P H A B E T ******** */ + + /** The 64 valid Base64 values. */ + /* Host platform me be something funny like EBCDIC, so we hardcode these values. */ + private final static byte[] _STANDARD_ALPHABET = { + (byte)'A', (byte)'B', (byte)'C', (byte)'D', (byte)'E', (byte)'F', (byte)'G', + (byte)'H', (byte)'I', (byte)'J', (byte)'K', (byte)'L', (byte)'M', (byte)'N', + (byte)'O', (byte)'P', (byte)'Q', (byte)'R', (byte)'S', (byte)'T', (byte)'U', + (byte)'V', (byte)'W', (byte)'X', (byte)'Y', (byte)'Z', + (byte)'a', (byte)'b', (byte)'c', (byte)'d', (byte)'e', (byte)'f', (byte)'g', + (byte)'h', (byte)'i', (byte)'j', (byte)'k', (byte)'l', (byte)'m', (byte)'n', + (byte)'o', (byte)'p', (byte)'q', (byte)'r', (byte)'s', (byte)'t', (byte)'u', + (byte)'v', (byte)'w', (byte)'x', (byte)'y', (byte)'z', + (byte)'0', (byte)'1', (byte)'2', (byte)'3', (byte)'4', (byte)'5', + (byte)'6', (byte)'7', (byte)'8', (byte)'9', (byte)'+', (byte)'/' + }; + + + /** + * Translates a Base64 value to either its 6-bit reconstruction value + * or a negative number indicating some other meaning. + **/ + private final static byte[] _STANDARD_DECODABET = { + -9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 0 - 8 + -5,-5, // Whitespace: Tab and Linefeed + -9,-9, // Decimal 11 - 12 + -5, // Whitespace: Carriage Return + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 14 - 26 + -9,-9,-9,-9,-9, // Decimal 27 - 31 + -5, // Whitespace: Space + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 33 - 42 + 62, // Plus sign at decimal 43 + -9,-9,-9, // Decimal 44 - 46 + 63, // Slash at decimal 47 + 52,53,54,55,56,57,58,59,60,61, // Numbers zero through nine + -9,-9,-9, // Decimal 58 - 60 + -1, // Equals sign at decimal 61 + -9,-9,-9, // Decimal 62 - 64 + 0,1,2,3,4,5,6,7,8,9,10,11,12,13, // Letters 'A' through 'N' + 14,15,16,17,18,19,20,21,22,23,24,25, // Letters 'O' through 'Z' + -9,-9,-9,-9,-9,-9, // Decimal 91 - 96 + 26,27,28,29,30,31,32,33,34,35,36,37,38, // Letters 'a' through 'm' + 39,40,41,42,43,44,45,46,47,48,49,50,51, // Letters 'n' through 'z' + -9,-9,-9,-9,-9 // Decimal 123 - 127 + ,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 128 - 139 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 140 - 152 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 153 - 165 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 166 - 178 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 179 - 191 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 192 - 204 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 205 - 217 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 218 - 230 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 231 - 243 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9 // Decimal 244 - 255 + }; + + +/* ******** U R L S A F E B A S E 6 4 A L P H A B E T ******** */ + + /** + * Used in the URL- and Filename-safe dialect described in Section 4 of RFC3548: + * http://www.faqs.org/rfcs/rfc3548.html. + * Notice that the last two bytes become "hyphen" and "underscore" instead of "plus" and "slash." + */ + private final static byte[] _URL_SAFE_ALPHABET = { + (byte)'A', (byte)'B', (byte)'C', (byte)'D', (byte)'E', (byte)'F', (byte)'G', + (byte)'H', (byte)'I', (byte)'J', (byte)'K', (byte)'L', (byte)'M', (byte)'N', + (byte)'O', (byte)'P', (byte)'Q', (byte)'R', (byte)'S', (byte)'T', (byte)'U', + (byte)'V', (byte)'W', (byte)'X', (byte)'Y', (byte)'Z', + (byte)'a', (byte)'b', (byte)'c', (byte)'d', (byte)'e', (byte)'f', (byte)'g', + (byte)'h', (byte)'i', (byte)'j', (byte)'k', (byte)'l', (byte)'m', (byte)'n', + (byte)'o', (byte)'p', (byte)'q', (byte)'r', (byte)'s', (byte)'t', (byte)'u', + (byte)'v', (byte)'w', (byte)'x', (byte)'y', (byte)'z', + (byte)'0', (byte)'1', (byte)'2', (byte)'3', (byte)'4', (byte)'5', + (byte)'6', (byte)'7', (byte)'8', (byte)'9', (byte)'-', (byte)'_' + }; + + /** + * Used in decoding URL- and Filename-safe dialects of Base64. + */ + private final static byte[] _URL_SAFE_DECODABET = { + -9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 0 - 8 + -5,-5, // Whitespace: Tab and Linefeed + -9,-9, // Decimal 11 - 12 + -5, // Whitespace: Carriage Return + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 14 - 26 + -9,-9,-9,-9,-9, // Decimal 27 - 31 + -5, // Whitespace: Space + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 33 - 42 + -9, // Plus sign at decimal 43 + -9, // Decimal 44 + 62, // Minus sign at decimal 45 + -9, // Decimal 46 + -9, // Slash at decimal 47 + 52,53,54,55,56,57,58,59,60,61, // Numbers zero through nine + -9,-9,-9, // Decimal 58 - 60 + -1, // Equals sign at decimal 61 + -9,-9,-9, // Decimal 62 - 64 + 0,1,2,3,4,5,6,7,8,9,10,11,12,13, // Letters 'A' through 'N' + 14,15,16,17,18,19,20,21,22,23,24,25, // Letters 'O' through 'Z' + -9,-9,-9,-9, // Decimal 91 - 94 + 63, // Underscore at decimal 95 + -9, // Decimal 96 + 26,27,28,29,30,31,32,33,34,35,36,37,38, // Letters 'a' through 'm' + 39,40,41,42,43,44,45,46,47,48,49,50,51, // Letters 'n' through 'z' + -9,-9,-9,-9,-9 // Decimal 123 - 127 + ,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 128 - 139 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 140 - 152 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 153 - 165 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 166 - 178 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 179 - 191 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 192 - 204 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 205 - 217 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 218 - 230 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 231 - 243 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9 // Decimal 244 - 255 + }; + + + +/* ******** O R D E R E D B A S E 6 4 A L P H A B E T ******** */ + + /** + * I don't get the point of this technique, but someone requested it, + * and it is described here: + * http://www.faqs.org/qa/rfcc-1940.html. + */ + private final static byte[] _ORDERED_ALPHABET = { + (byte)'-', + (byte)'0', (byte)'1', (byte)'2', (byte)'3', (byte)'4', + (byte)'5', (byte)'6', (byte)'7', (byte)'8', (byte)'9', + (byte)'A', (byte)'B', (byte)'C', (byte)'D', (byte)'E', (byte)'F', (byte)'G', + (byte)'H', (byte)'I', (byte)'J', (byte)'K', (byte)'L', (byte)'M', (byte)'N', + (byte)'O', (byte)'P', (byte)'Q', (byte)'R', (byte)'S', (byte)'T', (byte)'U', + (byte)'V', (byte)'W', (byte)'X', (byte)'Y', (byte)'Z', + (byte)'_', + (byte)'a', (byte)'b', (byte)'c', (byte)'d', (byte)'e', (byte)'f', (byte)'g', + (byte)'h', (byte)'i', (byte)'j', (byte)'k', (byte)'l', (byte)'m', (byte)'n', + (byte)'o', (byte)'p', (byte)'q', (byte)'r', (byte)'s', (byte)'t', (byte)'u', + (byte)'v', (byte)'w', (byte)'x', (byte)'y', (byte)'z' + }; + + /** + * Used in decoding the "ordered" dialect of Base64. + */ + private final static byte[] _ORDERED_DECODABET = { + -9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 0 - 8 + -5,-5, // Whitespace: Tab and Linefeed + -9,-9, // Decimal 11 - 12 + -5, // Whitespace: Carriage Return + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 14 - 26 + -9,-9,-9,-9,-9, // Decimal 27 - 31 + -5, // Whitespace: Space + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 33 - 42 + -9, // Plus sign at decimal 43 + -9, // Decimal 44 + 0, // Minus sign at decimal 45 + -9, // Decimal 46 + -9, // Slash at decimal 47 + 1,2,3,4,5,6,7,8,9,10, // Numbers zero through nine + -9,-9,-9, // Decimal 58 - 60 + -1, // Equals sign at decimal 61 + -9,-9,-9, // Decimal 62 - 64 + 11,12,13,14,15,16,17,18,19,20,21,22,23, // Letters 'A' through 'M' + 24,25,26,27,28,29,30,31,32,33,34,35,36, // Letters 'N' through 'Z' + -9,-9,-9,-9, // Decimal 91 - 94 + 37, // Underscore at decimal 95 + -9, // Decimal 96 + 38,39,40,41,42,43,44,45,46,47,48,49,50, // Letters 'a' through 'm' + 51,52,53,54,55,56,57,58,59,60,61,62,63, // Letters 'n' through 'z' + -9,-9,-9,-9,-9 // Decimal 123 - 127 + ,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 128 - 139 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 140 - 152 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 153 - 165 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 166 - 178 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 179 - 191 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 192 - 204 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 205 - 217 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 218 - 230 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 231 - 243 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9 // Decimal 244 - 255 + }; + + +/* ******** D E T E R M I N E W H I C H A L H A B E T ******** */ + + + /** + * Returns one of the _SOMETHING_ALPHABET byte arrays depending on + * the options specified. + * It's possible, though silly, to specify ORDERED and URLSAFE + * in which case one of them will be picked, though there is + * no guarantee as to which one will be picked. + */ + private final static byte[] getAlphabet( int options ) { + if ((options & URL_SAFE) == URL_SAFE) { + return _URL_SAFE_ALPHABET; + } else if ((options & ORDERED) == ORDERED) { + return _ORDERED_ALPHABET; + } else { + return _STANDARD_ALPHABET; + } + } // end getAlphabet + + + /** + * Returns one of the _SOMETHING_DECODABET byte arrays depending on + * the options specified. + * It's possible, though silly, to specify ORDERED and URL_SAFE + * in which case one of them will be picked, though there is + * no guarantee as to which one will be picked. + */ + private final static byte[] getDecodabet( int options ) { + if( (options & URL_SAFE) == URL_SAFE) { + return _URL_SAFE_DECODABET; + } else if ((options & ORDERED) == ORDERED) { + return _ORDERED_DECODABET; + } else { + return _STANDARD_DECODABET; + } + } // end getAlphabet + + + + /** Defeats instantiation. */ + private Base64(){} + + + + +/* ******** E N C O D I N G M E T H O D S ******** */ + + + /** + * Encodes up to the first three bytes of array threeBytes + * and returns a four-byte array in Base64 notation. + * The actual number of significant bytes in your array is + * given by numSigBytes. + * The array threeBytes needs only be as big as + * numSigBytes. + * Code can reuse a byte array by passing a four-byte array as b4. + * + * @param b4 A reusable byte array to reduce array instantiation + * @param threeBytes the array to convert + * @param numSigBytes the number of significant bytes in your array + * @return four byte array in Base64 notation. + * @since 1.5.1 + */ + private static byte[] encode3to4( byte[] b4, byte[] threeBytes, int numSigBytes, int options ) { + encode3to4( threeBytes, 0, numSigBytes, b4, 0, options ); + return b4; + } // end encode3to4 + + + /** + *

Encodes up to three bytes of the array source + * and writes the resulting four Base64 bytes to destination. + * The source and destination arrays can be manipulated + * anywhere along their length by specifying + * srcOffset and destOffset. + * This method does not check to make sure your arrays + * are large enough to accomodate srcOffset + 3 for + * the source array or destOffset + 4 for + * the destination array. + * The actual number of significant bytes in your array is + * given by numSigBytes.

+ *

This is the lowest level of the encoding methods with + * all possible parameters.

+ * + * @param source the array to convert + * @param srcOffset the index where conversion begins + * @param numSigBytes the number of significant bytes in your array + * @param destination the array to hold the conversion + * @param destOffset the index where output will be put + * @return the destination array + * @since 1.3 + */ + private static byte[] encode3to4( + byte[] source, int srcOffset, int numSigBytes, + byte[] destination, int destOffset, int options ) { + + byte[] ALPHABET = getAlphabet( options ); + + // 1 2 3 + // 01234567890123456789012345678901 Bit position + // --------000000001111111122222222 Array position from threeBytes + // --------| || || || | Six bit groups to index ALPHABET + // >>18 >>12 >> 6 >> 0 Right shift necessary + // 0x3f 0x3f 0x3f Additional AND + + // Create buffer with zero-padding if there are only one or two + // significant bytes passed in the array. + // We have to shift left 24 in order to flush out the 1's that appear + // when Java treats a value as negative that is cast from a byte to an int. + int inBuff = ( numSigBytes > 0 ? ((source[ srcOffset ] << 24) >>> 8) : 0 ) + | ( numSigBytes > 1 ? ((source[ srcOffset + 1 ] << 24) >>> 16) : 0 ) + | ( numSigBytes > 2 ? ((source[ srcOffset + 2 ] << 24) >>> 24) : 0 ); + + switch( numSigBytes ) + { + case 3: + destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ]; + destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ]; + destination[ destOffset + 2 ] = ALPHABET[ (inBuff >>> 6) & 0x3f ]; + destination[ destOffset + 3 ] = ALPHABET[ (inBuff ) & 0x3f ]; + return destination; + + case 2: + destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ]; + destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ]; + destination[ destOffset + 2 ] = ALPHABET[ (inBuff >>> 6) & 0x3f ]; + destination[ destOffset + 3 ] = EQUALS_SIGN; + return destination; + + case 1: + destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ]; + destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ]; + destination[ destOffset + 2 ] = EQUALS_SIGN; + destination[ destOffset + 3 ] = EQUALS_SIGN; + return destination; + + default: + return destination; + } // end switch + } // end encode3to4 + + + + /** + * Performs Base64 encoding on the raw ByteBuffer, + * writing it to the encoded ByteBuffer. + * This is an experimental feature. Currently it does not + * pass along any options (such as {@link #DO_BREAK_LINES} + * or {@link #GZIP}. + * + * @param raw input buffer + * @param encoded output buffer + * @since 2.3 + */ + public static void encode( java.nio.ByteBuffer raw, java.nio.ByteBuffer encoded ){ + byte[] raw3 = new byte[3]; + byte[] enc4 = new byte[4]; + + while( raw.hasRemaining() ){ + int rem = Math.min(3,raw.remaining()); + raw.get(raw3,0,rem); + Base64.encode3to4(enc4, raw3, rem, Base64.NO_OPTIONS ); + encoded.put(enc4); + } // end input remaining + } + + + /** + * Performs Base64 encoding on the raw ByteBuffer, + * writing it to the encoded CharBuffer. + * This is an experimental feature. Currently it does not + * pass along any options (such as {@link #DO_BREAK_LINES} + * or {@link #GZIP}. + * + * @param raw input buffer + * @param encoded output buffer + * @since 2.3 + */ + public static void encode( java.nio.ByteBuffer raw, java.nio.CharBuffer encoded ){ + byte[] raw3 = new byte[3]; + byte[] enc4 = new byte[4]; + + while( raw.hasRemaining() ){ + int rem = Math.min(3,raw.remaining()); + raw.get(raw3,0,rem); + Base64.encode3to4(enc4, raw3, rem, Base64.NO_OPTIONS ); + for( int i = 0; i < 4; i++ ){ + encoded.put( (char)(enc4[i] & 0xFF) ); + } + } // end input remaining + } + + + + + /** + * Serializes an object and returns the Base64-encoded + * version of that serialized object. + * + *

As of v 2.3, if the object + * cannot be serialized or there is another error, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned a null value, but + * in retrospect that's a pretty poor way to handle it.

+ * + * The object is not GZip-compressed before being encoded. + * + * @param serializableObject The object to encode + * @return The Base64-encoded object + * @throws java.io.IOException if there is an error + * @throws NullPointerException if serializedObject is null + * @since 1.4 + */ + public static String encodeObject( java.io.Serializable serializableObject ) + throws java.io.IOException { + return encodeObject( serializableObject, NO_OPTIONS ); + } // end encodeObject + + + + /** + * Serializes an object and returns the Base64-encoded + * version of that serialized object. + * + *

As of v 2.3, if the object + * cannot be serialized or there is another error, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned a null value, but + * in retrospect that's a pretty poor way to handle it.

+ * + * The object is not GZip-compressed before being encoded. + *

+ * Example options:

+     *   GZIP: gzip-compresses object before encoding it.
+     *   DO_BREAK_LINES: break lines at 76 characters
+     *
+ *

+ * Example: encodeObject( myObj, Base64.GZIP ) or + *

+ * Example: encodeObject( myObj, Base64.GZIP | Base64.DO_BREAK_LINES ) + * + * @param serializableObject The object to encode + * @param options Specified options + * @return The Base64-encoded object + * @see Base64#GZIP + * @see Base64#DO_BREAK_LINES + * @throws java.io.IOException if there is an error + * @since 2.0 + */ + public static String encodeObject( java.io.Serializable serializableObject, int options ) + throws java.io.IOException { + + if( serializableObject == null ){ + throw new NullPointerException( "Cannot serialize a null object." ); + } // end if: null + + // Streams + java.io.ByteArrayOutputStream baos = null; + java.io.OutputStream b64os = null; + java.util.zip.GZIPOutputStream gzos = null; + java.io.ObjectOutputStream oos = null; + + + try { + // ObjectOutputStream -> (GZIP) -> Base64 -> ByteArrayOutputStream + baos = new java.io.ByteArrayOutputStream(); + b64os = new Base64.OutputStream( baos, ENCODE | options ); + if( (options & GZIP) != 0 ){ + // Gzip + gzos = new java.util.zip.GZIPOutputStream(b64os); + oos = new java.io.ObjectOutputStream( gzos ); + } else { + // Not gzipped + oos = new java.io.ObjectOutputStream( b64os ); + } + oos.writeObject( serializableObject ); + } // end try + catch( java.io.IOException e ) { + // Catch it and then throw it immediately so that + // the finally{} block is called for cleanup. + throw e; + } // end catch + finally { + try{ oos.close(); } catch( Exception e ){} + try{ gzos.close(); } catch( Exception e ){} + try{ b64os.close(); } catch( Exception e ){} + try{ baos.close(); } catch( Exception e ){} + } // end finally + + // Return value according to relevant encoding. + try { + return new String( baos.toByteArray(), PREFERRED_ENCODING ); + } // end try + catch (java.io.UnsupportedEncodingException uue){ + // Fall back to some Java default + return new String( baos.toByteArray() ); + } // end catch + + } // end encode + + + + /** + * Encodes a byte array into Base64 notation. + * Does not GZip-compress data. + * + * @param source The data to convert + * @return The data in Base64-encoded form + * @throws NullPointerException if source array is null + * @since 1.4 + */ + public static String encodeBytes( byte[] source ) { + // Since we're not going to have the GZIP encoding turned on, + // we're not going to have an java.io.IOException thrown, so + // we should not force the user to have to catch it. + String encoded = null; + try { + encoded = encodeBytes(source, 0, source.length, NO_OPTIONS); + } catch (java.io.IOException ex) { + assert false : ex.getMessage(); + } // end catch + assert encoded != null; + return encoded; + } // end encodeBytes + + + + /** + * Encodes a byte array into Base64 notation. + *

+ * Example options:

+     *   GZIP: gzip-compresses object before encoding it.
+     *   DO_BREAK_LINES: break lines at 76 characters
+     *     Note: Technically, this makes your encoding non-compliant.
+     *
+ *

+ * Example: encodeBytes( myData, Base64.GZIP ) or + *

+ * Example: encodeBytes( myData, Base64.GZIP | Base64.DO_BREAK_LINES ) + * + * + *

As of v 2.3, if there is an error with the GZIP stream, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned a null value, but + * in retrospect that's a pretty poor way to handle it.

+ * + * + * @param source The data to convert + * @param options Specified options + * @return The Base64-encoded data as a String + * @see Base64#GZIP + * @see Base64#DO_BREAK_LINES + * @throws java.io.IOException if there is an error + * @throws NullPointerException if source array is null + * @since 2.0 + */ + public static String encodeBytes( byte[] source, int options ) throws java.io.IOException { + return encodeBytes( source, 0, source.length, options ); + } // end encodeBytes + + + /** + * Encodes a byte array into Base64 notation. + * Does not GZip-compress data. + * + *

As of v 2.3, if there is an error, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned a null value, but + * in retrospect that's a pretty poor way to handle it.

+ * + * + * @param source The data to convert + * @param off Offset in array where conversion should begin + * @param len Length of data to convert + * @return The Base64-encoded data as a String + * @throws NullPointerException if source array is null + * @throws IllegalArgumentException if source array, offset, or length are invalid + * @since 1.4 + */ + public static String encodeBytes( byte[] source, int off, int len ) { + // Since we're not going to have the GZIP encoding turned on, + // we're not going to have an java.io.IOException thrown, so + // we should not force the user to have to catch it. + String encoded = null; + try { + encoded = encodeBytes( source, off, len, NO_OPTIONS ); + } catch (java.io.IOException ex) { + assert false : ex.getMessage(); + } // end catch + assert encoded != null; + return encoded; + } // end encodeBytes + + + + /** + * Encodes a byte array into Base64 notation. + *

+ * Example options:

+     *   GZIP: gzip-compresses object before encoding it.
+     *   DO_BREAK_LINES: break lines at 76 characters
+     *     Note: Technically, this makes your encoding non-compliant.
+     *
+ *

+ * Example: encodeBytes( myData, Base64.GZIP ) or + *

+ * Example: encodeBytes( myData, Base64.GZIP | Base64.DO_BREAK_LINES ) + * + * + *

As of v 2.3, if there is an error with the GZIP stream, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned a null value, but + * in retrospect that's a pretty poor way to handle it.

+ * + * + * @param source The data to convert + * @param off Offset in array where conversion should begin + * @param len Length of data to convert + * @param options Specified options + * @return The Base64-encoded data as a String + * @see Base64#GZIP + * @see Base64#DO_BREAK_LINES + * @throws java.io.IOException if there is an error + * @throws NullPointerException if source array is null + * @throws IllegalArgumentException if source array, offset, or length are invalid + * @since 2.0 + */ + public static String encodeBytes( byte[] source, int off, int len, int options ) throws java.io.IOException { + byte[] encoded = encodeBytesToBytes( source, off, len, options ); + + // Return value according to relevant encoding. + try { + return new String( encoded, PREFERRED_ENCODING ); + } // end try + catch (java.io.UnsupportedEncodingException uue) { + return new String( encoded ); + } // end catch + + } // end encodeBytes + + + + + /** + * Similar to {@link #encodeBytes(byte[])} but returns + * a byte array instead of instantiating a String. This is more efficient + * if you're working with I/O streams and have large data sets to encode. + * + * + * @param source The data to convert + * @return The Base64-encoded data as a byte[] (of ASCII characters) + * @throws NullPointerException if source array is null + * @since 2.3.1 + */ + public static byte[] encodeBytesToBytes( byte[] source ) { + byte[] encoded = null; + try { + encoded = encodeBytesToBytes( source, 0, source.length, Base64.NO_OPTIONS ); + } catch( java.io.IOException ex ) { + assert false : "IOExceptions only come from GZipping, which is turned off: " + ex.getMessage(); + } + return encoded; + } + + + /** + * Similar to {@link #encodeBytes(byte[], int, int, int)} but returns + * a byte array instead of instantiating a String. This is more efficient + * if you're working with I/O streams and have large data sets to encode. + * + * + * @param source The data to convert + * @param off Offset in array where conversion should begin + * @param len Length of data to convert + * @param options Specified options + * @return The Base64-encoded data as a String + * @see Base64#GZIP + * @see Base64#DO_BREAK_LINES + * @throws java.io.IOException if there is an error + * @throws NullPointerException if source array is null + * @throws IllegalArgumentException if source array, offset, or length are invalid + * @since 2.3.1 + */ + public static byte[] encodeBytesToBytes( byte[] source, int off, int len, int options ) throws java.io.IOException { + + if( source == null ){ + throw new NullPointerException( "Cannot serialize a null array." ); + } // end if: null + + if( off < 0 ){ + throw new IllegalArgumentException( "Cannot have negative offset: " + off ); + } // end if: off < 0 + + if( len < 0 ){ + throw new IllegalArgumentException( "Cannot have length offset: " + len ); + } // end if: len < 0 + + if( off + len > source.length ){ + throw new IllegalArgumentException( + String.format( "Cannot have offset of %d and length of %d with array of length %d", off,len,source.length)); + } // end if: off < 0 + + + + // Compress? + if( (options & GZIP) != 0 ) { + java.io.ByteArrayOutputStream baos = null; + java.util.zip.GZIPOutputStream gzos = null; + Base64.OutputStream b64os = null; + + try { + // GZip -> Base64 -> ByteArray + baos = new java.io.ByteArrayOutputStream(); + b64os = new Base64.OutputStream( baos, ENCODE | options ); + gzos = new java.util.zip.GZIPOutputStream( b64os ); + + gzos.write( source, off, len ); + gzos.close(); + } // end try + catch( java.io.IOException e ) { + // Catch it and then throw it immediately so that + // the finally{} block is called for cleanup. + throw e; + } // end catch + finally { + try{ gzos.close(); } catch( Exception e ){} + try{ b64os.close(); } catch( Exception e ){} + try{ baos.close(); } catch( Exception e ){} + } // end finally + + return baos.toByteArray(); + } // end if: compress + + // Else, don't compress. Better not to use streams at all then. + else { + boolean breakLines = (options & DO_BREAK_LINES) != 0; + + //int len43 = len * 4 / 3; + //byte[] outBuff = new byte[ ( len43 ) // Main 4:3 + // + ( (len % 3) > 0 ? 4 : 0 ) // Account for padding + // + (breakLines ? ( len43 / MAX_LINE_LENGTH ) : 0) ]; // New lines + // Try to determine more precisely how big the array needs to be. + // If we get it right, we don't have to do an array copy, and + // we save a bunch of memory. + int encLen = ( len / 3 ) * 4 + ( len % 3 > 0 ? 4 : 0 ); // Bytes needed for actual encoding + if( breakLines ){ + encLen += encLen / MAX_LINE_LENGTH; // Plus extra newline characters + } + byte[] outBuff = new byte[ encLen ]; + + + int d = 0; + int e = 0; + int len2 = len - 2; + int lineLength = 0; + for( ; d < len2; d+=3, e+=4 ) { + encode3to4( source, d+off, 3, outBuff, e, options ); + + lineLength += 4; + if( breakLines && lineLength >= MAX_LINE_LENGTH ) + { + outBuff[e+4] = NEW_LINE; + e++; + lineLength = 0; + } // end if: end of line + } // en dfor: each piece of array + + if( d < len ) { + encode3to4( source, d+off, len - d, outBuff, e, options ); + e += 4; + } // end if: some padding needed + + + // Only resize array if we didn't guess it right. + if( e <= outBuff.length - 1 ){ + // If breaking lines and the last byte falls right at + // the line length (76 bytes per line), there will be + // one extra byte, and the array will need to be resized. + // Not too bad of an estimate on array size, I'd say. + byte[] finalOut = new byte[e]; + System.arraycopy(outBuff,0, finalOut,0,e); + //System.err.println("Having to resize array from " + outBuff.length + " to " + e ); + return finalOut; + } else { + //System.err.println("No need to resize array."); + return outBuff; + } + + } // end else: don't compress + + } // end encodeBytesToBytes + + + + + +/* ******** D E C O D I N G M E T H O D S ******** */ + + + /** + * Decodes four bytes from array source + * and writes the resulting bytes (up to three of them) + * to destination. + * The source and destination arrays can be manipulated + * anywhere along their length by specifying + * srcOffset and destOffset. + * This method does not check to make sure your arrays + * are large enough to accomodate srcOffset + 4 for + * the source array or destOffset + 3 for + * the destination array. + * This method returns the actual number of bytes that + * were converted from the Base64 encoding. + *

This is the lowest level of the decoding methods with + * all possible parameters.

+ * + * + * @param source the array to convert + * @param srcOffset the index where conversion begins + * @param destination the array to hold the conversion + * @param destOffset the index where output will be put + * @param options alphabet type is pulled from this (standard, url-safe, ordered) + * @return the number of decoded bytes converted + * @throws NullPointerException if source or destination arrays are null + * @throws IllegalArgumentException if srcOffset or destOffset are invalid + * or there is not enough room in the array. + * @since 1.3 + */ + private static int decode4to3( + byte[] source, int srcOffset, + byte[] destination, int destOffset, int options ) { + + // Lots of error checking and exception throwing + if( source == null ){ + throw new NullPointerException( "Source array was null." ); + } // end if + if( destination == null ){ + throw new NullPointerException( "Destination array was null." ); + } // end if + if( srcOffset < 0 || srcOffset + 3 >= source.length ){ + throw new IllegalArgumentException( String.format( + "Source array with length %d cannot have offset of %d and still process four bytes.", source.length, srcOffset ) ); + } // end if + if( destOffset < 0 || destOffset +2 >= destination.length ){ + throw new IllegalArgumentException( String.format( + "Destination array with length %d cannot have offset of %d and still store three bytes.", destination.length, destOffset ) ); + } // end if + + + byte[] DECODABET = getDecodabet( options ); + + // Example: Dk== + if( source[ srcOffset + 2] == EQUALS_SIGN ) { + // Two ways to do the same thing. Don't know which way I like best. + //int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 ) + // | ( ( DECODABET[ source[ srcOffset + 1] ] << 24 ) >>> 12 ); + int outBuff = ( ( DECODABET[ source[ srcOffset ] ] & 0xFF ) << 18 ) + | ( ( DECODABET[ source[ srcOffset + 1] ] & 0xFF ) << 12 ); + + destination[ destOffset ] = (byte)( outBuff >>> 16 ); + return 1; + } + + // Example: DkL= + else if( source[ srcOffset + 3 ] == EQUALS_SIGN ) { + // Two ways to do the same thing. Don't know which way I like best. + //int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 ) + // | ( ( DECODABET[ source[ srcOffset + 1 ] ] << 24 ) >>> 12 ) + // | ( ( DECODABET[ source[ srcOffset + 2 ] ] << 24 ) >>> 18 ); + int outBuff = ( ( DECODABET[ source[ srcOffset ] ] & 0xFF ) << 18 ) + | ( ( DECODABET[ source[ srcOffset + 1 ] ] & 0xFF ) << 12 ) + | ( ( DECODABET[ source[ srcOffset + 2 ] ] & 0xFF ) << 6 ); + + destination[ destOffset ] = (byte)( outBuff >>> 16 ); + destination[ destOffset + 1 ] = (byte)( outBuff >>> 8 ); + return 2; + } + + // Example: DkLE + else { + // Two ways to do the same thing. Don't know which way I like best. + //int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 ) + // | ( ( DECODABET[ source[ srcOffset + 1 ] ] << 24 ) >>> 12 ) + // | ( ( DECODABET[ source[ srcOffset + 2 ] ] << 24 ) >>> 18 ) + // | ( ( DECODABET[ source[ srcOffset + 3 ] ] << 24 ) >>> 24 ); + int outBuff = ( ( DECODABET[ source[ srcOffset ] ] & 0xFF ) << 18 ) + | ( ( DECODABET[ source[ srcOffset + 1 ] ] & 0xFF ) << 12 ) + | ( ( DECODABET[ source[ srcOffset + 2 ] ] & 0xFF ) << 6) + | ( ( DECODABET[ source[ srcOffset + 3 ] ] & 0xFF ) ); + + + destination[ destOffset ] = (byte)( outBuff >> 16 ); + destination[ destOffset + 1 ] = (byte)( outBuff >> 8 ); + destination[ destOffset + 2 ] = (byte)( outBuff ); + + return 3; + } + } // end decodeToBytes + + + + + + /** + * Low-level access to decoding ASCII characters in + * the form of a byte array. Ignores GUNZIP option, if + * it's set. This is not generally a recommended method, + * although it is used internally as part of the decoding process. + * Special case: if len = 0, an empty array is returned. Still, + * if you need more speed and reduced memory footprint (and aren't + * gzipping), consider this method. + * + * @param source The Base64 encoded data + * @return decoded data + * @since 2.3.1 + */ + public static byte[] decode( byte[] source ) + throws java.io.IOException { + byte[] decoded = null; +// try { + decoded = decode( source, 0, source.length, Base64.NO_OPTIONS ); +// } catch( java.io.IOException ex ) { +// assert false : "IOExceptions only come from GZipping, which is turned off: " + ex.getMessage(); +// } + return decoded; + } + + + + /** + * Low-level access to decoding ASCII characters in + * the form of a byte array. Ignores GUNZIP option, if + * it's set. This is not generally a recommended method, + * although it is used internally as part of the decoding process. + * Special case: if len = 0, an empty array is returned. Still, + * if you need more speed and reduced memory footprint (and aren't + * gzipping), consider this method. + * + * @param source The Base64 encoded data + * @param off The offset of where to begin decoding + * @param len The length of characters to decode + * @param options Can specify options such as alphabet type to use + * @return decoded data + * @throws java.io.IOException If bogus characters exist in source data + * @since 1.3 + */ + public static byte[] decode( byte[] source, int off, int len, int options ) + throws java.io.IOException { + + // Lots of error checking and exception throwing + if( source == null ){ + throw new NullPointerException( "Cannot decode null source array." ); + } // end if + if( off < 0 || off + len > source.length ){ + throw new IllegalArgumentException( String.format( + "Source array with length %d cannot have offset of %d and process %d bytes.", source.length, off, len ) ); + } // end if + + if( len == 0 ){ + return new byte[0]; + }else if( len < 4 ){ + throw new IllegalArgumentException( + "Base64-encoded string must have at least four characters, but length specified was " + len ); + } // end if + + byte[] DECODABET = getDecodabet( options ); + + int len34 = len * 3 / 4; // Estimate on array size + byte[] outBuff = new byte[ len34 ]; // Upper limit on size of output + int outBuffPosn = 0; // Keep track of where we're writing + + byte[] b4 = new byte[4]; // Four byte buffer from source, eliminating white space + int b4Posn = 0; // Keep track of four byte input buffer + int i = 0; // Source array counter + byte sbiDecode = 0; // Special value from DECODABET + + for( i = off; i < off+len; i++ ) { // Loop through source + + sbiDecode = DECODABET[ source[i]&0xFF ]; + + // White space, Equals sign, or legit Base64 character + // Note the values such as -5 and -9 in the + // DECODABETs at the top of the file. + if( sbiDecode >= WHITE_SPACE_ENC ) { + if( sbiDecode >= EQUALS_SIGN_ENC ) { + b4[ b4Posn++ ] = source[i]; // Save non-whitespace + if( b4Posn > 3 ) { // Time to decode? + outBuffPosn += decode4to3( b4, 0, outBuff, outBuffPosn, options ); + b4Posn = 0; + + // If that was the equals sign, break out of 'for' loop + if( source[i] == EQUALS_SIGN ) { + break; + } // end if: equals sign + } // end if: quartet built + } // end if: equals sign or better + } // end if: white space, equals sign or better + else { + // There's a bad input character in the Base64 stream. + throw new java.io.IOException( String.format( + "Bad Base64 input character decimal %d in array position %d", ((int)source[i])&0xFF, i ) ); + } // end else: + } // each input character + + byte[] out = new byte[ outBuffPosn ]; + System.arraycopy( outBuff, 0, out, 0, outBuffPosn ); + return out; + } // end decode + + + + + /** + * Decodes data from Base64 notation, automatically + * detecting gzip-compressed data and decompressing it. + * + * @param s the string to decode + * @return the decoded data + * @throws java.io.IOException If there is a problem + * @since 1.4 + */ + public static byte[] decode( String s ) throws java.io.IOException { + return decode( s, NO_OPTIONS ); + } + + + + /** + * Decodes data from Base64 notation, automatically + * detecting gzip-compressed data and decompressing it. + * + * @param s the string to decode + * @param options encode options such as URL_SAFE + * @return the decoded data + * @throws java.io.IOException if there is an error + * @throws NullPointerException if s is null + * @since 1.4 + */ + public static byte[] decode( String s, int options ) throws java.io.IOException { + + if( s == null ){ + throw new NullPointerException( "Input string was null." ); + } // end if + + byte[] bytes; + try { + bytes = s.getBytes( PREFERRED_ENCODING ); + } // end try + catch( java.io.UnsupportedEncodingException uee ) { + bytes = s.getBytes(); + } // end catch + // + + // Decode + bytes = decode( bytes, 0, bytes.length, options ); + + // Check to see if it's gzip-compressed + // GZIP Magic Two-Byte Number: 0x8b1f (35615) + boolean dontGunzip = (options & DONT_GUNZIP) != 0; + if( (bytes != null) && (bytes.length >= 4) && (!dontGunzip) ) { + + int head = ((int)bytes[0] & 0xff) | ((bytes[1] << 8) & 0xff00); + if( java.util.zip.GZIPInputStream.GZIP_MAGIC == head ) { + java.io.ByteArrayInputStream bais = null; + java.util.zip.GZIPInputStream gzis = null; + java.io.ByteArrayOutputStream baos = null; + byte[] buffer = new byte[2048]; + int length = 0; + + try { + baos = new java.io.ByteArrayOutputStream(); + bais = new java.io.ByteArrayInputStream( bytes ); + gzis = new java.util.zip.GZIPInputStream( bais ); + + while( ( length = gzis.read( buffer ) ) >= 0 ) { + baos.write(buffer,0,length); + } // end while: reading input + + // No error? Get new bytes. + bytes = baos.toByteArray(); + + } // end try + catch( java.io.IOException e ) { + e.printStackTrace(); + // Just return originally-decoded bytes + } // end catch + finally { + try{ baos.close(); } catch( Exception e ){} + try{ gzis.close(); } catch( Exception e ){} + try{ bais.close(); } catch( Exception e ){} + } // end finally + + } // end if: gzipped + } // end if: bytes.length >= 2 + + return bytes; + } // end decode + + + + /** + * Attempts to decode Base64 data and deserialize a Java + * Object within. Returns null if there was an error. + * + * @param encodedObject The Base64 data to decode + * @return The decoded and deserialized object + * @throws NullPointerException if encodedObject is null + * @throws java.io.IOException if there is a general error + * @throws ClassNotFoundException if the decoded object is of a + * class that cannot be found by the JVM + * @since 1.5 + */ + public static Object decodeToObject( String encodedObject ) + throws java.io.IOException, java.lang.ClassNotFoundException { + return decodeToObject(encodedObject,NO_OPTIONS,null); + } + + + /** + * Attempts to decode Base64 data and deserialize a Java + * Object within. Returns null if there was an error. + * If loader is not null, it will be the class loader + * used when deserializing. + * + * @param encodedObject The Base64 data to decode + * @param options Various parameters related to decoding + * @param loader Optional class loader to use in deserializing classes. + * @return The decoded and deserialized object + * @throws NullPointerException if encodedObject is null + * @throws java.io.IOException if there is a general error + * @throws ClassNotFoundException if the decoded object is of a + * class that cannot be found by the JVM + * @since 2.3.4 + */ + public static Object decodeToObject( + String encodedObject, int options, final ClassLoader loader ) + throws java.io.IOException, java.lang.ClassNotFoundException { + + // Decode and gunzip if necessary + byte[] objBytes = decode( encodedObject, options ); + + java.io.ByteArrayInputStream bais = null; + java.io.ObjectInputStream ois = null; + Object obj = null; + + try { + bais = new java.io.ByteArrayInputStream( objBytes ); + + // If no custom class loader is provided, use Java's builtin OIS. + if( loader == null ){ + ois = new java.io.ObjectInputStream( bais ); + } // end if: no loader provided + + // Else make a customized object input stream that uses + // the provided class loader. + else { + ois = new java.io.ObjectInputStream(bais){ + @Override + public Class resolveClass(java.io.ObjectStreamClass streamClass) + throws java.io.IOException, ClassNotFoundException { + Class c = Class.forName(streamClass.getName(), false, loader); + if( c == null ){ + return super.resolveClass(streamClass); + } else { + return c; // Class loader knows of this class. + } // end else: not null + } // end resolveClass + }; // end ois + } // end else: no custom class loader + + obj = ois.readObject(); + } // end try + catch( java.io.IOException e ) { + throw e; // Catch and throw in order to execute finally{} + } // end catch + catch( java.lang.ClassNotFoundException e ) { + throw e; // Catch and throw in order to execute finally{} + } // end catch + finally { + try{ bais.close(); } catch( Exception e ){} + try{ ois.close(); } catch( Exception e ){} + } // end finally + + return obj; + } // end decodeObject + + + + /** + * Convenience method for encoding data to a file. + * + *

As of v 2.3, if there is a error, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned false, but + * in retrospect that's a pretty poor way to handle it.

+ * + * @param dataToEncode byte array of data to encode in base64 form + * @param filename Filename for saving encoded data + * @throws java.io.IOException if there is an error + * @throws NullPointerException if dataToEncode is null + * @since 2.1 + */ + public static void encodeToFile( byte[] dataToEncode, String filename ) + throws java.io.IOException { + + if( dataToEncode == null ){ + throw new NullPointerException( "Data to encode was null." ); + } // end iff + + Base64.OutputStream bos = null; + try { + bos = new Base64.OutputStream( + new java.io.FileOutputStream( filename ), Base64.ENCODE ); + bos.write( dataToEncode ); + } // end try + catch( java.io.IOException e ) { + throw e; // Catch and throw to execute finally{} block + } // end catch: java.io.IOException + finally { + try{ bos.close(); } catch( Exception e ){} + } // end finally + + } // end encodeToFile + + + /** + * Convenience method for decoding data to a file. + * + *

As of v 2.3, if there is a error, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned false, but + * in retrospect that's a pretty poor way to handle it.

+ * + * @param dataToDecode Base64-encoded data as a string + * @param filename Filename for saving decoded data + * @throws java.io.IOException if there is an error + * @since 2.1 + */ + public static void decodeToFile( String dataToDecode, String filename ) + throws java.io.IOException { + + Base64.OutputStream bos = null; + try{ + bos = new Base64.OutputStream( + new java.io.FileOutputStream( filename ), Base64.DECODE ); + bos.write( dataToDecode.getBytes( PREFERRED_ENCODING ) ); + } // end try + catch( java.io.IOException e ) { + throw e; // Catch and throw to execute finally{} block + } // end catch: java.io.IOException + finally { + try{ bos.close(); } catch( Exception e ){} + } // end finally + + } // end decodeToFile + + + + + /** + * Convenience method for reading a base64-encoded + * file and decoding it. + * + *

As of v 2.3, if there is a error, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned false, but + * in retrospect that's a pretty poor way to handle it.

+ * + * @param filename Filename for reading encoded data + * @return decoded byte array + * @throws java.io.IOException if there is an error + * @since 2.1 + */ + public static byte[] decodeFromFile( String filename ) + throws java.io.IOException { + + byte[] decodedData = null; + Base64.InputStream bis = null; + try + { + // Set up some useful variables + java.io.File file = new java.io.File( filename ); + byte[] buffer = null; + int length = 0; + int numBytes = 0; + + // Check for size of file + if( file.length() > Integer.MAX_VALUE ) + { + throw new java.io.IOException( "File is too big for this convenience method (" + file.length() + " bytes)." ); + } // end if: file too big for int index + buffer = new byte[ (int)file.length() ]; + + // Open a stream + bis = new Base64.InputStream( + new java.io.BufferedInputStream( + new java.io.FileInputStream( file ) ), Base64.DECODE ); + + // Read until done + while( ( numBytes = bis.read( buffer, length, 4096 ) ) >= 0 ) { + length += numBytes; + } // end while + + // Save in a variable to return + decodedData = new byte[ length ]; + System.arraycopy( buffer, 0, decodedData, 0, length ); + + } // end try + catch( java.io.IOException e ) { + throw e; // Catch and release to execute finally{} + } // end catch: java.io.IOException + finally { + try{ bis.close(); } catch( Exception e) {} + } // end finally + + return decodedData; + } // end decodeFromFile + + + + /** + * Convenience method for reading a binary file + * and base64-encoding it. + * + *

As of v 2.3, if there is a error, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned false, but + * in retrospect that's a pretty poor way to handle it.

+ * + * @param filename Filename for reading binary data + * @return base64-encoded string + * @throws java.io.IOException if there is an error + * @since 2.1 + */ + public static String encodeFromFile( String filename ) + throws java.io.IOException { + + String encodedData = null; + Base64.InputStream bis = null; + try + { + // Set up some useful variables + java.io.File file = new java.io.File( filename ); + byte[] buffer = new byte[ Math.max((int)(file.length() * 1.4+1),40) ]; // Need max() for math on small files (v2.2.1); Need +1 for a few corner cases (v2.3.5) + int length = 0; + int numBytes = 0; + + // Open a stream + bis = new Base64.InputStream( + new java.io.BufferedInputStream( + new java.io.FileInputStream( file ) ), Base64.ENCODE ); + + // Read until done + while( ( numBytes = bis.read( buffer, length, 4096 ) ) >= 0 ) { + length += numBytes; + } // end while + + // Save in a variable to return + encodedData = new String( buffer, 0, length, Base64.PREFERRED_ENCODING ); + + } // end try + catch( java.io.IOException e ) { + throw e; // Catch and release to execute finally{} + } // end catch: java.io.IOException + finally { + try{ bis.close(); } catch( Exception e) {} + } // end finally + + return encodedData; + } // end encodeFromFile + + /** + * Reads infile and encodes it to outfile. + * + * @param infile Input file + * @param outfile Output file + * @throws java.io.IOException if there is an error + * @since 2.2 + */ + public static void encodeFileToFile( String infile, String outfile ) + throws java.io.IOException { + + String encoded = Base64.encodeFromFile( infile ); + java.io.OutputStream out = null; + try{ + out = new java.io.BufferedOutputStream( + new java.io.FileOutputStream( outfile ) ); + out.write( encoded.getBytes("US-ASCII") ); // Strict, 7-bit output. + } // end try + catch( java.io.IOException e ) { + throw e; // Catch and release to execute finally{} + } // end catch + finally { + try { out.close(); } + catch( Exception ex ){} + } // end finally + } // end encodeFileToFile + + + /** + * Reads infile and decodes it to outfile. + * + * @param infile Input file + * @param outfile Output file + * @throws java.io.IOException if there is an error + * @since 2.2 + */ + public static void decodeFileToFile( String infile, String outfile ) + throws java.io.IOException { + + byte[] decoded = Base64.decodeFromFile( infile ); + java.io.OutputStream out = null; + try{ + out = new java.io.BufferedOutputStream( + new java.io.FileOutputStream( outfile ) ); + out.write( decoded ); + } // end try + catch( java.io.IOException e ) { + throw e; // Catch and release to execute finally{} + } // end catch + finally { + try { out.close(); } + catch( Exception ex ){} + } // end finally + } // end decodeFileToFile + + + /* ******** I N N E R C L A S S I N P U T S T R E A M ******** */ + + + + /** + * A {@link Base64.InputStream} will read data from another + * java.io.InputStream, given in the constructor, + * and encode/decode to/from Base64 notation on the fly. + * + * @see Base64 + * @since 1.3 + */ + public static class InputStream extends java.io.FilterInputStream { + + private boolean encode; // Encoding or decoding + private int position; // Current position in the buffer + private byte[] buffer; // Small buffer holding converted data + private int bufferLength; // Length of buffer (3 or 4) + private int numSigBytes; // Number of meaningful bytes in the buffer + private int lineLength; + private boolean breakLines; // Break lines at less than 80 characters + private int options; // Record options used to create the stream. + private byte[] decodabet; // Local copies to avoid extra method calls + + + /** + * Constructs a {@link Base64.InputStream} in DECODE mode. + * + * @param in the java.io.InputStream from which to read data. + * @since 1.3 + */ + public InputStream( java.io.InputStream in ) { + this( in, DECODE ); + } // end constructor + + + /** + * Constructs a {@link Base64.InputStream} in + * either ENCODE or DECODE mode. + *

+ * Valid options:

+         *   ENCODE or DECODE: Encode or Decode as data is read.
+         *   DO_BREAK_LINES: break lines at 76 characters
+         *     (only meaningful when encoding)
+         *
+ *

+ * Example: new Base64.InputStream( in, Base64.DECODE ) + * + * + * @param in the java.io.InputStream from which to read data. + * @param options Specified options + * @see Base64#ENCODE + * @see Base64#DECODE + * @see Base64#DO_BREAK_LINES + * @since 2.0 + */ + public InputStream( java.io.InputStream in, int options ) { + + super( in ); + this.options = options; // Record for later + this.breakLines = (options & DO_BREAK_LINES) > 0; + this.encode = (options & ENCODE) > 0; + this.bufferLength = encode ? 4 : 3; + this.buffer = new byte[ bufferLength ]; + this.position = -1; + this.lineLength = 0; + this.decodabet = getDecodabet(options); + } // end constructor + + /** + * Reads enough of the input stream to convert + * to/from Base64 and returns the next byte. + * + * @return next byte + * @since 1.3 + */ + @Override + public int read() throws java.io.IOException { + + // Do we need to get data? + if( position < 0 ) { + if( encode ) { + byte[] b3 = new byte[3]; + int numBinaryBytes = 0; + for( int i = 0; i < 3; i++ ) { + int b = in.read(); + + // If end of stream, b is -1. + if( b >= 0 ) { + b3[i] = (byte)b; + numBinaryBytes++; + } else { + break; // out of for loop + } // end else: end of stream + + } // end for: each needed input byte + + if( numBinaryBytes > 0 ) { + encode3to4( b3, 0, numBinaryBytes, buffer, 0, options ); + position = 0; + numSigBytes = 4; + } // end if: got data + else { + return -1; // Must be end of stream + } // end else + } // end if: encoding + + // Else decoding + else { + byte[] b4 = new byte[4]; + int i = 0; + for( i = 0; i < 4; i++ ) { + // Read four "meaningful" bytes: + int b = 0; + do{ b = in.read(); } + while( b >= 0 && decodabet[ b & 0x7f ] <= WHITE_SPACE_ENC ); + + if( b < 0 ) { + break; // Reads a -1 if end of stream + } // end if: end of stream + + b4[i] = (byte)b; + } // end for: each needed input byte + + if( i == 4 ) { + numSigBytes = decode4to3( b4, 0, buffer, 0, options ); + position = 0; + } // end if: got four characters + else if( i == 0 ){ + return -1; + } // end else if: also padded correctly + else { + // Must have broken out from above. + throw new java.io.IOException( "Improperly padded Base64 input." ); + } // end + + } // end else: decode + } // end else: get data + + // Got data? + if( position >= 0 ) { + // End of relevant data? + if( /*!encode &&*/ position >= numSigBytes ){ + return -1; + } // end if: got data + + if( encode && breakLines && lineLength >= MAX_LINE_LENGTH ) { + lineLength = 0; + return '\n'; + } // end if + else { + lineLength++; // This isn't important when decoding + // but throwing an extra "if" seems + // just as wasteful. + + int b = buffer[ position++ ]; + + if( position >= bufferLength ) { + position = -1; + } // end if: end + + return b & 0xFF; // This is how you "cast" a byte that's + // intended to be unsigned. + } // end else + } // end if: position >= 0 + + // Else error + else { + throw new java.io.IOException( "Error in Base64 code reading stream." ); + } // end else + } // end read + + + /** + * Calls {@link #read()} repeatedly until the end of stream + * is reached or len bytes are read. + * Returns number of bytes read into array or -1 if + * end of stream is encountered. + * + * @param dest array to hold values + * @param off offset for array + * @param len max number of bytes to read into array + * @return bytes read into array or -1 if end of stream is encountered. + * @since 1.3 + */ + @Override + public int read( byte[] dest, int off, int len ) + throws java.io.IOException { + int i; + int b; + for( i = 0; i < len; i++ ) { + b = read(); + + if( b >= 0 ) { + dest[off + i] = (byte) b; + } + else if( i == 0 ) { + return -1; + } + else { + break; // Out of 'for' loop + } // Out of 'for' loop + } // end for: each byte read + return i; + } // end read + + } // end inner class InputStream + + + + + + + /* ******** I N N E R C L A S S O U T P U T S T R E A M ******** */ + + + + /** + * A {@link Base64.OutputStream} will write data to another + * java.io.OutputStream, given in the constructor, + * and encode/decode to/from Base64 notation on the fly. + * + * @see Base64 + * @since 1.3 + */ + public static class OutputStream extends java.io.FilterOutputStream { + + private boolean encode; + private int position; + private byte[] buffer; + private int bufferLength; + private int lineLength; + private boolean breakLines; + private byte[] b4; // Scratch used in a few places + private boolean suspendEncoding; + private int options; // Record for later + private byte[] decodabet; // Local copies to avoid extra method calls + + /** + * Constructs a {@link Base64.OutputStream} in ENCODE mode. + * + * @param out the java.io.OutputStream to which data will be written. + * @since 1.3 + */ + public OutputStream( java.io.OutputStream out ) { + this( out, ENCODE ); + } // end constructor + + + /** + * Constructs a {@link Base64.OutputStream} in + * either ENCODE or DECODE mode. + *

+ * Valid options:

+         *   ENCODE or DECODE: Encode or Decode as data is read.
+         *   DO_BREAK_LINES: don't break lines at 76 characters
+         *     (only meaningful when encoding)
+         *
+ *

+ * Example: new Base64.OutputStream( out, Base64.ENCODE ) + * + * @param out the java.io.OutputStream to which data will be written. + * @param options Specified options. + * @see Base64#ENCODE + * @see Base64#DECODE + * @see Base64#DO_BREAK_LINES + * @since 1.3 + */ + public OutputStream( java.io.OutputStream out, int options ) { + super( out ); + this.breakLines = (options & DO_BREAK_LINES) != 0; + this.encode = (options & ENCODE) != 0; + this.bufferLength = encode ? 3 : 4; + this.buffer = new byte[ bufferLength ]; + this.position = 0; + this.lineLength = 0; + this.suspendEncoding = false; + this.b4 = new byte[4]; + this.options = options; + this.decodabet = getDecodabet(options); + } // end constructor + + + /** + * Writes the byte to the output stream after + * converting to/from Base64 notation. + * When encoding, bytes are buffered three + * at a time before the output stream actually + * gets a write() call. + * When decoding, bytes are buffered four + * at a time. + * + * @param theByte the byte to write + * @since 1.3 + */ + @Override + public void write(int theByte) + throws java.io.IOException { + // Encoding suspended? + if( suspendEncoding ) { + this.out.write( theByte ); + return; + } // end if: supsended + + // Encode? + if( encode ) { + buffer[ position++ ] = (byte)theByte; + if( position >= bufferLength ) { // Enough to encode. + + this.out.write( encode3to4( b4, buffer, bufferLength, options ) ); + + lineLength += 4; + if( breakLines && lineLength >= MAX_LINE_LENGTH ) { + this.out.write( NEW_LINE ); + lineLength = 0; + } // end if: end of line + + position = 0; + } // end if: enough to output + } // end if: encoding + + // Else, Decoding + else { + // Meaningful Base64 character? + if( decodabet[ theByte & 0x7f ] > WHITE_SPACE_ENC ) { + buffer[ position++ ] = (byte)theByte; + if( position >= bufferLength ) { // Enough to output. + + int len = Base64.decode4to3( buffer, 0, b4, 0, options ); + out.write( b4, 0, len ); + position = 0; + } // end if: enough to output + } // end if: meaningful base64 character + else if( decodabet[ theByte & 0x7f ] != WHITE_SPACE_ENC ) { + throw new java.io.IOException( "Invalid character in Base64 data." ); + } // end else: not white space either + } // end else: decoding + } // end write + + + + /** + * Calls {@link #write(int)} repeatedly until len + * bytes are written. + * + * @param theBytes array from which to read bytes + * @param off offset for array + * @param len max number of bytes to read into array + * @since 1.3 + */ + @Override + public void write( byte[] theBytes, int off, int len ) + throws java.io.IOException { + // Encoding suspended? + if( suspendEncoding ) { + this.out.write( theBytes, off, len ); + return; + } // end if: supsended + + for( int i = 0; i < len; i++ ) { + write( theBytes[ off + i ] ); + } // end for: each byte written + + } // end write + + + + /** + * Method added by PHIL. [Thanks, PHIL. -Rob] + * This pads the buffer without closing the stream. + * @throws java.io.IOException if there's an error. + */ + public void flushBase64() throws java.io.IOException { + if( position > 0 ) { + if( encode ) { + out.write( encode3to4( b4, buffer, position, options ) ); + position = 0; + } // end if: encoding + else { + throw new java.io.IOException( "Base64 input not properly padded." ); + } // end else: decoding + } // end if: buffer partially full + + } // end flush + + + /** + * Flushes and closes (I think, in the superclass) the stream. + * + * @since 1.3 + */ + @Override + public void close() throws java.io.IOException { + // 1. Ensure that pending characters are written + flushBase64(); + + // 2. Actually close the stream + // Base class both flushes and closes. + super.close(); + + buffer = null; + out = null; + } // end close + + + + /** + * Suspends encoding of the stream. + * May be helpful if you need to embed a piece of + * base64-encoded data in a stream. + * + * @throws java.io.IOException if there's an error flushing + * @since 1.5.1 + */ + public void suspendEncoding() throws java.io.IOException { + flushBase64(); + this.suspendEncoding = true; + } // end suspendEncoding + + + /** + * Resumes encoding of the stream. + * May be helpful if you need to embed a piece of + * base64-encoded data in a stream. + * + * @since 1.5.1 + */ + public void resumeEncoding() { + this.suspendEncoding = false; + } // end resumeEncoding + + + + } // end inner class OutputStream + + +} // end class Base64 diff --git a/java/src/org/netstream/packing/Base64Packer.java b/java/src/org/netstream/packing/Base64Packer.java new file mode 100644 index 0000000..61862fc --- /dev/null +++ b/java/src/org/netstream/packing/Base64Packer.java @@ -0,0 +1,68 @@ +/* + * Copyright 2006 - 2012 + * Stefan Balev + * Julien Baudry + * Antoine Dutot + * Yoann Pigné + * Guilhelm Savin + * + * GraphStream is a library whose purpose is to handle static or dynamic + * graph, create them from scratch, file or any source and display them. + * + * This program is free software distributed under the terms of two licenses, the + * CeCILL-C license that fits European law, and the GNU Lesser General Public + * License. You can use, modify and/ or redistribute the software under the terms + * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following + * URL or under the terms of the GNU LGPL as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * 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 Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program. If not, see . + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms. + */ +package org.netstream.packing; + +/** +* +* @file Base64Packer.java +* @date Dec 14, 2011 +* +* @author Yoann Pigné +* +*/ + +import java.nio.ByteBuffer; + + +public class Base64Packer extends NetStreamPacker { + + + + /* (non-Javadoc) + * @see org.graphstream.stream.netstream.packing.NetStreamPacker#packMessage(java.nio.ByteBuffer, int, int) + */ + @Override + public ByteBuffer packMessage(ByteBuffer buffer, int startIndex, + int endIndex) { + String encoded = Base64.encodeBytes(buffer.array(),startIndex,endIndex-startIndex); + return ByteBuffer.wrap(encoded.getBytes()); + } + + /* (non-Javadoc) + * @see org.graphstream.stream.netstream.packing.NetStreamPacker#packMessageSize(int) + */ + @Override + public ByteBuffer packMessageSize(int capacity) { + ByteBuffer sizeBuffer = ByteBuffer.allocate(4); + sizeBuffer.putInt(capacity); + String encoded = Base64.encodeBytes(sizeBuffer.array()); + return ByteBuffer.wrap(encoded.getBytes()); + } +} diff --git a/java/src/org/netstream/packing/NetStreamPacker.java b/java/src/org/netstream/packing/NetStreamPacker.java new file mode 100644 index 0000000..ad997b3 --- /dev/null +++ b/java/src/org/netstream/packing/NetStreamPacker.java @@ -0,0 +1,63 @@ +/* + * Copyright 2006 - 2012 + * Stefan Balev + * Julien Baudry + * Antoine Dutot + * Yoann Pigné + * Guilhelm Savin + * + * GraphStream is a library whose purpose is to handle static or dynamic + * graph, create them from scratch, file or any source and display them. + * + * This program is free software distributed under the terms of two licenses, the + * CeCILL-C license that fits European law, and the GNU Lesser General Public + * License. You can use, modify and/ or redistribute the software under the terms + * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following + * URL or under the terms of the GNU LGPL as published by + * the Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * 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 Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program. If not, see . + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms. + */ +package org.netstream.packing; + +import java.nio.ByteBuffer; + +/** + * + */ +public abstract class NetStreamPacker { + + /** + * Pack the given ByteBuffer from startIndex to endIdex + * @param buffer The buffer to pack/encode + * @param startIndex the index at which the encoding starts in the buffer + * @param endIndex the index at which the encoding stops + * @return a ByteBuffer that is the packed version of the input one. It may not have the same size. + */ + public abstract ByteBuffer packMessage(ByteBuffer buffer, int startIndex, int endIndex); + + /** + * Pack the given ByteBuffer form its position to its capacity. + * @param buffer The buffer to pack/encode + * @return a ByteBuffer that is the packed version of the input one. It may not have the same size. + */ + public ByteBuffer packMessage(ByteBuffer buffer){ + return this.packMessage(buffer, 0, buffer.capacity()); + } + + /** + * @param capacity + * @return + */ + public abstract ByteBuffer packMessageSize(int capacity) ; + +} -- GitLab