Merge master into teravuswork

1 files changed, 138 insertions, 1 deletions

diff --git a/OpenSim/Region/ScriptEngine/Shared/Api/Interface/IOSSL_Api.cs b/OpenSim/Region/ScriptEngine/Shared/Api/Interface/IOSSL_Api.cs
index 8c34ed3..c447d1f 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Api/Interface/IOSSL_Api.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Api/Interface/IOSSL_Api.cs
@@ -40,16 +40,75 @@ using LSL_Key = OpenSim.Region.ScriptEngine.Shared.LSL_Types.LSLString;
 
 namespace OpenSim.Region.ScriptEngine.Shared.Api.Interfaces
 {
+    /// <summary>
+    /// To permit region owners to enable the extended scripting functionality
+    /// of OSSL, without allowing malicious scripts to access potentially
+    /// troublesome functions, each OSSL function is assigned a threat level,
+    /// and access to the functions is granted or denied based on a default
+    /// threshold set in OpenSim.ini (which can be overridden for individual
+    /// functions on a case-by-case basis)
+    /// </summary>
     public enum ThreatLevel
     {
+        // Not documented, presumably means permanently disabled ?
         NoAccess = -1,
+
+        /// <summary>
+        /// Function is no threat at all. It doesn't constitute a threat to 
+        /// either users or the system and has no known side effects.
+        /// </summary>
         None = 0,
+
+        /// <summary>
+        /// Abuse of this command can cause a nuisance to the region operator,
+        /// such as log message spew.
+        /// </summary>
         Nuisance = 1,
+
+        /// <summary>
+        /// Extreme levels of abuse of this function can cause impaired 
+        /// functioning of the region, or very gullible users can be tricked
+        /// into experiencing harmless effects.
+        /// </summary>
         VeryLow = 2,
+
+        /// <summary>
+        /// Intentional abuse can cause crashes or malfunction under certain
+        /// circumstances, which can be easily rectified; or certain users can
+        /// be tricked into certain situations in an avoidable manner.
+        /// </summary>
         Low = 3,
+
+        /// <summary>
+        /// Intentional abuse can cause denial of service and crashes with
+        /// potential of data or state loss; or trusting users can be tricked 
+        /// into embarrassing or uncomfortable situations.
+        /// </summary>
         Moderate = 4,
+
+        /// <summary>
+        /// Casual abuse can cause impaired functionality or temporary denial
+        /// of service conditions. Intentional abuse can easily cause crashes
+        /// with potential data loss, or can be used to trick experienced and
+        /// cautious users into unwanted situations, or changes global data
+        /// permanently and without undo ability.
+        /// </summary>
         High = 5,
+
+        /// <summary>
+        /// Even normal use may, depending on the number of instances, or
+        /// frequency of use, result in severe service impairment or crash
+        /// with loss of data, or can be used to cause unwanted or harmful
+        /// effects on users without giving the user a means to avoid it.
+        /// </summary>
         VeryHigh = 6,
+
+        /// <summary>
+        /// Even casual use is a danger to region stability, or function allows
+        /// console or OS command execution, or function allows taking money
+        /// without consent, or allows deletion or modification of user data,
+        /// or allows the compromise of sensitive data by design.
+        /// </summary>
         Severe = 7
     };
 
@@ -98,7 +157,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api.Interfaces
         void osAvatarPlayAnimation(string avatar, string animation);
         void osAvatarStopAnimation(string avatar, string animation);
 
-        // Attachment commands
+        #region Attachment commands
 
         /// <summary>
         /// Attach the object containing this script to the avatar that owns it without asking for PERMISSION_ATTACH
@@ -133,6 +192,29 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api.Interfaces
         /// <remarks>Nothing happens if the object is not attached.</remarks>
         void osForceDetachFromAvatar();
 
+        /// <summary>
+        /// Returns a strided list of the specified attachment points and the number of attachments on those points.
+        /// </summary>
+        /// <param name="avatar">avatar UUID</param>
+        /// <param name="attachmentPoints">list of ATTACH_* constants</param>
+        /// <returns></returns>
+        LSL_List osGetNumberOfAttachments(LSL_Key avatar, LSL_List attachmentPoints);
+
+        /// <summary>
+        /// Sends a specified message to the specified avatar's attachments on
+        ///     the specified attachment points.
+        /// </summary>
+        /// <remarks>
+        /// Behaves as osMessageObject(), without the sending script needing to know the attachment keys in advance.
+        /// </remarks>
+        /// <param name="avatar">avatar UUID</param>
+        /// <param name="message">message string</param>
+        /// <param name="attachmentPoints">list of ATTACH_* constants, or -1 for all attachments. If -1 is specified and OS_ATTACH_MSG_INVERT_POINTS is present in flags, no action is taken.</param>
+        /// <param name="flags">flags further constraining the attachments to deliver the message to.</param>
+        void osMessageAttachments(LSL_Key avatar, string message, LSL_List attachmentPoints, int flags);
+
+        #endregion
+
         //texture draw functions
         string osMovePen(string drawList, int x, int y);
         string osDrawLine(string drawList, int startX, int startY, int endX, int endY);
@@ -258,6 +340,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api.Interfaces
         int osGetSimulatorMemory();
         void osKickAvatar(string FirstName,string SurName,string alert);
         void osSetSpeed(string UUID, LSL_Float SpeedModifier);
+        LSL_Float osGetHealth(string avatar);
         void osCauseHealing(string avatar, double healing);
         void osCauseDamage(string avatar, double damage);
         LSL_List osGetPrimitiveParams(LSL_Key prim, LSL_List rules);
@@ -305,5 +388,59 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api.Interfaces
         /// </summary>
         /// <returns>Rezzing object key or NULL_KEY if rezzed by agent or otherwise unknown.</returns>
         LSL_Key osGetRezzingObject();
+
+        /// <summary>
+        /// Sets the response type for an HTTP request/response
+        /// </summary>
+        /// <returns></returns>
+        void osSetContentType(LSL_Key id, string type);
+
+        /// <summary>
+        /// Attempts to drop an attachment to the ground
+        /// </summary>
+        void osDropAttachment();
+
+        /// <summary>
+        /// Attempts to drop an attachment to the ground while bypassing the script permissions
+        /// </summary>
+        void osForceDropAttachment();
+
+        /// <summary>
+        /// Attempts to drop an attachment at the specified coordinates.
+        /// </summary>
+        /// <param name="pos"></param>
+        /// <param name="rot"></param>
+        void osDropAttachmentAt(vector pos, rotation rot);
+
+        /// <summary>
+        /// Attempts to drop an attachment at the specified coordinates while bypassing the script permissions
+        /// </summary>
+        /// <param name="pos"></param>
+        /// <param name="rot"></param>
+        void osForceDropAttachmentAt(vector pos, rotation rot);
+
+        /// <summary>
+        /// Identical to llListen except for a bitfield which indicates which
+        /// string parameters should be parsed as regex patterns.
+        /// </summary>
+        /// <param name="channelID"></param>
+        /// <param name="name"></param>
+        /// <param name="ID"></param>
+        /// <param name="msg"></param>
+        /// <param name="regexBitfield">
+        /// OS_LISTEN_REGEX_NAME
+        /// OS_LISTEN_REGEX_MESSAGE
+        /// </param>
+        /// <returns></returns>
+        LSL_Integer osListenRegex(int channelID, string name, string ID,
+                string msg, int regexBitfield);
+
+        /// <summary>
+        /// Wraps to bool Regex.IsMatch(string input, string pattern)
+        /// </summary>
+        /// <param name="input">string to test for match</param>
+        /// <param name="regex">string to use as pattern</param>
+        /// <returns>boolean</returns>
+        LSL_Integer osRegexIsMatch(string input, string pattern);
     }
 }