WebSVN – HomeAutomation – Diff – /trunk/MacBeth/src/Macbeth/System/MbPacket.java


/*
 * MbPacket.java
 *
 * Created on den 24 augusti 2003, 12:55
 */
package Macbeth.System;
 
import Macbeth.XML.XMLDataHandler;
import Macbeth.XML.XMLParser;
import Macbeth.Utilities.MySystem;
import java.util.Iterator;
import java.util.HashMap;
import java.io.IOException;
 
import org.xml.sax.SAXException;
 
/**
 * This class represents a Macbeth packet, containing both its destination,
 * its source, and its contents.
 * @author Jimmy
 */
public class MbPacket {
 
    /**
     * The Macbeth location to which this packet is addressed.
     * If the kernel-field is set to "self", it means that
     * the packet will be delivered locally only (that is,
     * within the same kernel it was sent from). If the field
     * is set to something else, however, this name will be
     * looked up in the list of known kernels, which, in case
     * the kernel was found, also provides the internet address
     * of the specified kernel.
     */
    private MbLocation destination;
 
    /**
     * The Macbeth location from which this packet was sent.
     * This can be used by receiver module (or kernel)
     * to identify the sender.
     */
    private MbLocation source;
 
    /**
     * The packet contents (an XML-document).
     */
    private String contents;
 
    /**
     * The remote address of the client that sent us this packet.
     * If the packet has never been transported via any networks,
     * this value is "self" (that is, source kernel and dest kernel
     * are equal).
     */
    private String originAddress;
 
    /**
     * Gets the destination of this packet.
     * @return The packet destination.
     */
    public MbLocation getDestination() {
        return destination;
    }
    /**
     * Sets the destination of this packet.
     * @param destination The new destination.
     */
    public void setDestination(MbLocation destination) {
        this.destination = destination;
    }
    /**
     * Sets the kernel field in the destination of this packet.
     * @param kernel The new destination kernel.
     */
    public void setDestinationKernel(String kernel) {
        destination.setKernel(kernel);
    }
    /**
     * Sets the module field in the destination of this packet.
     * @param module The new destination module.
     */
    public void setDestinationModule(String module) {
        destination.setModule(module);
    }
 
    /**
     * Gets the source of this packet.
     * @return The packet source.
     */
    public MbLocation getSource() {
        return source;
    }
    /**
     * Sets the source of this packet.
     * @param source The new packet source.
     */
    public void setSource(MbLocation source) {
        this.source = source;
    }
 
    /**
     * Gets the packet contents. This is an XML-string.
     * @return The packet contents.
     */
    public synchronized String getContents() {
        return contents;
    }
    /**
     * Sets the packet contents. This must be valid XML-data.
     * @param contents The new packet contents.
     */
    public synchronized void setContents(String contents) {
        this.contents = contents;
    }
    /**
     * Appends a string to the packet contents. This must be
     * valid XML-data.
     * @param s The string to append.
     */
    public synchronized void appendContents(String s) {
        this.contents += s;
    }
 
    /**
     * Gets the source remote address of this packet.
     * @return The remote address of the packet source.
     */
    public synchronized String getOriginAddress() {
        return originAddress;
    }
 
    /**
     * Creates a new instance of MbPacket.
     */
    public MbPacket() {
        destination = new MbLocation();
        source = new MbLocation();
        originAddress = "self";
        contents = "";
    }
 
    /**
     * Serializes this packet into a string object (XML-formatted)
     * @return the packet as an XML-string.
     */
    public String serializeToString() {
        String s = "<mbpacket ";
        s += "sourcekernel=\"" + source.getKernel() + "\" ";
        s += "sourcemodule=\"" + source.getModule() + "\" ";
        //s += "destkernel=\"" + destination.kernel + "\" ";
        s += "destmodule=\"" + destination.getModule() + "\" ";
        s += ">" + MySystem.lineBreak;
        s += contents;
        s += MySystem.lineBreak + "</mbpacket>";
        return s;
    }
 
