/* * Copyright (c) 2007, Second Life Reverse Engineering Team * All rights reserved. * * - 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. * - Neither the name of the Second Life Reverse Engineering Team 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 COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT OWNER OR 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.Text; using System.Threading; using libsecondlife.StructuredData; using libsecondlife.Capabilities; namespace libsecondlife { /// /// Capabilities is the name of the bi-directional HTTP REST protocol that /// Second Life uses to communicate transactions such as teleporting or /// group messaging /// public class Caps { /// /// Triggered when an event is received via the EventQueueGet /// capability /// /// Event name /// Decoded event data /// The simulator that generated the event public delegate void EventQueueCallback(string message, StructuredData.LLSD body, Simulator simulator); /// Reference to the simulator this system is connected to public Simulator Simulator; internal string _SeedCapsURI; internal Dictionary _Caps = new Dictionary(); private CapsClient _SeedRequest; private EventQueueClient _EventQueueCap = null; /// Capabilities URI this system was initialized with public string SeedCapsURI { get { return _SeedCapsURI; } } /// Whether the capabilities event queue is connected and /// listening for incoming events public bool IsEventQueueRunning { get { if (_EventQueueCap != null) return _EventQueueCap.Running; else return false; } } /// /// Default constructor /// /// /// internal Caps(Simulator simulator, string seedcaps) { Simulator = simulator; _SeedCapsURI = seedcaps; MakeSeedRequest(); } public void Disconnect(bool immediate) { Simulator.Client.Log(String.Format("Caps system for {0} is {1}", Simulator, (immediate ? "aborting" : "disconnecting")), Helpers.LogLevel.Info); if (_SeedRequest != null) _SeedRequest.Cancel(); if (_EventQueueCap != null) _EventQueueCap.Stop(immediate); } /// /// Request the URI of a named capability /// /// Name of the capability to request /// The URI of the requested capability, or String.Empty if /// the capability does not exist public Uri CapabilityURI(string capability) { Uri cap; if (_Caps.TryGetValue(capability, out cap)) return cap; else return null; } private void MakeSeedRequest() { if (Simulator == null || !Simulator.Client.Network.Connected) return; // Create a request list LLSDArray req = new LLSDArray(); req.Add("MapLayer"); req.Add("MapLayerGod"); req.Add("NewFileAgentInventory"); req.Add("EventQueueGet"); req.Add("UpdateGestureAgentInventory"); req.Add("UpdateNotecardAgentInventory"); req.Add("UpdateScriptAgentInventory"); req.Add("UpdateGestureTaskInventory"); req.Add("UpdateNotecardTaskInventory"); req.Add("UpdateScriptTaskInventory"); req.Add("SendPostcard"); req.Add("ViewerStartAuction"); req.Add("ParcelGodReserveForNewbie"); req.Add("SendUserReport"); req.Add("SendUserReportWithScreenshot"); req.Add("RequestTextureDownload"); req.Add("UntrustedSimulatorMessage"); req.Add("ParcelVoiceInfoRequest"); req.Add("ChatSessionRequest"); req.Add("ProvisionVoiceAccountRequest"); _SeedRequest = new CapsClient(new Uri(_SeedCapsURI)); _SeedRequest.OnComplete += new CapsClient.CompleteCallback(SeedRequestCompleteHandler); _SeedRequest.StartRequest(req); } private void SeedRequestCompleteHandler(CapsClient client, LLSD result, Exception error) { if (result != null && result.Type == LLSDType.Map) { LLSDMap respTable = (LLSDMap)result; StringBuilder capsList = new StringBuilder(); foreach (string cap in respTable.Keys) { capsList.Append(cap); capsList.Append(' '); _Caps[cap] = respTable[cap].AsUri(); } Simulator.Client.DebugLog("Got capabilities: " + capsList.ToString()); if (_Caps.ContainsKey("EventQueueGet")) { Simulator.Client.DebugLog("Starting event queue for " + Simulator.ToString()); _EventQueueCap = new EventQueueClient(_Caps["EventQueueGet"]); _EventQueueCap.OnConnected += new EventQueueClient.ConnectedCallback(EventQueueConnectedHandler); _EventQueueCap.OnEvent += new EventQueueClient.EventCallback(EventQueueEventHandler); _EventQueueCap.Start(); } } else { // The initial CAPS connection failed, try again MakeSeedRequest(); } } private void EventQueueConnectedHandler() { Simulator.Client.Network.RaiseConnectedEvent(Simulator); } private void EventQueueEventHandler(string eventName, LLSDMap body) { if (Simulator.Client.Settings.SYNC_PACKETCALLBACKS) Simulator.Client.Network.CapsEvents.RaiseEvent(eventName, body, Simulator); else Simulator.Client.Network.CapsEvents.BeginRaiseEvent(eventName, body, Simulator); } } }