f@0: /*  
f@0:  CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
f@0:   
f@0:  Copyright (C) 2011  Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)
f@0: 
f@0:  This program is free software: you can redistribute it and/or modify
f@0:  it under the terms of the GNU General Public License as published by
f@0:  the Free Software Foundation, either version 3 of the License, or
f@0:  (at your option) any later version.
f@0: 
f@0:  This program is distributed in the hope that it will be useful,
f@0:  but WITHOUT ANY WARRANTY; without even the implied warranty of
f@0:  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
f@0:  GNU General Public License for more details.
f@0: 
f@0:  You should have received a copy of the GNU General Public License
f@0:  along with this program.  If not, see <http://www.gnu.org/licenses/>.
f@0: */  
f@0: 
f@0: package uk.ac.qmul.eecs.ccmi.network;
f@0: 
f@0: import java.io.IOException;
f@0: import java.net.SocketException;
f@0: import java.nio.ByteBuffer;
f@0: import java.nio.channels.SocketChannel;
f@0: import java.util.ResourceBundle;
f@0: 
f@0: import uk.ac.qmul.eecs.ccmi.gui.DiagramEventSource;
f@0: 
f@0: import de.sciss.net.OSCBundle;
f@0: import de.sciss.net.OSCMessage;
f@0: 
f@0: /*
f@0:  * An implementation of the Protocol interface which uses OSC messages 
f@0:  * streamed on a TCP connection. 
f@0:  *
f@0:  */
f@0: class OscProtocol implements Protocol {
f@0: 
f@0: 	OscProtocol(){
f@0: 		buffer = ByteBuffer.allocate(DEFAULT_CAPACITY);
f@0: 		codec = new CCmIOSCPacketCodec();
f@0: 	}
f@0: 	
f@0: 	@Override
f@0: 	public void send(SocketChannel channel, Command cmd) throws IOException {
f@0: 		/* OSC message args = [diagram, cmd.arg1, cmd.arg2, amd.arg2, ... , cmd.argN  ] */
f@0: 		bundle = new CCmIOSCBundle(cmd.getTimestamp());
f@0: 		Object[] args = new Object[2+cmd.getArgNum()];
f@0: 		args[0] = cmd.getDiagram();
f@0: 		args[1] = cmd.getSource().toString();
f@0: 		for(int i=0; i<cmd.getArgNum();i++)
f@0: 			args[i+2] = cmd.getArgAt(i);
f@0: 		
f@0: 		bundle.addPacket(new OSCMessage(OSC_NAME_PREFIX+cmd.getName().toString(),args));
f@0: 		try{
f@0: 			writeBundle(channel);
f@0: 		}catch(IOException u){
f@0: 			throw new IOException(
f@0: 					/* give a more user friendly message */
f@0: 					ResourceBundle.getBundle(Server.class.getName()).getString("dialog.error.no_send"),u);
f@0: 		}
f@0: 	}
f@0: 	
f@0: 	@Override
f@0: 	public void send(SocketChannel channel, Reply reply) throws IOException {
f@0: 		/* OSC message args = [messageLen, diagram, message ] */
f@0: 		bundle = new CCmIOSCBundle(reply.getTimestamp());
f@0: 		bundle.addPacket(new OSCMessage(
f@0: 				OSC_NAME_PREFIX+reply.getName().toString(), 
f@0: 				new Object[] {reply.getMessageLen(), reply.getDiagram() ,reply.getMessage(),reply.getSource().toString()}
f@0: 				));
f@0: 		try{
f@0: 			writeBundle(channel);
f@0: 		}catch(IOException u){
f@0: 			throw new IOException(
f@0: 					/* give a more user friendly message */
f@0: 					ResourceBundle.getBundle(Server.class.getName()).getString("dialog.error.no_send"),u);
f@0: 		}
f@0: 	}
f@0: 	
f@0: 	@Override
f@0: 	public void send(SocketChannel channel, LockMessage lockMessage) throws IOException {
f@0: 		/* OSC message args = [diagram, source, lock.arg1, lock.arg2, lock.arg2, ... , lock.argN  ] */
f@0: 		bundle = new CCmIOSCBundle(lockMessage.getTimestamp());
f@0: 		Object[] args = new Object[2+lockMessage.getArgNum()];
f@0: 		args[0] = lockMessage.getDiagram();
f@0: 		args[1] = lockMessage.getSource().toString();
f@0: 		for(int i=0; i<lockMessage.getArgNum();i++)
f@0: 			args[i+2] = lockMessage.getArgAt(i);
f@0: 		
f@0: 		bundle.addPacket(new OSCMessage(
f@0: 				OSC_NAME_PREFIX+lockMessage.getName().toString(), 
f@0: 				args));
f@0: 		try{
f@0: 			writeBundle(channel);
f@0: 		}catch(IOException u){
f@0: 			throw new IOException(
f@0: 					/* give a more user friendly message */
f@0: 					ResourceBundle.getBundle(Server.class.getName()).getString("dialog.error.no_send"),u);
f@0: 		}
f@0: 	}
f@0: 	
f@0: 	@Override
f@0: 	public void send(SocketChannel channel, AwarenessMessage awareMsg) throws IOException {
f@0: 		/* OSC message args = [diagram name, siagram event action source]*/
f@0: 		bundle = new CCmIOSCBundle(awareMsg.getTimestamp());
f@0: 		Object[] args = new Object[2];
f@0: 		args[0] = awareMsg.getDiagram();
f@0: 		args[1] = awareMsg.getSource().toString();
f@0: 		
f@0: 		bundle.addPacket(new OSCMessage(
f@0: 				OSC_NAME_PREFIX+awareMsg.getName().toString(),
f@0: 				args));
f@0: 		try{
f@0: 			writeBundle(channel);
f@0: 		}catch(IOException u){
f@0: 			throw new IOException(
f@0: 					/* give a more user friendly message */
f@0: 					ResourceBundle.getBundle(Server.class.getName()).getString("dialog.error.no_send"),u);
f@0: 		}
f@0: 	}
f@0: 
f@0: //	@Override
f@0: //	public Command receiveCommand(SocketChannel channel) throws IOException {
f@0: //		OSCBundle bundle = readBundle(channel);
f@0: //		OSCMessage oscMessage = (OSCMessage)bundle.getPacket(0);
f@0: //		String name = oscMessage.getName();
f@0: //		assert(name.startsWith(""+OSC_NAME_PREFIX));
f@0: //		name = name.substring(1); // chop off the trailing '/'
f@0: //		Object args[] = new Object[oscMessage.getArgCount()-CMD_OFFSET];			 
f@0: //		for(int i=0; i< args.length;i++)
f@0: //			args[i] = oscMessage.getArg(i+CMD_OFFSET);
f@0: //		return new Command(
f@0: //				Command.valueOf(name),
f@0: //				(String)oscMessage.getArg(CMD_DIAGRAM_INDEX),
f@0: //				args,
f@0: //				bundle.getTimeTag(),
f@0: //				DiagramEventSource.valueOf((String)oscMessage.getArg(CMD_SOURCE_INDEX))
f@0: //		);
f@0: //	}
f@0: 	
f@0: 	@Override
f@0: 	public Reply receiveReply(SocketChannel channel) throws IOException {
f@0: 		OSCBundle bundle = readBundle(channel);
f@0: 		OSCMessage oscMessage = (OSCMessage)bundle.getPacket(0);
f@0: 		String name = oscMessage.getName();
f@0: 		assert(name.startsWith(""+OSC_NAME_PREFIX));
f@0: 		name = name.substring(1); // chop off the trailing '/'
f@0: 		@SuppressWarnings("unused")
f@0: 		Integer len = (Integer)oscMessage.getArg(REPLY_LEN_INDEX); // of no use at the moment
f@0: 		return new Reply(
f@0: 				Reply.valueOf(name),
f@0: 				(String)oscMessage.getArg(REPLY_DIAGRAM_INDEX),
f@0: 				(String)oscMessage.getArg(REPLY_MESSAGE_INDEX),
f@0: 				bundle.getTimeTag(),
f@0: 				DiagramEventSource.valueOf((String)oscMessage.getArg(REPLY_SOURCE_INDEX)));
f@0: 	}
f@0: 	
f@0: 	@Override
f@0: 	public LockMessage receiveLockMessage(SocketChannel channel) throws IOException {
f@0: 		OSCBundle bundle = readBundle(channel);
f@0: 		OSCMessage oscMessage = (OSCMessage)bundle.getPacket(0);
f@0: 		String name = oscMessage.getName();
f@0: 		name = name.substring(1); // chop off the trailing '/'
f@0: 		Object args[] = new Object[oscMessage.getArgCount()-LOCK_OFFSET];			 
f@0: 		for(int i=0; i< args.length;i++)
f@0: 			args[i] = oscMessage.getArg(i+LOCK_OFFSET);
f@0: 		return new LockMessage(
f@0: 				LockMessage.valueOf(name),
f@0: 				bundle.getTimeTag(),
f@0: 				(String)oscMessage.getArg(LOCK_DIAGRAM_INDEX),
f@0: 				args,
f@0: 				DiagramEventActionSource.valueOf((String)oscMessage.getArg(LOCK_SOURCE_INDEX))
f@0: 				);
f@0: 	}
f@0: 	
f@0: 	public Message receiveMessage(SocketChannel channel) throws IOException {
f@0: 		OSCBundle bundle = readBundle(channel);
f@0: 		OSCMessage oscMessage = (OSCMessage)bundle.getPacket(0);
f@0: 		String name = oscMessage.getName();
f@0: 		assert(name.startsWith(""+OSC_NAME_PREFIX));
f@0: 		name = name.substring(1); // chop off the trailing '/'
f@0: 		if(name.endsWith(Reply.NAME_POSTFIX)){ // it's a reply 
f@0: 			@SuppressWarnings("unused")
f@0: 			Integer len = (Integer)oscMessage.getArg(REPLY_LEN_INDEX); // of no use at the moment
f@0: 			Reply reply = new Reply(
f@0: 					Reply.valueOf(name),
f@0: 					(String)oscMessage.getArg(REPLY_DIAGRAM_INDEX),
f@0: 					(String)oscMessage.getArg(REPLY_MESSAGE_INDEX),
f@0: 					bundle.getTimeTag(),
f@0: 					DiagramEventSource.valueOf((String)oscMessage.getArg(REPLY_SOURCE_INDEX)));
f@0: 			return reply;
f@0: 		}else if (name.endsWith(LockMessage.NAME_POSTFIX)){
f@0: 			Object args[] = new Object[oscMessage.getArgCount()-LOCK_OFFSET];			 
f@0: 			for(int i=0; i< args.length;i++)
f@0: 				args[i] = oscMessage.getArg(i+LOCK_OFFSET);
f@0: 			return new LockMessage(
f@0: 					LockMessage.valueOf(name),
f@0: 					bundle.getTimeTag(),
f@0: 					(String)oscMessage.getArg(LOCK_DIAGRAM_INDEX),
f@0: 					args,
f@0: 					DiagramEventActionSource.valueOf((String)oscMessage.getArg(LOCK_SOURCE_INDEX)) 
f@0: 					);
f@0: 		}else if(name.endsWith(AwarenessMessage.NAME_POSTFIX)){ // it's an awareness message 
f@0: 			AwarenessMessage.Name awName = AwarenessMessage.valueOf(name);
f@0: 			if(awName == AwarenessMessage.Name.USERNAME_A || awName == AwarenessMessage.Name.ERROR_A){
f@0: 				return new AwarenessMessage(awName,
f@0: 						(String)oscMessage.getArg(AWAR_DIAGRAM_INDEX),
f@0: 						(String)oscMessage.getArg(AWAR_SOURCE_INDEX)
f@0: 					);
f@0: 			}else {
f@0: 				return new AwarenessMessage(awName,
f@0: 						(String)oscMessage.getArg(AWAR_DIAGRAM_INDEX),
f@0: 						DiagramEventActionSource.valueOf((String)oscMessage.getArg(AWAR_SOURCE_INDEX))
f@0: 					);
f@0: 			}
f@0: 		}else{ // it's a command
f@0: 			Object args[] = new Object[oscMessage.getArgCount()-CMD_OFFSET];
f@0: 			for(int i=0; i< args.length;i++)
f@0: 				args[i] = oscMessage.getArg(i+CMD_OFFSET);
f@0: 			return new Command(
f@0: 					Command.valueOf(name),
f@0: 					(String)oscMessage.getArg(CMD_DIAGRAM_INDEX),
f@0: 					args,
f@0: 					bundle.getTimeTag(),
f@0: 					DiagramEventSource.valueOf((String)oscMessage.getArg(CMD_SOURCE_INDEX))
f@0: 			);
f@0: 		}
f@0: 	}
f@0: 	
f@0: 	private OSCBundle readBundle(SocketChannel channel) throws IOException{
f@0: 		/* read the size of the OSC packet, first 4 bytes according to OSC specs */
f@0: 		buffer.rewind().limit(4);
f@0: 		while( buffer.hasRemaining() )
f@0: 			if( channel.read( buffer ) == -1 )
f@0: 				throw new SocketException(ResourceBundle.getBundle(Server.class.getName()).getString("error.connection_close"));
f@0: 			
f@0: 		buffer.rewind();
f@0: 		int packetSize = buffer.getInt();
f@0: 		assert(packetSize > 0 );
f@0: 		ByteBuffer b = buffer;
f@0: 		/* if the packet is very big we must allocate an ad hoc temporary big big buffer */
f@0: 		if(packetSize <= DEFAULT_CAPACITY)
f@0: 			b.rewind().limit(packetSize);
f@0: 		else	
f@0: 			b = ByteBuffer.allocate(packetSize);
f@0: 		/* read the packet, it must be a bundle containing only one message */
f@0: 		while( b.hasRemaining() )
f@0: 			if( channel.read( b ) == -1 ) 
f@0: 				throw new SocketException(ResourceBundle.getBundle(Server.class.getName()).getString("error.connection_close"));
f@0: 		b.rewind();
f@0: 		return (OSCBundle)codec.decode(b);
f@0: 	}
f@0: 	
f@0: 	private void writeBundle(SocketChannel channel) throws IOException{
f@0: 		ByteBuffer b = buffer;
f@0: 		buffer.clear();
f@0: 		if(bundle.getSize() + 4 > DEFAULT_CAPACITY){
f@0: 			b = ByteBuffer.allocate(bundle.getSize() + 4);
f@0: 		}
f@0: 		b.position(4);
f@0: 		bundle.encode(codec,b);
f@0: 		int len = b.position() - 4;
f@0: 		b.putInt(0, len);
f@0: 		b.flip();
f@0: 		channel.write(b);
f@0: 	}
f@0: 	
f@0: 	ByteBuffer buffer;
f@0: 	CCmIOSCBundle bundle;
f@0: 	CCmIOSCPacketCodec codec;
f@0: 	
f@0: 	private static final int DEFAULT_CAPACITY = 1024;
f@0: 	private static final char OSC_NAME_PREFIX = '/';
f@0: 	
f@0: 	
f@0: 	private static final int REPLY_LEN_INDEX = 0;
f@0: 	/* position of the diagram Name in the OSC message */
f@0: 	private static final int REPLY_DIAGRAM_INDEX = 1;
f@0: 	private static final int REPLY_SOURCE_INDEX = 3;
f@0: 	private static final int CMD_DIAGRAM_INDEX = 0;
f@0: 	private static final int CMD_SOURCE_INDEX = 1;
f@0: 	private static final int CMD_OFFSET = 2;
f@0: 	private static final int LOCK_DIAGRAM_INDEX = 0;
f@0: 	private static final int LOCK_SOURCE_INDEX = 1;
f@0: 	private static final int LOCK_OFFSET = 2;
f@0: 	private static final int AWAR_DIAGRAM_INDEX = 0;
f@0: 	private static final int AWAR_SOURCE_INDEX = 1;
f@0: 	/* ------------------------------------------------*/
f@0: 	private static final int REPLY_MESSAGE_INDEX = 2;
f@0: }