aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/OptionalModules/PrimLimitsModule/PrimLimitsModule.cs
blob: 61b6d682e6f5c3af978df4ce43c818e14a427c4b (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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
/*
 * 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;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using log4net;
using Mono.Addins;
using Nini.Config;
using OpenMetaverse;
using OpenSim.Framework;
using OpenSim.Region.Framework.Interfaces;
using OpenSim.Region.Framework.Scenes;

namespace OpenSim.Region.OptionalModules
{
    /// <summary>
    /// Enables Prim limits for parcel.
    /// </summary>
    /// <remarks>
    /// This module selectivly enables parcel prim limits.
    /// </remarks>
    [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "PrimLimitsModule")]
    public class PrimLimitsModule : INonSharedRegionModule
    {
        protected IDialogModule m_dialogModule;
        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
        private bool m_enabled;

        private Scene m_scene;
        public string Name { get { return "PrimLimitsModule"; } }

        public Type ReplaceableInterface { get { return null; } }

        public void Initialise(IConfigSource config)
        {
            string permissionModules = Util.GetConfigVarFromSections<string>(config, "permissionmodules",
                new string[] { "Startup", "Permissions" }, "DefaultPermissionsModule");

            List<string> modules = new List<string>(permissionModules.Split(',').Select(m => m.Trim()));

            if(!modules.Contains("PrimLimitsModule"))
                return;

            m_log.DebugFormat("[PRIM LIMITS]: Initialized module");
            m_enabled = true;
        }

        public void Close()
        {
        }

        public void AddRegion(Scene scene)
        {
            if (!m_enabled)
                return;

            m_scene = scene;
            scene.Permissions.OnRezObject += CanRezObject;
            scene.Permissions.OnObjectEntry += CanObjectEnter;
            scene.Permissions.OnObjectEnterWithScripts += CanObjectEnterWithScripts;
            scene.Permissions.OnDuplicateObject += CanDuplicateObject;

            m_log.DebugFormat("[PRIM LIMITS]: Region {0} added", scene.RegionInfo.RegionName);
        }

        public void RemoveRegion(Scene scene)
        {
            if (!m_enabled)
                return;

            m_scene.Permissions.OnRezObject -= CanRezObject;
            m_scene.Permissions.OnObjectEntry -= CanObjectEnter;
            scene.Permissions.OnObjectEnterWithScripts -= CanObjectEnterWithScripts;
            m_scene.Permissions.OnDuplicateObject -= CanDuplicateObject;
        }

        public void RegionLoaded(Scene scene)
        {
            m_dialogModule = scene.RequestModuleInterface<IDialogModule>();
        }

        private bool CanRezObject(int objectCount, UUID ownerID, Vector3 objectPosition)
        {
            
            ILandObject lo = m_scene.LandChannel.GetLandObject(objectPosition.X, objectPosition.Y);

            string response = DoCommonChecks(objectCount, ownerID, lo);

            if (response != null)
            {
                m_dialogModule.SendAlertToUser(ownerID, response);
                return false;
            }
            return true;
        }

        //OnDuplicateObject
        private bool CanDuplicateObject(SceneObjectGroup sog, ScenePresence sp)
        {
            Vector3 objectPosition = sog.AbsolutePosition;
            ILandObject lo = m_scene.LandChannel.GetLandObject(objectPosition.X, objectPosition.Y);

            string response = DoCommonChecks(sog.PrimCount, sp.UUID, lo);

            if (response != null)
            {
                m_dialogModule.SendAlertToUser(sp.UUID, response);
                return false;
            }
            return true;
        }

        private bool CanObjectEnter(SceneObjectGroup sog, bool enteringRegion, Vector3 newPoint)
        {
            float newX = newPoint.X;
            float newY = newPoint.Y;
            if (newX < -1.0f || newX > (m_scene.RegionInfo.RegionSizeX + 1.0f) ||
                newY < -1.0f || newY > (m_scene.RegionInfo.RegionSizeY + 1.0f) )
                return true;

            if (sog == null)
                return false;

            ILandObject newParcel = m_scene.LandChannel.GetLandObject(newX, newY);

            if (newParcel == null)
                return true;

            if(!enteringRegion)
            {
                Vector3 oldPoint = sog.AbsolutePosition;
                ILandObject oldParcel = m_scene.LandChannel.GetLandObject(oldPoint.X, oldPoint.Y);
                if(oldParcel != null && oldParcel.Equals(newParcel))
                    return true;
            }

            int objectCount = sog.PrimCount;

            // TODO: Add Special Case here for temporary prims

            string response = DoCommonChecks(objectCount, sog.OwnerID, newParcel);

            if (response != null)
            {
                if(m_dialogModule != null)
                    m_dialogModule.SendAlertToUser(sog.OwnerID, response);
                return false;
            }
            return true;
        }

        private bool CanObjectEnterWithScripts(SceneObjectGroup sog, ILandObject newParcel)
        {
            if (sog == null)
                return false;

            if (newParcel == null)
                return true;

            int objectCount = sog.PrimCount;

            // TODO: Add Special Case here for temporary prims

            string response = DoCommonChecks(objectCount, sog.OwnerID, newParcel);

            if (response != null)
                return false;

            return true;
        }

        private string DoCommonChecks(int objectCount, UUID ownerID, ILandObject lo)
        {
            string response = null;

            int OwnedParcelsCapacity = lo.GetSimulatorMaxPrimCount();
            if ((objectCount + lo.PrimCounts.Total) > OwnedParcelsCapacity)
            {
                response = "Unable to rez object because the parcel is full";
            }
            else
            {
                int maxPrimsPerUser = m_scene.RegionInfo.MaxPrimsPerUser;
                if (maxPrimsPerUser >= 0)
                {
                    // per-user prim limit is set
                    if (ownerID != lo.LandData.OwnerID || lo.LandData.IsGroupOwned)
                    {
                        // caller is not the sole Parcel owner
                        EstateSettings estateSettings = m_scene.RegionInfo.EstateSettings;
                        if (ownerID != estateSettings.EstateOwner)
                        {
                            // caller is NOT the Estate owner
                            List<UUID> mgrs = new List<UUID>(estateSettings.EstateManagers);
                            if (!mgrs.Contains(ownerID))
                            {
                                // caller is not an Estate Manager
                                if ((lo.PrimCounts.Users[ownerID] + objectCount) >  maxPrimsPerUser)
                                {
                                    response = "Unable to rez object because you have reached your limit";
                                }
                            }
                        }
                    }
                }
            }
            return response;
        }
    }
}