    /**
     * Tries to deserialize an XML-string into a packet.
     * The format of the string must be:
     * <mbpacket destmodule="modulename">
     *     Only valid XML-data in here!
     * </mbpacket>
     * or else this function will not succeed.
     * @param s The XML-string
     * @return true if successful, false otherwise.
     * @throws SAXException if the string contains an invalid XML document (syntax errors).
     */
    synchronized public boolean createFromString(String s) throws SAXException {
        //destination kernel is always set to "self"
        destination = new MbLocation("self",null);
        source = new MbLocation("external","external");
        contents = "";
        XMLParser xmlParser = new XMLParser(new DataHandler());
        try {
            xmlParser.parseString(s);
        } catch (IOException e) {
            System.err.println(e);
            e.printStackTrace();
            return false;
        }
        //TODO: why check this? can it happen?
        if (destination==null) {
            return false;
        }
        return true;
    }
 
    /**
     * A data handler for XML parser.
     */
    private class DataHandler implements XMLDataHandler {
        //current element name
        private String currentElement = null;
        //current data for the element
        private String currentElementData = null;
 
        public void XMLstartElement(String element, HashMap attributes) {
            currentElementData = null;
            if (element.equals("mbpacket")) {
                if (attributes.containsKey("sourcekernel")) {
                    source.setKernel((String)attributes.get("sourcekernel"));
                }
                if (attributes.containsKey("sourcemodule")) {
                    source.setModule((String)attributes.get("sourcemodule"));
                }
                if (attributes.containsKey("destmodule")) {
                    destination.setModule((String)attributes.get("destmodule"));
                }
                // NOTE: destination kernel is IGNORED in all incoming packets!
                // (for security reasons, since no relaying is allowed. destkernel is always set to "self")
            } else if (element.equals("remoteaddress") && originAddress.equals("self")) {
                //(it must equal self, or else it can be set more than once, and can thus be faked)
                //remember remote address
                if (attributes.containsKey("value")) {
                    originAddress = (String)attributes.get("value");
                }
            } else {
                //this is user data, so put it into the contents field
                currentElement = element;
                contents += "<" + element;
                Iterator it = attributes.keySet().iterator();
                while (it.hasNext()) {
                    String key = (String)it.next();
                    contents += " " + key + "=\"" + attributes.get(key) + "\"";
                }
                //NEW CODE:
                contents += ">";
            }
        }
        public void XMLelementData(String data) {
            //NEW CODE
            if (currentElement!=null) {
                contents += MySystem.lineBreak + data;
                currentElementData = data;
            }
        }
        public void XMLendElement(String element) {
            if (!element.equals("remoteaddress") && !element.equals("mbpacket")) {
                //NEW CODE:
                //always add full end tag
                //TODO: maybe fix this again. OLD CODE caused some ">" to be missing though!
                contents += "</" + element + ">";
            }
            currentElement = null;
        }
        public void XMLdocumentStart() {}
        public void XMLdocumentEnd() {}
    }
}
 

Subversion Repositories HomeAutomation

(root)/trunk/MacBeth/src/Macbeth/System/MbPacket.java @ 73 – Rev 15 → 73

