aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorDr Scofield2008-06-04 13:06:24 +0000
committerDr Scofield2008-06-04 13:06:24 +0000
commit67dee6410dcb982b899ec0bb9644d5afa4a8e2d1 (patch)
tree1bad930de9ec6088b6ce8695c028668f54a6ac4d
parentapplied patch from mantis #1268 , thanks mikem (diff)
downloadopensim-SC-67dee6410dcb982b899ec0bb9644d5afa4a8e2d1.zip
opensim-SC-67dee6410dcb982b899ec0bb9644d5afa4a8e2d1.tar.gz
opensim-SC-67dee6410dcb982b899ec0bb9644d5afa4a8e2d1.tar.bz2
opensim-SC-67dee6410dcb982b899ec0bb9644d5afa4a8e2d1.tar.xz
* fleshing out XMPP entities, adding XmppWriter and XmppSerializer
having spent the last couple of days wrestling with .NET XmlSerializer and trying to get it to do what is required by XMPP (RFC 3920 & 3921) this is the preliminary result of that wrestling (you should see the other guy!): XmppSerializer allows us to serialize Xmpp stanza (and theoretically deserialize [or reify] them), XmppWriter helps avoiding various gratuitous crap added in by off-the-shelf XmlSerializer. this is currently not used anywhere but the plan is to use it for at least an XMPPBridgeModule.
-rw-r--r--OpenSim/Framework/Communications/XMPP/XmppError.cs (renamed from OpenSim/Framework/Communications/XMPP/XMPPParser.cs)11
-rw-r--r--OpenSim/Framework/Communications/XMPP/XmppIqStanza.cs62
-rw-r--r--OpenSim/Framework/Communications/XMPP/XmppMessageStanza.cs90
-rw-r--r--OpenSim/Framework/Communications/XMPP/XmppSerializer.cs65
-rw-r--r--OpenSim/Framework/Communications/XMPP/XmppStanza.cs71
-rw-r--r--OpenSim/Framework/Communications/XMPP/XmppWriter.cs (renamed from OpenSim/Framework/Communications/XMPP/Stanza.cs)33
6 files changed, 315 insertions, 17 deletions
diff --git a/OpenSim/Framework/Communications/XMPP/XMPPParser.cs b/OpenSim/Framework/Communications/XMPP/XmppError.cs
index 26a78b2..1698b6a 100644
--- a/OpenSim/Framework/Communications/XMPP/XMPPParser.cs
+++ b/OpenSim/Framework/Communications/XMPP/XmppError.cs
@@ -25,10 +25,17 @@
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */ 26 */
27 27
28using System;
29using System.Xml;
30using System.Xml.Serialization;
31
28namespace OpenSim.Framework.Communications.XMPP 32namespace OpenSim.Framework.Communications.XMPP
29{ 33{
30 public class XMPPParser 34 [XmlRoot("error")]
35 public class XmppErrorStanza
31 { 36 {
32 37 public XmppErrorStanza()
38 {
39 }
33 } 40 }
34} 41}
diff --git a/OpenSim/Framework/Communications/XMPP/XmppIqStanza.cs b/OpenSim/Framework/Communications/XMPP/XmppIqStanza.cs
new file mode 100644
index 0000000..1789536
--- /dev/null
+++ b/OpenSim/Framework/Communications/XMPP/XmppIqStanza.cs
@@ -0,0 +1,62 @@
1/*
2 * Copyright (c) Contributors, http://opensimulator.org/
3 * See CONTRIBUTORS.TXT for a full list of copyright holders.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the OpenSim Project nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28using System;
29using System.Xml;
30using System.Xml.Serialization;
31
32namespace OpenSim.Framework.Communications.XMPP
33{
34 /// <summary>
35 /// An IQ needs to have one of the follow types set.
36 /// </summary>
37 public enum XmppIqType
38 {
39 [XmlEnum("set")] set,
40 [XmlEnum("get")] get,
41 [XmlEnum("result")] result,
42 [XmlEnum("error")] error,
43 }
44
45 /// <summary>
46 /// XmppIqStanza needs to be subclassed as the query content is
47 /// specific to the query type.
48 /// </summary>
49 [XmlRoot("iq")]
50 public abstract class XmppIqStanza: XmppStanza
51 {
52 /// <summary>
53 /// IQ type: one of set, get, result, error
54 /// </summary>
55 [XmlAttribute("type")]
56 public XmppIqType Type;
57
58 public XmppIqStanza(): base()
59 {
60 }
61 }
62}
diff --git a/OpenSim/Framework/Communications/XMPP/XmppMessageStanza.cs b/OpenSim/Framework/Communications/XMPP/XmppMessageStanza.cs
new file mode 100644
index 0000000..e80c0aa
--- /dev/null
+++ b/OpenSim/Framework/Communications/XMPP/XmppMessageStanza.cs
@@ -0,0 +1,90 @@
1/*
2 * Copyright (c) Contributors, http://opensimulator.org/
3 * See CONTRIBUTORS.TXT for a full list of copyright holders.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the OpenSim Project nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28using System;
29using System.Xml;
30using System.Xml.Serialization;
31
32namespace OpenSim.Framework.Communications.XMPP
33{
34 /// <summary>
35 /// Message types.
36 /// </summary>
37 public enum XmppMessageType
38 {
39 [XmlEnum("chat")] chat,
40 [XmlEnum("error")] error,
41 [XmlEnum("groupchat")] groupchat,
42 [XmlEnum("headline")] headline,
43 [XmlEnum("normal")] normal,
44 }
45
46 /// <summary>
47 /// Message body.
48 /// </summary>
49 public class XmppMessageBody
50 {
51 [XmlText]
52 public string Text;
53
54 public XmppMessageBody()
55 {
56 }
57
58 public XmppMessageBody(string message)
59 {
60 Text = message;
61 }
62 }
63
64 [XmlRoot("message")]
65 public class XmppMessageStanza: XmppStanza
66 {
67 /// <summary>
68 /// IQ type: one of set, get, result, error
69 /// </summary>
70 [XmlAttribute("type")]
71 public XmppMessageType MessageType;
72
73 // [XmlAttribute("error")]
74 // public XmppError Error;
75
76 [XmlElement("body")]
77 public XmppMessageBody Body;
78
79 public XmppMessageStanza() : base()
80 {
81 }
82
83 public XmppMessageStanza(string fromJid, string toJid, XmppMessageType mType, string message) :
84 base(fromJid, toJid)
85 {
86 MessageType = mType;
87 Body = new XmppMessageBody(message);
88 }
89 }
90}
diff --git a/OpenSim/Framework/Communications/XMPP/XmppSerializer.cs b/OpenSim/Framework/Communications/XMPP/XmppSerializer.cs
new file mode 100644
index 0000000..f0d2cd5
--- /dev/null
+++ b/OpenSim/Framework/Communications/XMPP/XmppSerializer.cs
@@ -0,0 +1,65 @@
1/*
2 * Copyright (c) Contributors, http://opensimulator.org/
3 * See CONTRIBUTORS.TXT for a full list of copyright holders.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the OpenSim Project nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28using System;
29using System.Collections.Generic;
30using System.IO;
31using System.Text;
32using System.Xml;
33using System.Xml.Serialization;
34
35namespace OpenSim.Framework.Communications.XMPP
36{
37 public class XMPPSerializer
38 {
39 // need to do it this way, as XmlSerializer(type, extratypes)
40 // does not work on mono (at least).
41 private Dictionary<Type, XmlSerializer> _serializers = new Dictionary<Type, XmlSerializer>();
42 private XmlSerializerNamespaces _xmlNs;
43 private string _defaultNS;
44
45 public XMPPSerializer(bool server)
46 {
47 _xmlNs = new XmlSerializerNamespaces();
48 _xmlNs.Add(String.Empty, String.Empty);
49 if (server)
50 _defaultNS = "jabber:server";
51 else
52 _defaultNS = "jabber:client";
53
54 _serializers[typeof(XmppMessageStanza)] = new XmlSerializer(typeof(XmppMessageStanza), _defaultNS);
55 }
56
57 public void Serialize(XmlWriter xw, object o)
58 {
59 if (!_serializers.ContainsKey(o.GetType()))
60 throw new ArgumentException(String.Format("no serializer available for type {0}", o.GetType()));
61
62 _serializers[o.GetType()].Serialize(xw, o, _xmlNs);
63 }
64 }
65}
diff --git a/OpenSim/Framework/Communications/XMPP/XmppStanza.cs b/OpenSim/Framework/Communications/XMPP/XmppStanza.cs
new file mode 100644
index 0000000..00df14a
--- /dev/null
+++ b/OpenSim/Framework/Communications/XMPP/XmppStanza.cs
@@ -0,0 +1,71 @@
1/*
2 * Copyright (c) Contributors, http://opensimulator.org/
3 * See CONTRIBUTORS.TXT for a full list of copyright holders.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the OpenSim Project nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28using System;
29using System.Xml;
30using System.Xml.Serialization;
31
32namespace OpenSim.Framework.Communications.XMPP
33{
34 public abstract class XmppStanza
35 {
36 /// <summary>
37 /// counter used for generating ID
38 /// </summary>
39 [XmlIgnore]
40 private static ulong _ctr = 0;
41
42 /// <summary>
43 /// recipient JID
44 /// </summary>
45 [XmlAttribute("to")]
46 public string ToJid;
47
48 /// <summary>
49 /// sender JID
50 /// </summary>
51 [XmlAttribute("from")]
52 public string FromJid;
53
54 /// <summary>
55 /// unique ID.
56 /// </summary>
57 [XmlAttribute("id")]
58 public string MessageId;
59
60 public XmppStanza()
61 {
62 }
63
64 public XmppStanza(string fromJid, string toJid)
65 {
66 ToJid = toJid;
67 FromJid = fromJid;
68 MessageId = String.Format("OpenSim_{0}{1}", DateTime.UtcNow.Ticks, _ctr++);
69 }
70 }
71}
diff --git a/OpenSim/Framework/Communications/XMPP/Stanza.cs b/OpenSim/Framework/Communications/XMPP/XmppWriter.cs
index 3930bac..c5ad9b4 100644
--- a/OpenSim/Framework/Communications/XMPP/Stanza.cs
+++ b/OpenSim/Framework/Communications/XMPP/XmppWriter.cs
@@ -25,31 +25,34 @@
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */ 26 */
27 27
28using System; 28using System.IO;
29using System.Text;
29using System.Xml; 30using System.Xml;
30 31
32using IOStream = System.IO.Stream;
33
31namespace OpenSim.Framework.Communications.XMPP 34namespace OpenSim.Framework.Communications.XMPP
32{ 35{
33 public class Stanza 36 public class XMPPWriter: XmlTextWriter
34 { 37 {
35 public string localName = String.Empty; 38 public XMPPWriter(TextWriter textWriter) : base(textWriter)
36 public JId to; 39 {
37 public JId from; 40 }
38 public string id;
39 public string lang;
40 public string nodeName;
41 41
42 public Stanza(XmlNode node, Object defaults, bool hasID) 42 public XMPPWriter(IOStream stream) : this(stream, Encoding.UTF8)
43 { 43 {
44 }
44 45
46 public XMPPWriter(IOStream stream, Encoding enc) : base(stream, enc)
47 {
45 } 48 }
46 //public virtual XmlElement getNode() 49
47 //{ 50 public override void WriteStartDocument()
48 //return new XmlElement(); 51 {
49 //} 52 }
50 public virtual string generateId() 53
54 public override void WriteStartDocument(bool standalone)
51 { 55 {
52 return "";
53 } 56 }
54 } 57 }
55} 58}