aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Data/IGroupsData.cs
blob: c11e6499a536fbf03ec69e20769edafaffd9337a (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
/*
 * 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 OpenSimulator 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.Collections.Generic;
using OpenSim.Data;
using OpenMetaverse;

namespace OpenSim.Data
{
    public class GroupData
    {
        public UUID GroupID;
        public Dictionary<string, string> Data;
    }

    public class MembershipData
    {
        public UUID GroupID;
        public string PrincipalID;
        public Dictionary<string, string> Data;
    }

    public class RoleData
    {
        public UUID GroupID;
        public UUID RoleID;
        public Dictionary<string, string> Data;
    }

    public class RoleMembershipData
    {
        public UUID GroupID;
        public UUID RoleID;
        public string PrincipalID;
    }

    public class PrincipalData
    {
        public string PrincipalID;
        public UUID ActiveGroupID;
    }

    public class InvitationData
    {
        public UUID InviteID;
        public UUID GroupID;
        public UUID RoleID;
        public string PrincipalID;
        public Dictionary<string, string> Data;
    }

    public class NoticeData
    {
        public UUID GroupID;
        public UUID NoticeID;
        public Dictionary<string, string> Data;
    }


    public interface IGroupsData 
    {
        // groups table
        bool StoreGroup(GroupData data);
        GroupData RetrieveGroup(UUID groupID);
        GroupData RetrieveGroup(string name);
        GroupData[] RetrieveGroups(string pattern);
        bool DeleteGroup(UUID groupID);
        int GroupsCount();

        // membership table
        MembershipData RetrieveMember(UUID groupID, string pricipalID);
        MembershipData[] RetrieveMembers(UUID groupID);
        MembershipData[] RetrieveMemberships(string pricipalID);
        bool StoreMember(MembershipData data);
        bool DeleteMember(UUID groupID, string pricipalID);
        int MemberCount(UUID groupID);

        // roles table
        bool StoreRole(RoleData data);
        RoleData RetrieveRole(UUID groupID, UUID roleID);
        RoleData[] RetrieveRoles(UUID groupID);
        bool DeleteRole(UUID groupID, UUID roleID);
        int RoleCount(UUID groupID);

        // rolememberhip table
        RoleMembershipData[] RetrieveRolesMembers(UUID groupID);
        RoleMembershipData[] RetrieveRoleMembers(UUID groupID, UUID roleID);
        RoleMembershipData[] RetrieveMemberRoles(UUID groupID, string principalID);
        RoleMembershipData RetrieveRoleMember(UUID groupID, UUID roleID, string principalID);
        int RoleMemberCount(UUID groupID, UUID roleID);
        bool StoreRoleMember(RoleMembershipData data);
        bool DeleteRoleMember(RoleMembershipData data);
        bool DeleteMemberAllRoles(UUID groupID, string principalID);

        // principals table
        bool StorePrincipal(PrincipalData data);
        PrincipalData RetrievePrincipal(string principalID);
        bool DeletePrincipal(string principalID);

        // invites table
        bool StoreInvitation(InvitationData data);
        InvitationData RetrieveInvitation(UUID inviteID);
        InvitationData RetrieveInvitation(UUID groupID, string principalID);
        bool DeleteInvite(UUID inviteID);
        void DeleteOldInvites();

        // notices table
        bool StoreNotice(NoticeData data);
        NoticeData RetrieveNotice(UUID noticeID);
        NoticeData[] RetrieveNotices(UUID groupID);
        bool DeleteNotice(UUID noticeID);
        void DeleteOldNotices();

        // combinations
        MembershipData RetrievePrincipalGroupMembership(string principalID, UUID groupID);
        MembershipData[] RetrievePrincipalGroupMemberships(string principalID);

        // Misc
    }
}