Rev 15		Rev 73
1	/*	1	/*
2	* MbPacket.java	2	* MbPacket.java
3	*	3	*
4	* Created on den 24 augusti 2003, 12:55	4	* Created on den 24 augusti 2003, 12:55
5	*/	5	*/
6	package Macbeth.System;	6	package Macbeth.System;
7		7
8	import Macbeth.XML.XMLDataHandler;	8	import Macbeth.XML.XMLDataHandler;
9	import Macbeth.XML.XMLParser;	9	import Macbeth.XML.XMLParser;
10	import Macbeth.Utilities.MySystem;	10	import Macbeth.Utilities.MySystem;
11	import java.util.Iterator;	11	import java.util.Iterator;
12	import java.util.HashMap;	12	import java.util.HashMap;
13	import java.io.IOException;	13	import java.io.IOException;
14		14
15	import org.xml.sax.SAXException;	15	import org.xml.sax.SAXException;
16		16
17	/**	17	/**
18	* This class represents a Macbeth packet, containing both its destination,	18	* This class represents a Macbeth packet, containing both its destination,
19	* its source, and its contents.	19	* its source, and its contents.
20	* @author Jimmy	20	* @author Jimmy
21	*/	21	*/
22	public class MbPacket {	22	public class MbPacket {
23		23
24	/**	24	/**
25	* The Macbeth location to which this packet is addressed.	25	* The Macbeth location to which this packet is addressed.
26	* If the kernel-field is set to "self", it means that	26	* If the kernel-field is set to "self", it means that
27	* the packet will be delivered locally only (that is,	27	* the packet will be delivered locally only (that is,
28	* within the same kernel it was sent from). If the field	28	* within the same kernel it was sent from). If the field
29	* is set to something else, however, this name will be	29	* is set to something else, however, this name will be
30	* looked up in the list of known kernels, which, in case	30	* looked up in the list of known kernels, which, in case
31	* the kernel was found, also provides the internet address	31	* the kernel was found, also provides the internet address
32	* of the specified kernel.	32	* of the specified kernel.
33	*/	33	*/
34	private MbLocation destination;	34	private MbLocation destination;
35		35
36	/**	36	/**
37	* The Macbeth location from which this packet was sent.	37	* The Macbeth location from which this packet was sent.
38	* This can be used by receiver module (or kernel)	38	* This can be used by receiver module (or kernel)
39	* to identify the sender.	39	* to identify the sender.
40	*/	40	*/
41	private MbLocation source;	41	private MbLocation source;
42		42
43	/**	43	/**
44	* The packet contents (an XML-document).	44	* The packet contents (an XML-document).
45	*/	45	*/
46	private String contents;	46	private String contents;
47		47
48	/**	48	/**
49	* The remote address of the client that sent us this packet.	49	* The remote address of the client that sent us this packet.
50	* If the packet has never been transported via any networks,	50	* If the packet has never been transported via any networks,
51	* this value is "self" (that is, source kernel and dest kernel	51	* this value is "self" (that is, source kernel and dest kernel
52	* are equal).	52	* are equal).
53	*/	53	*/
54	private String originAddress;	54	private String originAddress;
55		55
56	/**	56	/**
57	* Gets the destination of this packet.	57	* Gets the destination of this packet.
58	* @return The packet destination.	58	* @return The packet destination.
59	*/	59	*/
60	public MbLocation getDestination() {	60	public MbLocation getDestination() {
61	return destination;	61	return destination;
62	}	62	}
63	/**	63	/**
64	* Sets the destination of this packet.	64	* Sets the destination of this packet.
65	* @param destination The new destination.	65	* @param destination The new destination.
66	*/	66	*/
67	public void setDestination(MbLocation destination) {	67	public void setDestination(MbLocation destination) {
68	this.destination = destination;	68	this.destination = destination;
69	}	69	}
70	/**	70	/**
71	* Sets the kernel field in the destination of this packet.	71	* Sets the kernel field in the destination of this packet.
72	* @param kernel The new destination kernel.	72	* @param kernel The new destination kernel.
73	*/	73	*/
74	public void setDestinationKernel(String kernel) {	74	public void setDestinationKernel(String kernel) {
75	destination.setKernel(kernel);	75	destination.setKernel(kernel);
76	}	76	}
77	/**	77	/**
78	* Sets the module field in the destination of this packet.	78	* Sets the module field in the destination of this packet.
79	* @param module The new destination module.	79	* @param module The new destination module.
80	*/	80	*/
81	public void setDestinationModule(String module) {	81	public void setDestinationModule(String module) {
82	destination.setModule(module);	82	destination.setModule(module);
83	}	83	}
84		84
85	/**	85	/**
86	* Gets the source of this packet.	86	* Gets the source of this packet.
87	* @return The packet source.	87	* @return The packet source.
88	*/	88	*/
89	public MbLocation getSource() {	89	public MbLocation getSource() {
90	return source;	90	return source;
91	}	91	}
92	/**	92	/**
93	* Sets the source of this packet.	93	* Sets the source of this packet.
94	* @param source The new packet source.	94	* @param source The new packet source.
95	*/	95	*/
96	public void setSource(MbLocation source) {	96	public void setSource(MbLocation source) {
97	this.source = source;	97	this.source = source;
98	}	98	}
99		99
100	/**	100	/**
101	* Gets the packet contents. This is an XML-string.	101	* Gets the packet contents. This is an XML-string.
102	* @return The packet contents.	102	* @return The packet contents.
103	*/	103	*/
104	public synchronized String getContents() {	104	public synchronized String getContents() {
105	return contents;	105	return contents;
106	}	106	}
107	/**	107	/**
108	* Sets the packet contents. This must be valid XML-data.	108	* Sets the packet contents. This must be valid XML-data.
109	* @param contents The new packet contents.	109	* @param contents The new packet contents.
110	*/	110	*/
111	public synchronized void setContents(String contents) {	111	public synchronized void setContents(String contents) {
112	this.contents = contents;	112	this.contents = contents;
113	}	113	}
114	/**	114	/**
115	* Appends a string to the packet contents. This must be	115	* Appends a string to the packet contents. This must be
116	* valid XML-data.	116	* valid XML-data.
117	* @param s The string to append.	117	* @param s The string to append.
118	*/	118	*/
119	public synchronized void appendContents(String s) {	119	public synchronized void appendContents(String s) {
120	this.contents += s;	120	this.contents += s;
121	}	121	}
122		122
123	/**	123	/**
124	* Gets the source remote address of this packet.	124	* Gets the source remote address of this packet.
125	* @return The remote address of the packet source.	125	* @return The remote address of the packet source.
126	*/	126	*/
127	public synchronized String getOriginAddress() {	127	public synchronized String getOriginAddress() {
128	return originAddress;	128	return originAddress;
129	}	129	}
130		130
131	/**	131	/**
132	* Creates a new instance of MbPacket.	132	* Creates a new instance of MbPacket.
133	*/	133	*/
134	public MbPacket() {	134	public MbPacket() {
135	destination = new MbLocation();	135	destination = new MbLocation();
136	source = new MbLocation();	136	source = new MbLocation();
137	originAddress = "self";	137	originAddress = "self";
138	contents = "";	138	contents = "";
139	}	139	}
140		140
141	/**	141	/**
142	* Serializes this packet into a string object (XML-formatted)	142	* Serializes this packet into a string object (XML-formatted)
143	* @return the packet as an XML-string.	143	* @return the packet as an XML-string.
144	*/	144	*/
145	public String serializeToString() {	145	public String serializeToString() {
146	String s = "<mbpacket ";	146	String s = "<mbpacket ";
147	s += "sourcekernel=\"" + source.getKernel() + "\" ";	147	s += "sourcekernel=\"" + source.getKernel() + "\" ";
148	s += "sourcemodule=\"" + source.getModule() + "\" ";	148	s += "sourcemodule=\"" + source.getModule() + "\" ";
149	//s += "destkernel=\"" + destination.kernel + "\" ";	149	//s += "destkernel=\"" + destination.kernel + "\" ";
150	s += "destmodule=\"" + destination.getModule() + "\" ";	150	s += "destmodule=\"" + destination.getModule() + "\" ";
151	s += ">" + MySystem.lineBreak;	151	s += ">" + MySystem.lineBreak;
152	s += contents;	152	s += contents;
153	s += MySystem.lineBreak + "</mbpacket>";	153	s += MySystem.lineBreak + "</mbpacket>";
154	return s;	154	return s;
155	}	155	}
156		156
157	/**	157	/**
158	* Tries to deserialize an XML-string into a packet.	158	* Tries to deserialize an XML-string into a packet.
159	* The format of the string must be:	159	* The format of the string must be:
160	* <mbpacket destmodule="modulename">	160	* <mbpacket destmodule="modulename">
161	* Only valid XML-data in here!	161	* Only valid XML-data in here!
162	* </mbpacket>	162	* </mbpacket>
163	* or else this function will not succeed.	163	* or else this function will not succeed.
164	* @param s The XML-string	164	* @param s The XML-string
165	* @return true if successful, false otherwise.	165	* @return true if successful, false otherwise.
166	* @throws SAXException if the string contains an invalid XML document (syntax errors).	166	* @throws SAXException if the string contains an invalid XML document (syntax errors).
167	*/	167	*/
168	synchronized public boolean createFromString(String s) throws SAXException {	168	synchronized public boolean createFromString(String s) throws SAXException {
169	//destination kernel is always set to "self"	169	//destination kernel is always set to "self"
170	destination = new MbLocation("self",null);	170	destination = new MbLocation("self",null);
171	source = new MbLocation("external","external");	171	source = new MbLocation("external","external");
172	contents = "";	172	contents = "";
173	XMLParser xmlParser = new XMLParser(new DataHandler());	173	XMLParser xmlParser = new XMLParser(new DataHandler());
174	try {	174	try {
175	xmlParser.parseString(s);	175	xmlParser.parseString(s);
176	} catch (IOException e) {	176	} catch (IOException e) {
177	System.err.println(e);	177	System.err.println(e);
178	e.printStackTrace();	178	e.printStackTrace();
179	return false;	179	return false;
180	}	180	}
181	//TODO: why check this? can it happen?	181	//TODO: why check this? can it happen?
182	if (destination==null) {	182	if (destination==null) {
183	return false;	183	return false;
184	}	184	}
185	return true;	185	return true;
186	}	186	}
187		187
188	/**	188	/**
189	* A data handler for XML parser.	189	* A data handler for XML parser.
190	*/	190	*/
191	private class DataHandler implements XMLDataHandler {	191	private class DataHandler implements XMLDataHandler {
192	//current element name	192	//current element name
193	private String currentElement = null;	193	private String currentElement = null;
194	//current data for the element	194	//current data for the element
195	private String currentElementData = null;	195	private String currentElementData = null;
196		196
197	public void XMLstartElement(String element, HashMap attributes) {	197	public void XMLstartElement(String element, HashMap attributes) {
198	currentElementData = null;	198	currentElementData = null;
199	if (element.equals("mbpacket")) {	199	if (element.equals("mbpacket")) {
200	if (attributes.containsKey("sourcekernel")) {	200	if (attributes.containsKey("sourcekernel")) {
201	source.setKernel((String)attributes.get("sourcekernel"));	201	source.setKernel((String)attributes.get("sourcekernel"));
202	}	202	}
203	if (attributes.containsKey("sourcemodule")) {	203	if (attributes.containsKey("sourcemodule")) {
204	source.setModule((String)attributes.get("sourcemodule"));	204	source.setModule((String)attributes.get("sourcemodule"));
205	}	205	}
206	if (attributes.containsKey("destmodule")) {	206	if (attributes.containsKey("destmodule")) {
207	destination.setModule((String)attributes.get("destmodule"));	207	destination.setModule((String)attributes.get("destmodule"));
208	}	208	}
209	// NOTE: destination kernel is IGNORED in all incoming packets!	209	// NOTE: destination kernel is IGNORED in all incoming packets!
210	// (for security reasons, since no relaying is allowed. destkernel is always set to "self")	210	// (for security reasons, since no relaying is allowed. destkernel is always set to "self")
211	} else if (element.equals("remoteaddress") && originAddress.equals("self")) {	211	} else if (element.equals("remoteaddress") && originAddress.equals("self")) {
212	//(it must equal self, or else it can be set more than once, and can thus be faked)	212	//(it must equal self, or else it can be set more than once, and can thus be faked)
213	//remember remote address	213	//remember remote address
214	if (attributes.containsKey("value")) {	214	if (attributes.containsKey("value")) {
215	originAddress = (String)attributes.get("value");	215	originAddress = (String)attributes.get("value");
216	}	216	}
217	} else {	217	} else {
218	//this is user data, so put it into the contents field	218	//this is user data, so put it into the contents field
219	currentElement = element;	219	currentElement = element;
220	contents += "<" + element;	220	contents += "<" + element;
221	Iterator it = attributes.keySet().iterator();	221	Iterator it = attributes.keySet().iterator();
222	while (it.hasNext()) {	222	while (it.hasNext()) {
223	String key = (String)it.next();	223	String key = (String)it.next();
224	contents += " " + key + "=\"" + attributes.get(key) + "\"";	224	contents += " " + key + "=\"" + attributes.get(key) + "\"";
225	}	225	}
226	//NEW CODE:	226	//NEW CODE:
227	contents += ">";	227	contents += ">";
228	}	228	}
229	}	229	}
230	public void XMLelementData(String data) {	230	public void XMLelementData(String data) {
231	//NEW CODE	231	//NEW CODE
232	if (currentElement!=null) {	232	if (currentElement!=null) {
233	contents += MySystem.lineBreak + data;	233	contents += MySystem.lineBreak + data;
234	currentElementData = data;	234	currentElementData = data;
235	}	235	}
236	}	236	}
237	public void XMLendElement(String element) {	237	public void XMLendElement(String element) {
238	if (!element.equals("remoteaddress") && !element.equals("mbpacket")) {	238	if (!element.equals("remoteaddress") && !element.equals("mbpacket")) {
239	//NEW CODE:	239	//NEW CODE:
240	//always add full end tag	240	//always add full end tag
241	//TODO: maybe fix this again. OLD CODE caused some ">" to be missing though!	241	//TODO: maybe fix this again. OLD CODE caused some ">" to be missing though!
242	contents += "</" + element + ">";	242	contents += "</" + element + ">";
243	}	243	}
244	currentElement = null;	244	currentElement = null;
245	}	245	}
246	public void XMLdocumentStart() {}	246	public void XMLdocumentStart() {}
247	public void XMLdocumentEnd() {}	247	public void XMLdocumentEnd() {}
248	}	248	}
249	}	249	}
250		250