serval-dna/java/org/servalproject/servaldna/rhizome/RhizomeCommon.java

/**
 * Copyright (C) 2014 Serval Project Inc.
 *
 * This file is part of Serval Software (http://www.servalproject.org)
 *
 * Serval Software is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This source code is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this source code; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.servalproject.servaldna.rhizome;

import java.lang.StringBuilder;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.lang.reflect.InvocationTargetException;
import java.util.Map;
import java.util.List;
import java.io.IOException;
import java.io.PrintStream;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.HttpURLConnection;
import org.servalproject.json.JSONTokeniser;
import org.servalproject.json.JSONInputException;
import org.servalproject.servaldna.BundleId;
import org.servalproject.servaldna.FileHash;
import org.servalproject.servaldna.BundleKey;
import org.servalproject.servaldna.SubscriberId;
import org.servalproject.servaldna.BundleSecret;
import org.servalproject.servaldna.ServalDHttpConnectionFactory;
import org.servalproject.servaldna.ServalDInterfaceException;
import org.servalproject.servaldna.ServalDFailureException;

public class RhizomeCommon
{

	private static class Status {
		InputStream input_stream;
		public int http_status_code;
		public String http_status_message;
		RhizomeBundleStatus bundle_status_code;
		String bundle_status_message;
		RhizomePayloadStatus payload_status_code;
		String payload_status_message;
	}

	protected static Status receiveResponse(HttpURLConnection conn, int expected_response_code) throws IOException, ServalDInterfaceException
	{
		int[] expected_response_codes = { expected_response_code };
		return receiveResponse(conn, expected_response_codes);
	}

	protected static Status receiveResponse(HttpURLConnection conn, int[] expected_response_codes) throws IOException, ServalDInterfaceException
	{
		Status status = new Status();
		status.http_status_code = conn.getResponseCode();
		status.http_status_message = conn.getResponseMessage();
		for (int code: expected_response_codes) {
			if (status.http_status_code == code) {
				status.input_stream = conn.getInputStream();
				return status;
			}
		}
		if (!conn.getContentType().equals("application/json"))
			throw new ServalDInterfaceException("unexpected HTTP Content-Type: " + conn.getContentType());
		if (conn.getResponseCode() == HttpURLConnection.HTTP_FORBIDDEN) {
			JSONTokeniser json = new JSONTokeniser(new InputStreamReader(conn.getErrorStream(), "US-ASCII"));
			decodeRestfulStatus(status, json);
			return status;
		}
		throw new ServalDInterfaceException("unexpected HTTP response code: " + conn.getResponseCode());
	}

	protected static void unexpectedResponse(Status status) throws ServalDInterfaceException
	{
		throw new ServalDInterfaceException(
				"unexpected Rhizome failure, \"" + status.http_status_message + "\""
				+ (status.bundle_status_code == null ? "" : ", " + status.bundle_status_code)
				+ (status.bundle_status_message == null ? "" : " \"" + status.bundle_status_message + "\"")
				+ (status.payload_status_code == null ? "" : ", " + status.payload_status_code)
				+ (status.payload_status_message == null ? "" : ", " + status.payload_status_message + "\"")
			);
	}

/*
	protected static void throwRestfulResponseExceptions(Status status, URL url) throws RhizomeException, ServalDFailureException
	{
		if (status.bundle_status_code != null) {
			switch (status.bundle_status_code) {
			case ERROR:
				throw new ServalDFailureException("received rhizome_bundle_status_code=ERROR(-1) from " + url);
			case NEW:
				throw new RhizomeManifestNotFoundException(url);
			case SAME:
				throw new RhizomeManifestAlreadyStoredException(url);
			case DUPLICATE:
				throw new RhizomeDuplicateBundleException(url);
			case OLD:
				throw new RhizomeOutdatedBundleException(url);
			case NO_ROOM:
				throw new RhizomeStoreFullException(url);
			case INVALID:
				throw new RhizomeInvalidManifestException(url);
			case FAKE:
				throw new RhizomeFakeManifestException(url);
			case INCONSISTENT:
				throw new RhizomeInconsistencyException(url);
			}
		}
	}
*/

	protected static JSONTokeniser receiveRestfulResponse(HttpURLConnection conn, int expected_response_code) throws IOException, ServalDInterfaceException, RhizomeException
	{
		int[] expected_response_codes = { expected_response_code };
		return receiveRestfulResponse(conn, expected_response_codes);
	}

	protected static JSONTokeniser receiveRestfulResponse(HttpURLConnection conn, int[] expected_response_codes) throws IOException, ServalDInterfaceException, RhizomeException
	{
		Status status = receiveResponse(conn, expected_response_codes);
		if (!conn.getContentType().equals("application/json"))
			throw new ServalDInterfaceException("unexpected HTTP Content-Type: " + conn.getContentType());
		return new JSONTokeniser(new InputStreamReader(status.input_stream, "US-ASCII"));
	}

	protected static void decodeHeaderBundleStatus(Status status, HttpURLConnection conn) throws ServalDInterfaceException
	{
		status.bundle_status_code = header(conn,  "Serval-Rhizome-Result-Bundle-Status-Code", RhizomeBundleStatus.class);
		status.bundle_status_message = headerString(conn,  "Serval-Rhizome-Result-Bundle-Status-Message");
	}

	protected static void decodeHeaderPayloadStatus(Status status, HttpURLConnection conn) throws ServalDInterfaceException
	{
		status.payload_status_code = header(conn,  "Serval-Rhizome-Result-Payload-Status-Code", RhizomePayloadStatus.class);
		status.payload_status_message = headerString(conn,  "Serval-Rhizome-Result-Payload-Status-Message");
	}

	protected static void decodeRestfulStatus(Status status, JSONTokeniser json) throws IOException, ServalDInterfaceException
	{
		try {
			json.consume(JSONTokeniser.Token.START_OBJECT);
			json.consume("http_status_code");
			json.consume(JSONTokeniser.Token.COLON);
			int hs = json.consume(Integer.class);
			json.consume(JSONTokeniser.Token.COMMA);
			if (status.http_status_code == 0)
				status.http_status_code = json.consume(Integer.class);
			else if (hs != status.http_status_code)
				throw new ServalDInterfaceException("JSON/header conflict"
						+ ", http_status_code=" + hs
						+ " but HTTP response code is " + status.http_status_code);
			json.consume("http_status_message");
			json.consume(JSONTokeniser.Token.COLON);
			status.http_status_message = json.consume(String.class);
			Object tok = json.nextToken();
			while (tok == JSONTokeniser.Token.COMMA) {
				String label = json.consume(String.class);
				json.consume(JSONTokeniser.Token.COLON);
				if (label.equals("rhizome_bundle_status_code")) {
					RhizomeBundleStatus bs = RhizomeBundleStatus.fromCode(json.consume(Integer.class));
					if (status.bundle_status_code == null)
						status.bundle_status_code = bs;
					else if (status.bundle_status_code != bs)
						throw new ServalDInterfaceException("JSON/header conflict"
								+ ", rhizome_bundle_status_code=" + bs.code
								+ " but Serval-Rhizome-Result-Bundle-Status-Code: " + status.bundle_status_code.code);
				}
				else if (label.equals("rhizome_bundle_status_message")) {
					String message = json.consume(String.class);
					if (status.bundle_status_message == null)
						status.bundle_status_message = message;
					else if (!status.bundle_status_message.equals(message))
						throw new ServalDInterfaceException("JSON/header conflict"
								+ ", rhizome_bundle_status_message=" + message
								+ " but Serval-Rhizome-Result-Bundle-Status-Message: " + status.bundle_status_message);
				}
				else if (label.equals("rhizome_payload_status_code")) {
					RhizomePayloadStatus bs = RhizomePayloadStatus.fromCode(json.consume(Integer.class));
					if (status.payload_status_code == null)
						status.payload_status_code = bs;
					else if (status.payload_status_code != bs)
						throw new ServalDInterfaceException("JSON/header conflict"
								+ ", rhizome_payload_status_code=" + bs.code
								+ " but Serval-Rhizome-Result-Payload-Status-Code: " + status.payload_status_code.code);
				}
				else if (label.equals("rhizome_payload_status_message")) {
					String message = json.consume(String.class);
					if (status.payload_status_message == null)
						status.payload_status_message = message;
					else if (!status.payload_status_message.equals(message))
						throw new ServalDInterfaceException("JSON/header conflict"
								+ ", rhizome_payload_status_message=" + message
								+ " but Serval-Rhizome-Result-Payload-Status-Code: " + status.payload_status_message);
				}
				else
					json.unexpected(label);
				tok = json.nextToken();
			}
			json.match(tok, JSONTokeniser.Token.END_OBJECT);
			json.consume(JSONTokeniser.Token.EOF);
		}
		catch (JSONInputException e) {
			throw new ServalDInterfaceException("malformed JSON status response", e);
		}
	}

	public static RhizomeManifestBundle rhizomeManifest(ServalDHttpConnectionFactory connector, BundleId bid)
		throws IOException, ServalDInterfaceException
	{
		HttpURLConnection conn = connector.newServalDHttpConnection("/restful/rhizome/" + bid.toHex() + ".rhm");
		conn.connect();
		Status status = RhizomeCommon.receiveResponse(conn, HttpURLConnection.HTTP_OK);
		try {
			dumpHeaders(conn, System.err);
			decodeHeaderBundleStatus(status, conn);
			switch (status.bundle_status_code) {
			case NEW:
				return null;
			case SAME:
				if (!conn.getContentType().equals("rhizome-manifest/text"))
					throw new ServalDInterfaceException("unexpected HTTP Content-Type: " + conn.getContentType());
				RhizomeManifest manifest = RhizomeManifest.fromTextFormat(status.input_stream);
				BundleExtra extra = bundleExtraFromHeaders(conn);
				return new RhizomeManifestBundle(manifest, extra.insertTime, extra.author, extra.secret);
			case ERROR:
				throw new ServalDFailureException("received rhizome_bundle_status_code=ERROR(-1) from " + conn.getURL());
			}
		}
		catch (RhizomeManifestParseException e) {
			throw new ServalDInterfaceException("malformed manifest from daemon", e);
		}
		finally {
			if (status.input_stream != null)
				status.input_stream.close();
		}
		unexpectedResponse(status);
		return null;
	}

	public static RhizomePayloadRawBundle rhizomePayloadRaw(ServalDHttpConnectionFactory connector, BundleId bid)
		throws IOException, ServalDInterfaceException
	{
		HttpURLConnection conn = connector.newServalDHttpConnection("/restful/rhizome/" + bid.toHex() + "/raw.bin");
		conn.connect();
		Status status = RhizomeCommon.receiveResponse(conn, HttpURLConnection.HTTP_OK);
		try {
			dumpHeaders(conn, System.err);
			decodeHeaderBundleStatus(status, conn);
			switch (status.bundle_status_code) {
			case ERROR:
				throw new ServalDFailureException("received rhizome_bundle_status_code=ERROR(-1) from " + conn.getURL());
			case NEW: // No manifest
				return null;
			case SAME:
				decodeHeaderPayloadStatus(status, conn);
				switch (status.payload_status_code) {
				case ERROR:
					throw new ServalDFailureException("received rhizome_payload_status_code=ERROR(-1) from " + conn.getURL());
				case NEW:
					// The manifest is known but the payload is unavailable, so return a bundle
					// object with a null input stream.
					// FALL THROUGH
				case EMPTY:
					if (status.input_stream != null) {
						status.input_stream.close();
						status.input_stream = null;
					}
					// FALL THROUGH
				case STORED: {
						if (status.input_stream != null && !conn.getContentType().equals("application/octet-stream"))
							throw new ServalDInterfaceException("unexpected HTTP Content-Type: " + conn.getContentType());
						RhizomeManifest manifest = manifestFromHeaders(conn);
						BundleExtra extra = bundleExtraFromHeaders(conn);
						RhizomePayloadRawBundle ret = new RhizomePayloadRawBundle(manifest, status.input_stream, extra.insertTime, extra.author, extra.secret);
						status.input_stream = null; // don't close when we return
						return ret;
					}
				}
			}
		}
		finally {
			if (status.input_stream != null)
				status.input_stream.close();
		}
		unexpectedResponse(status);
		return null;
	}

	public static RhizomePayloadBundle rhizomePayload(ServalDHttpConnectionFactory connector, BundleId bid)
		throws IOException, ServalDInterfaceException, RhizomeDecryptionException
	{
		HttpURLConnection conn = connector.newServalDHttpConnection("/restful/rhizome/" + bid.toHex() + "/decrypted.bin");
		conn.connect();
		Status status = RhizomeCommon.receiveResponse(conn, HttpURLConnection.HTTP_OK);
		try {
			dumpHeaders(conn, System.err);
			decodeHeaderBundleStatus(status, conn);
			switch (status.bundle_status_code) {
			case ERROR:
				throw new ServalDFailureException("received rhizome_bundle_status_code=ERROR(-1) from " + conn.getURL());
			case NEW: // No manifest
				return null;
			case SAME:
				decodeHeaderPayloadStatus(status, conn);
				switch (status.payload_status_code) {
				case ERROR:
					throw new ServalDFailureException("received rhizome_payload_status_code=ERROR(-1) from " + conn.getURL());
				case CRYPTO_FAIL:
					throw new RhizomeDecryptionException(conn.getURL());
				case NEW:
					// The manifest is known but the payload is unavailable, so return a bundle
					// object with a null input stream.
					// FALL THROUGH
				case EMPTY:
					if (status.input_stream != null) {
						status.input_stream.close();
						status.input_stream = null;
					}
					// FALL THROUGH
				case STORED: {
						if (status.input_stream != null && !conn.getContentType().equals("application/octet-stream"))
							throw new ServalDInterfaceException("unexpected HTTP Content-Type: " + conn.getContentType());
						RhizomeManifest manifest = manifestFromHeaders(conn);
						BundleExtra extra = bundleExtraFromHeaders(conn);
						RhizomePayloadBundle ret = new RhizomePayloadBundle(manifest, status.input_stream, extra.insertTime, extra.author, extra.secret);
						status.input_stream = null; // don't close when we return
						return ret;
					}
				}
			}
		}
		finally {
			if (status.input_stream != null)
				status.input_stream.close();
		}
		unexpectedResponse(status);
		return null;
	}

	private static void dumpHeaders(HttpURLConnection conn, PrintStream out)
	{
		for (Map.Entry<String,List<String>> e: conn.getHeaderFields().entrySet())
			for (String v: e.getValue())
				out.println("received header " + e.getKey() + ": " + v);
	}

	private static RhizomeManifest manifestFromHeaders(HttpURLConnection conn) throws ServalDInterfaceException
	{
		BundleId id = header(conn, "Serval-Rhizome-Bundle-Id", BundleId.class);
		long version = headerUnsignedLong(conn, "Serval-Rhizome-Bundle-Version");
		long filesize = headerUnsignedLong(conn, "Serval-Rhizome-Bundle-Filesize");
		FileHash filehash = filesize == 0 ? null : header(conn, "Serval-Rhizome-Bundle-Filehash", FileHash.class);
		SubscriberId sender = headerOrNull(conn, "Serval-Rhizome-Bundle-Sender", SubscriberId.class);
		SubscriberId recipient = headerOrNull(conn, "Serval-Rhizome-Bundle-Recipient", SubscriberId.class);
		BundleKey BK = headerOrNull(conn, "Serval-Rhizome-Bundle-BK", BundleKey.class);
		Integer crypt = headerIntegerOrNull(conn, "Serval-Rhizome-Bundle-Crypt");
		Long tail = headerUnsignedLongOrNull(conn, "Serval-Rhizome-Bundle-Tail");
		Long date = headerUnsignedLongOrNull(conn, "Serval-Rhizome-Bundle-Date");
		String service = conn.getHeaderField("Serval-Rhizome-Bundle-Service");
		String name = headerQuotedStringOrNull(conn, "Serval-Rhizome-Bundle-Name");
		return new RhizomeManifest(id, version, filesize, filehash, sender, recipient, BK, crypt, tail, date, service, name);
	}

	private static class BundleExtra {
		public long insertTime;
		public SubscriberId author;
		public BundleSecret secret;
	}

	private static BundleExtra bundleExtraFromHeaders(HttpURLConnection conn) throws ServalDInterfaceException
	{
		BundleExtra extra = new BundleExtra();
		extra.insertTime = headerUnsignedLong(conn, "Serval-Rhizome-Bundle-Inserttime");
		extra.author = header(conn, "Serval-Rhizome-Bundle-Author", SubscriberId.class);
		extra.secret = header(conn, "Serval-Rhizome-Bundle-Secret", BundleSecret.class);
		return extra;
	}

	private static String headerString(HttpURLConnection conn, String header) throws ServalDInterfaceException
	{
		String str = conn.getHeaderField(header);
		if (str == null)
			throw new ServalDInterfaceException("missing header field: " + header);
		return str;
	}

	private static String headerQuotedStringOrNull(HttpURLConnection conn, String header) throws ServalDInterfaceException
	{
		String quoted = conn.getHeaderField(header);
		if (quoted == null)
			return null;
		if (quoted.length() == 0 || quoted.charAt(0) != '"')
			throw new ServalDInterfaceException("malformed header field: " + header + ": missing quote at start of quoted-string");
		boolean slosh = false;
		boolean end = false;
		StringBuilder b = new StringBuilder(quoted.length());
		for (int i = 1; i < quoted.length(); ++i) {
			char c = quoted.charAt(i);
			if (end)
				throw new ServalDInterfaceException("malformed header field: " + header + ": spurious character after quoted-string");
			if (c < ' ' || c > '~')
				throw new ServalDInterfaceException("malformed header field: " + header + ": invalid character in quoted-string");
			if (slosh) {
				b.append(c);
				slosh = false;
			}
			else if (c == '"')
				end = true;
			else if (c == '\\')
				slosh = true;
			else
				b.append(c);
		}
		if (!end)
			throw new ServalDInterfaceException("malformed header field: " + header + ": missing quote at end of quoted-string");
		return b.toString();
	}

	private static Integer headerIntegerOrNull(HttpURLConnection conn, String header) throws ServalDInterfaceException
	{
		String str = conn.getHeaderField(header);
		if (str == null)
			return null;
		try {
			return Integer.valueOf(str);
		}
		catch (NumberFormatException e) {
		}
		throw new ServalDInterfaceException("invalid header field: " + header + ": " + str);
	}

	private static Long headerUnsignedLongOrNull(HttpURLConnection conn, String header) throws ServalDInterfaceException
	{
		String str = conn.getHeaderField(header);
		if (str == null)
			return null;
		try {
			Long value = Long.valueOf(str);
			if (value >= 0)
				return value;
		}
		catch (NumberFormatException e) {
		}
		throw new ServalDInterfaceException("invalid header field: " + header + ": " + str);
	}

	private static long headerUnsignedLong(HttpURLConnection conn, String header) throws ServalDInterfaceException
	{
		Long value = headerUnsignedLongOrNull(conn, header);
		if (value == null)
			throw new ServalDInterfaceException("missing header field: " + header);
		return value;
	}

	private static <T> T headerOrNull(HttpURLConnection conn, String header, Class<T> cls) throws ServalDInterfaceException
	{
		String str = conn.getHeaderField(header);
		try {
			try {
				Constructor<T> constructor = cls.getConstructor(String.class);
				if (str == null)
					return null;
				return constructor.newInstance(str);
			}
			catch (NoSuchMethodException e) {
			}
			try {
				Method method = cls.getMethod("fromCode", Integer.TYPE);
				if ((method.getModifiers() & Modifier.STATIC) != 0 && method.getReturnType() == cls) {
					Integer integer = headerIntegerOrNull(conn, header);
					if (integer == null)
						return null;
					return cls.cast(method.invoke(null, integer));
				}
			}
			catch (NoSuchMethodException e) {
			}
			throw new ServalDInterfaceException("don't know how to instantiate: " + cls.getName());
		}
		catch (ServalDInterfaceException e) {
			throw e;
		}
		catch (InvocationTargetException e) {
			throw new ServalDInterfaceException("invalid header field: " + header + ": " + str, e.getTargetException());
		}
		catch (Exception e) {
			throw new ServalDInterfaceException("invalid header field: " + header + ": " + str, e);
		}
	}

	private static <T> T header(HttpURLConnection conn, String header, Class<T> cls) throws ServalDInterfaceException
	{
		T value = headerOrNull(conn, header, cls);
		if (value == null)
			throw new ServalDInterfaceException("missing header field: " + header);
		return value;
	}

}