clockwerk-opensim – Blame information for rev 1
?pathlinks?
Rev | Author | Line No. | Line |
---|---|---|---|
1 | vero | 1 | /* |
2 | * Copyright (c) Contributors, http://opensimulator.org/ |
||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. |
||
4 | * |
||
5 | * Redistribution and use in source and binary forms, with or without |
||
6 | * modification, are permitted provided that the following conditions are met: |
||
7 | * * Redistributions of source code must retain the above copyright |
||
8 | * notice, this list of conditions and the following disclaimer. |
||
9 | * * Redistributions in binary form must reproduce the above copyright |
||
10 | * notice, this list of conditions and the following disclaimer in the |
||
11 | * documentation and/or other materials provided with the distribution. |
||
12 | * * Neither the name of the OpenSimulator Project nor the |
||
13 | * names of its contributors may be used to endorse or promote products |
||
14 | * derived from this software without specific prior written permission. |
||
15 | * |
||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY |
||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY |
||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||
26 | */ |
||
27 | |||
28 | using System; |
||
29 | using System.Net; |
||
30 | using System.Collections.Generic; |
||
31 | |||
32 | using OpenSim.Framework; |
||
33 | using OpenMetaverse; |
||
34 | |||
35 | namespace OpenSim.Services.Interfaces |
||
36 | { |
||
37 | public interface IGatekeeperService |
||
38 | { |
||
39 | bool LinkRegion(string regionDescriptor, out UUID regionID, out ulong regionHandle, out string externalName, out string imageURL, out string reason); |
||
40 | |||
41 | /// <summary> |
||
42 | /// Returns the region a Hypergrid visitor should enter. |
||
43 | /// </summary> |
||
44 | /// <remarks> |
||
45 | /// Usually the returned region will be the requested region. But the grid can choose to |
||
46 | /// redirect the user to another region: e.g., a default gateway region. |
||
47 | /// </remarks> |
||
48 | /// <param name="regionID">The region the visitor *wants* to enter</param> |
||
49 | /// <param name="agentID">The visitor's User ID. Will be missing (UUID.Zero) in older OpenSims.</param> |
||
50 | /// <param name="agentHomeURI">The visitor's Home URI. Will be missing (null) in older OpenSims.</param> |
||
51 | /// <param name="message">[out] A message to show to the user (optional, may be null)</param> |
||
52 | /// <returns>The region the visitor should enter, or null if no region can be found / is allowed</returns> |
||
53 | GridRegion GetHyperlinkRegion(UUID regionID, UUID agentID, string agentHomeURI, out string message); |
||
54 | |||
55 | bool LoginAgent(GridRegion source, AgentCircuitData aCircuit, GridRegion destination, out string reason); |
||
56 | |||
57 | } |
||
58 | |||
59 | public interface IUserAgentService |
||
60 | { |
||
61 | bool LoginAgentToGrid(GridRegion source, AgentCircuitData agent, GridRegion gatekeeper, GridRegion finalDestination, bool fromLogin, out string reason); |
||
62 | |||
63 | void LogoutAgent(UUID userID, UUID sessionID); |
||
64 | |||
65 | /// <summary> |
||
66 | /// Returns the home region of a remote user. |
||
67 | /// </summary> |
||
68 | /// <returns>On success: the user's home region. If the user doesn't exist: null.</returns> |
||
69 | /// <remarks>Throws an exception if an error occurs (e.g., can't contact the server).</remarks> |
||
70 | GridRegion GetHomeRegion(UUID userID, out Vector3 position, out Vector3 lookAt); |
||
71 | |||
72 | /// <summary> |
||
73 | /// Returns the Server URLs of a remote user. |
||
74 | /// </summary> |
||
75 | /// <returns>On success: the user's Server URLs. If the user doesn't exist: an empty dictionary.</returns> |
||
76 | /// <remarks>Throws an exception if an error occurs (e.g., can't contact the server).</remarks> |
||
77 | Dictionary<string, object> GetServerURLs(UUID userID); |
||
78 | |||
79 | /// <summary> |
||
80 | /// Returns the UserInfo of a remote user. |
||
81 | /// </summary> |
||
82 | /// <returns>On success: the user's UserInfo. If the user doesn't exist: an empty dictionary.</returns> |
||
83 | /// <remarks>Throws an exception if an error occurs (e.g., can't contact the server).</remarks> |
||
84 | Dictionary<string, object> GetUserInfo(UUID userID); |
||
85 | |||
86 | /// <summary> |
||
87 | /// Returns the current location of a remote user. |
||
88 | /// </summary> |
||
89 | /// <returns>On success: the user's Server URLs. If the user doesn't exist: "".</returns> |
||
90 | /// <remarks>Throws an exception if an error occurs (e.g., can't contact the server).</remarks> |
||
91 | string LocateUser(UUID userID); |
||
92 | |||
93 | /// <summary> |
||
94 | /// Returns the Universal User Identifier for 'targetUserID' on behalf of 'userID'. |
||
95 | /// </summary> |
||
96 | /// <returns>On success: the user's UUI. If the user doesn't exist: "".</returns> |
||
97 | /// <remarks>Throws an exception if an error occurs (e.g., can't contact the server).</remarks> |
||
98 | string GetUUI(UUID userID, UUID targetUserID); |
||
99 | |||
100 | /// <summary> |
||
101 | /// Returns the remote user that has the given name. |
||
102 | /// </summary> |
||
103 | /// <returns>On success: the user's UUID. If the user doesn't exist: UUID.Zero.</returns> |
||
104 | /// <remarks>Throws an exception if an error occurs (e.g., can't contact the server).</remarks> |
||
105 | UUID GetUUID(String first, String last); |
||
106 | |||
107 | // Returns the local friends online |
||
108 | [Obsolete] |
||
109 | List<UUID> StatusNotification(List<string> friends, UUID userID, bool online); |
||
110 | |||
111 | bool IsAgentComingHome(UUID sessionID, string thisGridExternalName); |
||
112 | bool VerifyAgent(UUID sessionID, string token); |
||
113 | bool VerifyClient(UUID sessionID, string reportedIP); |
||
114 | } |
||
115 | |||
116 | public interface IInstantMessage |
||
117 | { |
||
118 | bool IncomingInstantMessage(GridInstantMessage im); |
||
119 | bool OutgoingInstantMessage(GridInstantMessage im, string url, bool foreigner); |
||
120 | } |
||
121 | public interface IFriendsSimConnector |
||
122 | { |
||
123 | bool StatusNotify(UUID userID, UUID friendID, bool online); |
||
124 | bool LocalFriendshipOffered(UUID toID, GridInstantMessage im); |
||
125 | bool LocalFriendshipApproved(UUID userID, string userName, UUID friendID); |
||
126 | } |
||
127 | |||
128 | public interface IHGFriendsService |
||
129 | { |
||
130 | int GetFriendPerms(UUID userID, UUID friendID); |
||
131 | bool NewFriendship(FriendInfo finfo, bool verified); |
||
132 | bool DeleteFriendship(FriendInfo finfo, string secret); |
||
133 | bool FriendshipOffered(UUID from, string fromName, UUID to, string message); |
||
134 | bool ValidateFriendshipOffered(UUID fromID, UUID toID); |
||
135 | // Returns the local friends online |
||
136 | List<UUID> StatusNotification(List<string> friends, UUID userID, bool online); |
||
137 | } |
||
138 | |||
139 | public interface IInstantMessageSimConnector |
||
140 | { |
||
141 | bool SendInstantMessage(GridInstantMessage im); |
||
142 | } |
||
143 | } |