/* * Copyright (c) Contributors * 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 Mono.Addins; using System; using System.Reflection; using System.Threading; using System.Text; using System.Net; using System.Net.Sockets; using log4net; using Nini.Config; using OpenMetaverse; using OpenMetaverse.StructuredData; using OpenSim.Framework; using OpenSim.Region.Framework.Interfaces; using OpenSim.Region.Framework.Scenes; using System.Collections.Generic; using System.Text.RegularExpressions; namespace OpenSim.Region.OptionalModules.Scripting.JsonStore { [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "JsonStoreModule")] public class JsonStoreModule : INonSharedRegionModule, IJsonStoreModule { private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); private IConfig m_config = null; private bool m_enabled = false; private bool m_enableObjectStore = false; private int m_maxStringSpace = Int32.MaxValue; private Scene m_scene = null; private Dictionary m_JsonValueStore; private UUID m_sharedStore; #region Region Module interface // ----------------------------------------------------------------- /// /// Name of this shared module is it's class name /// // ----------------------------------------------------------------- public string Name { get { return this.GetType().Name; } } // ----------------------------------------------------------------- /// /// Initialise this shared module /// /// this region is getting initialised /// nini config, we are not using this // ----------------------------------------------------------------- public void Initialise(IConfigSource config) { try { if ((m_config = config.Configs["JsonStore"]) == null) { // There is no configuration, the module is disabled // m_log.InfoFormat("[JsonStore] no configuration info"); return; } m_enabled = m_config.GetBoolean("Enabled", m_enabled); m_enableObjectStore = m_config.GetBoolean("EnableObjectStore", m_enableObjectStore); m_maxStringSpace = m_config.GetInt("MaxStringSpace", m_maxStringSpace); if (m_maxStringSpace == 0) m_maxStringSpace = Int32.MaxValue; } catch (Exception e) { m_log.Error("[JsonStore]: initialization error: {0}", e); return; } if (m_enabled) m_log.DebugFormat("[JsonStore]: module is enabled"); } // ----------------------------------------------------------------- /// /// everything is loaded, perform post load configuration /// // ----------------------------------------------------------------- public void PostInitialise() { } // ----------------------------------------------------------------- /// /// Nothing to do on close /// // ----------------------------------------------------------------- public void Close() { } // ----------------------------------------------------------------- /// /// // ----------------------------------------------------------------- public void AddRegion(Scene scene) { if (m_enabled) { m_scene = scene; m_scene.RegisterModuleInterface(this); m_sharedStore = UUID.Zero; m_JsonValueStore = new Dictionary(); m_JsonValueStore.Add(m_sharedStore,new JsonStore("")); scene.EventManager.OnObjectBeingRemovedFromScene += EventManagerOnObjectBeingRemovedFromScene; } } // ----------------------------------------------------------------- /// /// // ----------------------------------------------------------------- public void RemoveRegion(Scene scene) { scene.EventManager.OnObjectBeingRemovedFromScene -= EventManagerOnObjectBeingRemovedFromScene; // need to remove all references to the scene in the subscription // list to enable full garbage collection of the scene object } // ----------------------------------------------------------------- /// /// Called when all modules have been added for a region. This is /// where we hook up events /// // ----------------------------------------------------------------- public void RegionLoaded(Scene scene) { if (m_enabled) { } } /// ----------------------------------------------------------------- /// /// // ----------------------------------------------------------------- public Type ReplaceableInterface { get { return null; } } #endregion #region SceneEvents // ----------------------------------------------------------------- /// /// /// // ----------------------------------------------------------------- public void EventManagerOnObjectBeingRemovedFromScene(SceneObjectGroup obj) { obj.ForEachPart(delegate(SceneObjectPart sop) { DestroyStore(sop.UUID); } ); } #endregion #region ScriptInvocationInteface // ----------------------------------------------------------------- /// /// /// // ----------------------------------------------------------------- public JsonStoreStats GetStoreStats() { JsonStoreStats stats; lock (m_JsonValueStore) { stats.StoreCount = m_JsonValueStore.Count; } return stats; } // ----------------------------------------------------------------- /// /// /// // ----------------------------------------------------------------- public bool AttachObjectStore(UUID objectID) { if (! m_enabled) return false; if (! m_enableObjectStore) return false; SceneObjectPart sop = m_scene.GetSceneObjectPart(objectID); if (sop == null) { m_log.ErrorFormat("[JsonStore] unable to attach to unknown object; {0}", objectID); return false; } lock (m_JsonValueStore) { if (m_JsonValueStore.ContainsKey(objectID)) return true; JsonStore map = new JsonObjectStore(m_scene,objectID); m_JsonValueStore.Add(objectID,map); } return true; } // ----------------------------------------------------------------- /// /// /// // ----------------------------------------------------------------- public bool CreateStore(string value, ref UUID result) { if (result == UUID.Zero) result = UUID.Random(); JsonStore map = null; if (! m_enabled) return false; try { map = new JsonStore(value); } catch (Exception) { m_log.ErrorFormat("[JsonStore]: Unable to initialize store from {0}", value); return false; } lock (m_JsonValueStore) m_JsonValueStore.Add(result,map); return true; } // ----------------------------------------------------------------- /// /// /// // ----------------------------------------------------------------- public bool DestroyStore(UUID storeID) { if (! m_enabled) return false; lock (m_JsonValueStore) return m_JsonValueStore.Remove(storeID); } // ----------------------------------------------------------------- /// /// /// // ----------------------------------------------------------------- public bool TestStore(UUID storeID) { if (! m_enabled) return false; lock (m_JsonValueStore) return m_JsonValueStore.ContainsKey(storeID); } // ----------------------------------------------------------------- /// /// /// // ----------------------------------------------------------------- public JsonStoreNodeType GetNodeType(UUID storeID, string path) { if (! m_enabled) return JsonStoreNodeType.Undefined; JsonStore map = null; lock (m_JsonValueStore) { if (! m_JsonValueStore.TryGetValue(storeID,out map)) { m_log.InfoFormat("[JsonStore] Missing store {0}",storeID); return JsonStoreNodeType.Undefined; } } try { lock (map) return map.GetNodeType(path); } catch (Exception e) { m_log.Error(string.Format("[JsonStore]: Path test failed for {0} in {1}", path, storeID), e); } return JsonStoreNodeType.Undefined; } // ----------------------------------------------------------------- /// /// /// // ----------------------------------------------------------------- public JsonStoreValueType GetValueType(UUID storeID, string path) { if (! m_enabled) return JsonStoreValueType.Undefined; JsonStore map = null; lock (m_JsonValueStore) { if (! m_JsonValueStore.TryGetValue(storeID,out map)) { m_log.InfoFormat("[JsonStore] Missing store {0}",storeID); return JsonStoreValueType.Undefined; } } try { lock (map) return map.GetValueType(path); } catch (Exception e) { m_log.Error(string.Format("[JsonStore]: Path test failed for {0} in {1}", path, storeID), e); } return JsonStoreValueType.Undefined; } // ----------------------------------------------------------------- /// /// /// // ----------------------------------------------------------------- public bool SetValue(UUID storeID, string path, string value, bool useJson) { if (! m_enabled) return false; JsonStore map = null; lock (m_JsonValueStore) { if (! m_JsonValueStore.TryGetValue(storeID,out map)) { m_log.InfoFormat("[JsonStore] Missing store {0}",storeID); return false; } } try { lock (map) { if (map.StringSpace > m_maxStringSpace) { m_log.WarnFormat("[JsonStore] {0} exceeded string size; {1} bytes used of {2} limit", storeID,map.StringSpace,m_maxStringSpace); return false; } return map.SetValue(path,value,useJson); } } catch (Exception e) { m_log.Error(string.Format("[JsonStore]: Unable to assign {0} to {1} in {2}", value, path, storeID), e); } return false; } // ----------------------------------------------------------------- /// /// /// // ----------------------------------------------------------------- public bool RemoveValue(UUID storeID, string path) { if (! m_enabled) return false; JsonStore map = null; lock (m_JsonValueStore) { if (! m_JsonValueStore.TryGetValue(storeID,out map)) { m_log.InfoFormat("[JsonStore] Missing store {0}",storeID); return false; } } try { lock (map) return map.RemoveValue(path); } catch (Exception e) { m_log.Error(string.Format("[JsonStore]: Unable to remove {0} in {1}", path, storeID), e); } return false; } // ----------------------------------------------------------------- /// /// /// // ----------------------------------------------------------------- public int GetArrayLength(UUID storeID, string path) { if (! m_enabled) return -1; JsonStore map = null; lock (m_JsonValueStore) { if (! m_JsonValueStore.TryGetValue(storeID,out map)) return -1; } try { lock (map) { return map.ArrayLength(path); } } catch (Exception e) { m_log.Error("[JsonStore]: unable to retrieve value", e); } return -1; } // ----------------------------------------------------------------- /// /// /// // ----------------------------------------------------------------- public bool GetValue(UUID storeID, string path, bool useJson, out string value) { value = String.Empty; if (! m_enabled) return false; JsonStore map = null; lock (m_JsonValueStore) { if (! m_JsonValueStore.TryGetValue(storeID,out map)) return false; } try { lock (map) { return map.GetValue(path, out value, useJson); } } catch (Exception e) { m_log.Error("[JsonStore]: unable to retrieve value", e); } return false; } // ----------------------------------------------------------------- /// /// /// // ----------------------------------------------------------------- public void TakeValue(UUID storeID, string path, bool useJson, TakeValueCallback cback) { if (! m_enabled) { cback(String.Empty); return; } JsonStore map = null; lock (m_JsonValueStore) { if (! m_JsonValueStore.TryGetValue(storeID,out map)) { cback(String.Empty); return; } } try { lock (map) { map.TakeValue(path, useJson, cback); return; } } catch (Exception e) { m_log.Error("[JsonStore] unable to retrieve value", e); } cback(String.Empty); } // ----------------------------------------------------------------- /// /// /// // ----------------------------------------------------------------- public void ReadValue(UUID storeID, string path, bool useJson, TakeValueCallback cback) { if (! m_enabled) { cback(String.Empty); return; } JsonStore map = null; lock (m_JsonValueStore) { if (! m_JsonValueStore.TryGetValue(storeID,out map)) { cback(String.Empty); return; } } try { lock (map) { map.ReadValue(path, useJson, cback); return; } } catch (Exception e) { m_log.Error("[JsonStore]: unable to retrieve value", e); } cback(String.Empty); } #endregion } }