aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Framework/DAMap.cs
blob: c25623065ad7ad6ea8bfa4148a545acc05c20eb4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
/*
 * Copyright (c) Contributors, http://opensimulator.org/
 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the OpenSimulator Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Text;
using System.Xml;
using System.Xml.Schema;
using System.Xml.Serialization;
using OpenMetaverse;
using OpenMetaverse.StructuredData;

namespace OpenSim.Framework
{
    /// <summary>
    /// This class stores and retrieves dynamic attributes.
    /// </summary>
    /// <remarks>
    /// Modules that want to use dynamic attributes need to do so in a private data store
    /// which is accessed using a unique name. DAMap provides access to the data stores,
    /// each of which is an OSDMap. Modules are free to store any type of data they want
    /// within their data store. However, avoid storing large amounts of data because that
    /// would slow down database access.
    /// </remarks>
    public class DAMap : IDictionary<string, OSDMap>, IXmlSerializable
    {
        private static readonly int MIN_STORE_NAME_LENGTH = 4;

        protected OSDMap m_map;
        
        public DAMap() { m_map = new OSDMap(); }
        
        public XmlSchema GetSchema() { return null; } 

        public static DAMap FromXml(string rawXml)
        {
            DAMap map = new DAMap();
            map.ReadXml(rawXml);
            return map;
        }
        
        public void ReadXml(string rawXml)
        {            
            //System.Console.WriteLine("Trying to deserialize [{0}]", rawXml);
            
            lock (this)
                m_map = (OSDMap)OSDParser.DeserializeLLSDXml(rawXml);         
        }
        
        public void ReadXml(XmlReader reader)
        { 
            ReadXml(reader.ReadInnerXml());            
        }
        
        public string ToXml()
        {
            lock (this)
                return OSDParser.SerializeLLSDXmlString(m_map);
        }

        public void WriteXml(XmlWriter writer)
        {
            writer.WriteRaw(ToXml());
        }                             

        /// <summary>
        /// Returns the number of data stores.
        /// </summary>
        public int Count { get { lock (this) { return m_map.Count; } } }
        
        public bool IsReadOnly { get { return false; } }
        
        /// <summary>
        /// Returns the names of the data stores.
        /// </summary>
        public ICollection<string> Keys { get { lock (this) { return m_map.Keys; } } }

        /// <summary>
        /// Returns all the data stores.
        /// </summary>
        public ICollection<OSDMap> Values
        {
            get
            {
                lock (this)
                {
                    List<OSDMap> stores = new List<OSDMap>(m_map.Count);
                    foreach (OSD llsd in m_map.Values)
                        stores.Add((OSDMap)llsd);
                    return stores;
                }
            }
        }
        
        /// <summary>
        /// Gets or sets one data store.
        /// </summary>
        /// <param name="key">Store name</param>
        /// <returns></returns>
        public OSDMap this[string key] 
        {    
            get  
            {                    
                OSD llsd;
                
                lock (this)
                {
                    if (m_map.TryGetValue(key, out llsd))
                        return (OSDMap)llsd;
                    else 
                        return null;
                }
            }    
            
            set
            {
                ValidateKey(key);
                lock (this)
                    m_map[key] = value;
            }
        }

        private static void ValidateKey(string key)
        {
            if (key.Length < MIN_STORE_NAME_LENGTH)
                throw new Exception("Minimum store name length is " + MIN_STORE_NAME_LENGTH);
        }

        public bool ContainsKey(string key) 
        {    
            lock (this)
                return m_map.ContainsKey(key);
        }    

        public void Add(string key, OSDMap store)
        {
            ValidateKey(key);
            lock (this)
                m_map.Add(key, store);
        }    

        public void Add(KeyValuePair<string, OSDMap> kvp) 
        {    
            lock (this)
                m_map.Add(kvp.Key, kvp.Value);
        }    

        public bool Remove(string key) 
        {    
            lock (this)
                return m_map.Remove(key);
        }    

        public bool TryGetValue(string key, out OSDMap store)
        {
            lock (this)
            {
                OSD llsd;
                if (m_map.TryGetValue(key, out llsd))
                {
                    store = (OSDMap)llsd;
                    return true;
                }
                else
                {
                    store = null;
                    return false;
                }
            }
        }    

        public void Clear()
        {
            lock (this)
                m_map.Clear();
        }  
        
        public bool Contains(KeyValuePair<string, OSDMap> kvp)
        {
            lock (this)
                return m_map.ContainsKey(kvp.Key);
        }

        public void CopyTo(KeyValuePair<string, OSDMap>[] array, int index)
        {
            throw new NotImplementedException();
        }

        public bool Remove(KeyValuePair<string, OSDMap> kvp)
        {
            lock (this)
                return m_map.Remove(kvp.Key);
        }

        public System.Collections.IDictionaryEnumerator GetEnumerator()
        {
            lock (this)
                return m_map.GetEnumerator();
        }

        IEnumerator<KeyValuePair<string, OSDMap>> IEnumerable<KeyValuePair<string, OSDMap>>.GetEnumerator()
        {
            return null;
        }

        IEnumerator IEnumerable.GetEnumerator()
        {
            lock (this)
                return m_map.GetEnumerator();
        }        
    }
}