aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/Modules/AvatarFactory/AvatarFactoryModule.cs
blob: 1f99a7278785b51c339afb511d478a2e5e2fc3ca (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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
/*
 * 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 OpenSim 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.Generic;
using System.Threading;
using libsecondlife;
using Nini.Config;
using OpenSim.Framework;
using OpenSim.Framework.Communications.Cache;
using OpenSim.Framework.Data.MySQLMapper;
using OpenSim.Region.Environment.Interfaces;
using OpenSim.Region.Environment.Scenes;
using OpenSim.Framework.Data.Base;

namespace OpenSim.Region.Modules.AvatarFactory
{
    public class AvatarFactoryModule : IAvatarFactory
    {
        private Scene m_scene = null;
        private readonly Dictionary<LLUUID, AvatarAppearance> m_avatarsAppearance = new Dictionary<LLUUID, AvatarAppearance>();

        private bool m_enablePersist = false;
        private string m_connectionString;
        private bool m_configured = false;
        private BaseDatabaseConnector m_databaseMapper;
        private AppearanceTableMapper m_appearanceMapper;

        private Dictionary<LLUUID, EventWaitHandle> m_fetchesInProgress = new Dictionary<LLUUID, EventWaitHandle>();
        private object m_syncLock = new object();

        public bool TryGetAvatarAppearance(LLUUID avatarId, out AvatarAppearance appearance)
        {

            //should only let one thread at a time do this part
            EventWaitHandle waitHandle = null;
            bool fetchInProgress = false;
            lock (m_syncLock)
            {
                appearance = CheckCache(avatarId);
                if (appearance != null)
                {
                    return true;
                }

                //not in cache so check to see if another thread is already fetching it
                if (m_fetchesInProgress.TryGetValue(avatarId, out waitHandle))
                {
                    fetchInProgress = true;
                }
                else
                {
                    fetchInProgress = false;

                    //no thread already fetching this appearance, so add a wait handle to list
                    //for any following threads that want the same appearance
                    waitHandle = new EventWaitHandle(false, EventResetMode.ManualReset);
                    m_fetchesInProgress.Add(avatarId, waitHandle);
                }
            }

            if (fetchInProgress)
            {
                waitHandle.WaitOne();
                appearance = CheckCache(avatarId);
                if (appearance != null)
                {
                    waitHandle = null;
                    return true;
                }
                else
                {
                    waitHandle = null;
                    return false;
                }
            }
            else
            {
                Thread.Sleep(5000);

                //this is the first thread to request this appearance
                //so let it check the db and if not found then create a default appearance
                //and add that to the cache
                appearance = CheckDatabase(avatarId);
                if (appearance != null)
                {
                    //appearance has now been added to cache so lets pulse any waiting threads
                    lock (m_syncLock)
                    {
                        m_fetchesInProgress.Remove(avatarId);
                        waitHandle.Set();
                    }
                    // waitHandle.Close();
                    waitHandle = null;
                    return true;
                }

                //not found a appearance for the user, so create a new default one
                appearance = CreateDefault(avatarId);
                if (appearance != null)
                {
                    //update database
                    if (m_enablePersist)
                    {
                        m_appearanceMapper.Add(avatarId.UUID, appearance);
                    }

                    //add appearance to dictionary cache
                    lock (m_avatarsAppearance)
                    {
                        m_avatarsAppearance[avatarId] = appearance;
                    }

                    //appearance has now been added to cache so lets pulse any waiting threads
                    lock (m_syncLock)
                    {
                        m_fetchesInProgress.Remove(avatarId);
                        waitHandle.Set();
                    }
                    // waitHandle.Close();
                    waitHandle = null;
                    return true;
                }
                else
                {
                    //something went wrong, so release the wait handle and remove it
                    //all waiting threads will fail to find cached appearance
                    //but its better for them to fail than wait for ever
                    lock (m_syncLock)
                    {
                        m_fetchesInProgress.Remove(avatarId);
                        waitHandle.Set();
                    }
                    //waitHandle.Close();
                    waitHandle = null;
                    return false;
                }
            }
        }

        private AvatarAppearance CreateDefault(LLUUID avatarId)
        {
            AvatarAppearance appearance = null;
            AvatarWearable[] wearables;
            byte[] visualParams;
            GetDefaultAvatarAppearance(out wearables, out visualParams);
            appearance = new AvatarAppearance(avatarId, wearables, visualParams);

            return appearance;
        }

        private AvatarAppearance CheckDatabase(LLUUID avatarId)
        {
            AvatarAppearance appearance = null;
            if (m_enablePersist)
            {
                if (m_appearanceMapper.TryGetValue(avatarId.UUID, out appearance))
                {
                    appearance.VisualParams = GetDefaultVisualParams();
                    appearance.TextureEntry = AvatarAppearance.GetDefaultTextureEntry();
                    lock (m_avatarsAppearance)
                    {
                        m_avatarsAppearance[avatarId] = appearance;
                    }
                }
            }
            return appearance;
        }

        private AvatarAppearance CheckCache(LLUUID avatarId)
        {
            AvatarAppearance appearance = null;
            lock (m_avatarsAppearance)
            {
                if (m_avatarsAppearance.ContainsKey(avatarId))
                {
                    appearance = m_avatarsAppearance[avatarId];
                }
            }
            return appearance;
        }

        public void Initialise(Scene scene, IConfigSource source)
        {
            scene.RegisterModuleInterface<IAvatarFactory>(this);
            scene.EventManager.OnNewClient += NewClient;

            if (m_scene == null)
            {
                m_scene = scene;
            }

            if (!m_configured)
            {
                m_configured = true;
                try
                {
                    m_enablePersist = source.Configs["Startup"].GetBoolean("appearance_persist", false);
                    m_connectionString = source.Configs["Startup"].GetString("appearance_connection_string", "");
                }
                catch (Exception)
                {
                }
                if (m_enablePersist)
                {
                    m_databaseMapper = new MySQLDatabaseMapper(m_connectionString);
                    m_appearanceMapper = new AppearanceTableMapper(m_databaseMapper, "AvatarAppearance");
                }
            }
        }

        public void PostInitialise()
        {
        }

        public void Close()
        {
        }

        public string Name
        {
            get { return "Default Avatar Factory"; }
        }

        public bool IsSharedModule
        {
            get { return true; }
        }

        public void NewClient(IClientAPI client)
        {
            client.OnAvatarNowWearing += AvatarIsWearing;
        }

        public void RemoveClient(IClientAPI client)
        {
            // client.OnAvatarNowWearing -= AvatarIsWearing;
        }

        public void AvatarIsWearing(Object sender, AvatarWearingArgs e)
        {
            IClientAPI clientView = (IClientAPI)sender;
            CachedUserInfo profile = m_scene.CommsManager.UserProfileCacheService.GetUserDetails(clientView.AgentId);
            if (profile != null)
            {
                if (profile.RootFolder != null)
                {
                    if (m_avatarsAppearance.ContainsKey(clientView.AgentId))
                    {
                        AvatarAppearance avatAppearance = null;
                        lock (m_avatarsAppearance)
                        {
                            avatAppearance = m_avatarsAppearance[clientView.AgentId];
                        }

                        foreach (AvatarWearingArgs.Wearable wear in e.NowWearing)
                        {
                            if (wear.Type < 13)
                            {
                                if (wear.ItemID == LLUUID.Zero)
                                {
                                    avatAppearance.Wearables[wear.Type].ItemID = LLUUID.Zero;
                                    avatAppearance.Wearables[wear.Type].AssetID = LLUUID.Zero;

                                    UpdateDatabase(clientView.AgentId, avatAppearance);
                                }
                                else
                                {
                                    LLUUID assetId;

                                    InventoryItemBase baseItem = profile.RootFolder.HasItem(wear.ItemID);
                                    if (baseItem != null)
                                    {
                                        assetId = baseItem.assetID;
                                        avatAppearance.Wearables[wear.Type].AssetID = assetId;
                                        avatAppearance.Wearables[wear.Type].ItemID = wear.ItemID;

                                        UpdateDatabase(clientView.AgentId, avatAppearance);
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }

        public void UpdateDatabase(LLUUID userID, AvatarAppearance avatAppearance)
        {
            if (m_enablePersist)
            {
                m_appearanceMapper.Update(userID.UUID, avatAppearance);
            }
        }

        public static void GetDefaultAvatarAppearance(out AvatarWearable[] wearables, out byte[] visualParams)
        {
            visualParams = GetDefaultVisualParams();
            wearables = AvatarWearable.DefaultWearables;
        }

        private static byte[] GetDefaultVisualParams()
        {
            byte[] visualParams;
            visualParams = new byte[218];
            for (int i = 0; i < 218; i++)
            {
                visualParams[i] = 100;
            }
            return visualParams;
        }
    }
}