[SEC] Lockette - Simple chest and door lock, no databases! [Moved to BukkitDev]

Discussion in 'Inactive/Unsupported Plugins' started by Acru, Feb 14, 2011.

  1. Offline


    Lockette - The sign-based container and door lock for Bukkit! - by Acru Jovian

    ElgarL has been assigned as the current maintainer of this project, please forward any important issues to him as well. This post is abandoned, but proceed to BukkitDev for updates.

    Download it at BukkitDev! (Alternate) (JAR) (Source), also view the Change Log on BukkitDev.

    Supported external plugins:
    • Permissions - Permissions/Groups
    • GroupManager - Permissions/Groups
    • PermissionsBukkit - SuperPerms/Groups
    • PermissionsEx - SuperPerms/Groups
    • bPermissions- SuperPerms/Groups
    • Towny - Groups/Zones
    • SimpleClans - Groups
    • mcMMO - Groups (Disabled by default now, due to issues.)
    • Factions - Groups
    • LWC - Zones
    • Register - Economy
    Alternate languages included:
    Confirmed compatible plugins: ColorSign, SpeedSign.
    Conflicting plugins: ChestShop, Most sign editors!

    The active Lockette information page will commute to BukkitDev soon, but the forum thread is still the best place for discussion.


    The purpose of this plugin is to restrict access to the contents of chests, dispensers, furnaces, and doors without the use of a database to track containers.

    To use, simply place a signpost on the floor directly beside a chest or other container to be locked. Enter [Private] as the first line. Your own name will automatically be entered on line 2 as the chest owner. Optionally type in the full names of two other users allowed to access the chest's inventory on lines 3 and 4.

    When done correctly, the sign will automatically fix itself to the side the target chest, protecting it from unauthorized access! Only the chest's owner can then break the sign or chest. (Warning: Anyone with permission to use WorldEdit commands or similar can circumvent the protection by removing the sign.)


    Additionally, you can enter [Everyone] on lines 3 or 4 instead of a user name to allow everyone access to the contents of a private container, or [Operators] to allow ops access. If a Permissions plugin is available, you can use groups like [Moderator] or [Admins] or others as defined in the Permissions settings files.

    The owner of a container can add more users by placing additional signs beside the container with the heading [More Users], where lines 2-4 specify the names of the additional users. You can edit the users on previously placed signs by right clicking the sign, and using the command '/lockette <line number> <text>' to change it.

    Working with Doors:

    To protect a door, you can use the same method as protecting a container, the sign will attach to the door automatically. In addition, you can attach a [Private] wall sign to any side of the blocks just above or just below a door. For double doors only one side needs a sign. Door support is enabled by default in the config file.

    Once a door is protected it will only open for someone listed as a user, and will not respond to redstone power or switches unless [Everyone] is listed as a user. Iron doors which usually won't open from clicking will work just as wooden doors. In addition, double doors will open together automatically!

    You can also use [More Users] signs as with containers, with the caveat that the sign cannot be placed on the block above the door if the [Private] sign is not above the door as well! (This is done to prevent a security uncertainty issue.)

    Protected doors will be closed automatically if a timer is set. A timer can be set globally with a configuration option, or individually for each door by using the tag [Timer: #] on line 3 or 4 of the [Private] sign, where # is the number of seconds that the door should remain open. If the timer is set to 0, this means the door will never automatically close. If no timer is specified, protected doors will use a global timer set in the configuration file. If the server is shut down cleanly any open doors will be closed, but in the event of a server crash while a door is open, it may remain so. Note that the initial state of a door is assumed to be closed.

    Care must me taken to place protected doors on a stable block. Building a door on sand, gravel, leaves, TNT and et cetera are allowed by the plugin, but cannot be secured fully. :3 Additionally, it should be noted that most status messages still refer to locked blocks as containers, so for the purpose of simplicity, doors should be considered as a type of container.

    • No passwords or databases needed!
    • Permission checks run in constant time, no matter how many protected containers.
      • One owner and up to 11 additional users supported. (17 for double chests!)
      • Allows access to [Everyone] while still protecting the container from vandalism.
      • Allows group names in conjunction with many other plugins.
    • Special powers for ops or admins, configurable with permissions.
      • Reports when an admin does something naughty.
    • Protects single and double chests, dispensers, and furnaces.
      • Explosion and block-break protection for the protected container and sign.
        • Option to protect all containers from explosions.
    • Full support for doors, both wooden and iron!
      • Double doors are handled automatically, with no redstone.
      • Doors can be set to close automatically, via a timer setting.
      • Redstone hacking is disabled for protected doors.
    • Prevents creation of chests larger than 2 blocks.
    • Informative or helpful messages when interacting with containers.
      • The first time a chest is placed, a help message will be shown.
      • Types of messages shown are configurable in settings.
      • Additional language support.

    Advanced Setup (Permissions) (open)

    Advanced Setup:
    There are a few things you can now customize in the configuration files for the plugin, found in the plugins/Lockette folder. After running the plugin for the first time, two files will be created, config.yml and strings.yml. The first holds the following settings:
    • enable-permissions - Allows the use of permission nodes to specify who can do what. If this is disabled, groups will still be used but admin status is taken from the ops file. Defaults to false.
    • enable-messages-* - Enables or disables groups of messages listed in the strings.yml file. Not counting the broadcast ones.
    • broadcast-*-target - Sets the group or player that specific broadcast messages should be sent to. This can be set to "" for no one.
    • explosion-protection-all - Enabling this extends explosion protection to all containers on the server, not just [Private] ones. Default is disabled.
    • allow-admin-bypass - Allows admins to go though any protected door. Default is true.
    • allow-admin-snoop - Allows admins to peek into chests owned by other people. Default is false, and this setting is recommended! A broadcast message will be sent each time an admin snoops in a protected container where the admin doesn't have permission to. The message will be sent to a player or group as specified in another option. Admins can still break protection on chests if this is disabled, however.
    • enable-protection-doors - Enables support for private doors, defaults to true.
    • default-door-timer - Sets the door closing timer for all protected doors on the server, unless overridden by a specific sign. Defaults to 0, which disables the door closing timer.
    In the strings.yml file, you can set alternate language tags for [Private] and such, in ANSI format. If you need characters not in ANSI then you might try UTF-8 format, though it seems bugged tight now. The default alternate tags are in French, but server ops are free to translate the whole file into the language of their choice. If you do this, please share it back to me~ :3 If you want to disable only a specific message, you can set it to "", the empty string. Admins can use the command '/lockette reload' after editing the configuration files, to reload them.

    If a Permissions plugin is not available or the enable-permissions option is set to false, Lockette will use the ops file to determine who are admins. Admins can break the protection on any chest, and look inside protected chests (only if the related option is set), as well as reload the plugins configuration files. All non-ops will be able to create protected containers for themselves.

    If a Permissions plugin is available and the enable-permissions option is set to true, the following nodes will be used instead of the ops file and are included by default in the '*' node:
    • lockette.user.create.* - Permission required to create a protected container or door. Possible sub-nodes include chest, dispenser, furnace, and door. (The permission lockette.create.all is still supported, but obsolete.)
    • lockette.admin.create.* - Allows admins to create containers and doors for other users. Possible sub-nodes include chest, dispenser, furnace, and door. Leave line 2 blank for the default behavior or enter the name of your choice. Capitalization matters.
    • lockette.admin.break - Allows breaking protection on containers.
    • lockette.admin.bypass - Allows opening of any locked door.
    • lockette.admin.snoop - Allows peeking in protected containers. (The setting allow-admin-snoop must be true.)
    • lockette.admin.reload - Allows use of the reload command.

    Technical Information (open)

    Technical Information:

    This plugin has been tested and shown to be working for many builds of CraftBucket though a number of the more recent builds had a serious issue, so I'm suggesting a minimum build of 561 now. If you update past what is listed in the post's title and the plugin seems to break, it is probably not my fault. Post a note anyway and I'll see about fixing. I'll try and keep up with the new recommended build system, but for latest builds that break things, you should expect some time to pass before I take care of the issue, as this plugin is now mature. :3

    If there are multiple containers by the placed sign, the plugin will use the NESW rule to choose the first container that is not yet private. To elaborate, the plugin will check to the north of the sign first, and if no container or door is available to the north, it will continue checking clockwise around the sign.

    Due to the current implementation of the explosion event, this plugin will cancel all explosions that would damage the container or sign, rather than just remove the container and sign from the blocks to be damaged. Canceled explosions still knock signs off the walls. Canceled explosions leave signs looking blank, but this is just a graphic glitch, reconnect to fix.

    Bonus: This plugin will prevent chests bigger than 2 blocks from being created via glitches. (Again, this could be circumvented using WorldEdit commands, so take care who has access to such a plugin.)

    This plugin was inspired by the old hmod plugins Lock by Roman "kingseta" Pramberger and ChestCapsule by Fernando "Fergo".

    Hooking into Lockette (open)

    Hooking into Lockette:

    If you are a plugin author and want to connect to Lockette, you can use a public static function to get information about the protected status of a block.

    More info later, perhaps, but if you need the details now then go poke through the source~

    Future Possibilities:

    There are a number of things that have been suggested, and they tend to be added to the list below if I think they might be a good idea. However, some sort of locked container limit is requested often but this is not possible without a database to track the number of locked containers someone has. All things considered, this will not be supported. On the up side, without a database you can have literally millions of locked containers without any sort of lag, and there are permissions to restrict who can create locked chests. Perhaps only allow Moderators to create locked chests for other users, if you don't want to allow infinite locked chests.

    Aside what has already been implemented, the following may or may not appear in future versions:
    • Furnace/dispenser clusters, protected by a single sign.
    • [Log] sign to list recent users of a container or door.
    • iConomy fee for protecting containers/doors.
    • Worldguard connection.
    • [Protected] tag for viewing only.
    • Specific time range that doors can be opened.
    • DataLog plugin support.
    • More types of protected blocks, such as brewing stands.
    If you want any of the above features sooner than never, let me know! However, I currently see Lockette as functionally complete, for the most part, in that it already has all the functionality it needs. Future updates will mostly be to account for changes in Minecraft and Bukkit.

    Final Note:

    Please leave a reply if there are any bugs or suggestions, and if you like this plugin you can click the like button at the bottom of this post~ Thanks to those few that have donated! [​IMG]
  2. Offline


    Yes the issues are still very present. With lockette overtime not working properly, even not recognize that chests that are locked in far off areas.
    Here is a post by another use who is experiencing the same thing.

    Blackstorm72 said:
    Doing some additional research, it appears to be a map issue.
    Reloading the server doesn't fix the issue on my end, but restarting the server did.

    What appears to be happening as maps are slower to load in 1.5 the plugin doesn't recognize that there are entity of chests/doors/etc. that are there, and therefore not locking them.

    It appears to affect a few other plugins but nothing major (it did occur as well with a sign shop), it isn't map corruption, its just the plugin not seeing the chests because the map did not load them.
    It also appears to be client-side--server-side communication errors. It seems very common in 1.5. Several times, SEVERAL, have I had problems with clients not syncing with the server, and people joining and leaving the game is the most common 15 minute break thing to do.

    I don't think its possible to fix this - but it all depends on if my testing is true, its whats happening here.​

    I agree, as this happens mainly in areas that are less used. Like far away from my main city areas.
    I honestly think is the right in this assumption of whats going on.
  3. Offline


    Replies to page 28, part 1;

    You can use the alternate-private-tag in strings.yml to set an alternate tag more appropriate for your needs.
    Eg, you could use 'Stuff for' so the sign will read [Stuff for] [Everyone]. An admin can set [Everyone] for the username, rather than having it as one of the additional users.

    I'll add it to the possible conflict list for now, thanks.

    From my experimentation into making a shop plugin, this would be the way to do it I expect, but this is also more in the realm of a feature for a shop plugin and not really appropriate for Lockette. It could pose security/privacy issues.

    Still, I think I will make note of the [Protected] suggestion, it sounds java-esque~

    It appears that Lockette isn't even running, on placing a sign it should either attach to the chest or change the text to [?] on an error. I'll have to read down further to see if you added more info, as I saw more posts from you.

    I checked this, and seems to still be generated for me. The only reason why it may not be generated is due to file creation permissions on whatever system you are using as a server, for whatever user the bukkit server is running under.

    I am not sure what you are asking.

    This has been suggested before, though it may lead to instances where someone is trapped in an area for in game hours? Still, I'll make a note of it.

    Replies to page 28, part 2;

    Ah, looks like you got it fixed, good~

    If by take stuff you mean the chest inventory opens, this sounds like a strait forward plugin conflict.

    I would like you to disable the other plugins you have installed until you find the culprit, if you are willing.

    I'll have a look myself, though, before I add to the list. :3

    I'm glad you fixed your problem. :3

    Yer welcome, and yes I started supporting the static location for CraftBukkitUpToDate.
    Perhaps I'll also put the link in the main post too, for other uses. :3

    Your permissions look okay, though it may be another plugin you have running that is preventing breaking. Also, you should break the sign before the chest. (Akin to removing a lock on a chest before you are allowed to smash the chest like a pinata~)

    Let me know if you need more help.

    Okay, bear with me as I am getting up to date on the nature of the problem.
    I am seeing more posts related to this now~

    Replies to page 29, part 1;

    This is done automatically in GroupManager, though I am not sure yet how to get Permissions to do the same, it is on the to-do list. ^.^;

    It is in the list for a nasty security incompatibility.
    See this post on the FenceStack forum thread.

    That's an odd one. Try updating your java runtime?

    This suggestion is more appropriate for a shop plugin, sorry.

    There is an option in worldguard to disable door protection.

    This is something I would have to look into, before saying.

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: May 8, 2016
  4. Offline


    I fixed my Problem turns out it was Mine-cart Mania Sorry to bother you.
  5. Offline


    Replies to page 29, part 2;

    From that log, it seems that bukkit team changed something, breaking how I hook into permissions.
    I'll have to put out a fix if so, I'll get back to you on this.

    I would like to know the exact text on the sign in question, including nonprintable characters... (It appears to have to do with the regex to strip color codes off a sign's text, and nothing to do with user groups.)

    The best way to limit the number of abandoned chests is to only allow regular members or only admins to lock chests in the first place, not guests.

    Replies to page 29;

    I can't help unless you can figure out which plugin you added is the culprit. :3

    In theory, that should work?
    I assume you are using UTF-8 encoding in the strings.yml file?
    It is possible that minecraft client is having trouble with the non-roman characters on signs.
    Perhaps try with romanized labels? See: http://en.wikipedia.org/wiki/Romanization_of_Russian

    I see, it should be compatible with the most recent version though?
    Anyway, glad you got it fixed.

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: May 8, 2016
  6. Offline


    Yeah I didn't update it, Everything works great. :)
  7. Offline


    In regards to the new incarnation of the chunk ghosting bug;

    As these all seem to be related, I am replying to them together. The common feature is that they all seem to have started with recommended build 766, unless anyone can say for sure that the problem exists prior. Perhaps someone could run 733 or 740 for a while and see if the problem still occurs.

    The problem in is nature is odd indeed, but not unheard of. This has happened before when stuff was broken within bukkit, known as the chunk ghosting bug, but this incarnation seems to be different.

    I assume restarting the server makes the problem go away, for a while at least? Not the best solution though, I know, but as Lockette relies on Bukkit giving the correct answer on a block.getTypeId(). If Bukkit tells Lockette that a block is not a container, when it really is, there is noting I can do to prevent a container not being found.

    With MC 1.6 out and the bukkit team trying to integrate it, the problem may get worse or it may get better after the update. For now they are quite busy however, and I suppose we will have to wait and see.
  8. Offline


    Attempting to help here:
    Reloading (not restarting) the server does not fix this issue.
    Lately, it continues to get worse. Restarting the server did help fix it generally, but the success rate of that now is <50%.

    I still think its maps not loading entities correctly. You mention that it gets a block ID, and essentially, it just isn't loading to the map. Sign Shops are slowly getting worse under this as well. So yes it sounds like a Bukkit issue in the end.

    So it sounds like block.getTypeID() is not getting all the types if the map does not load correctly. It's not corruption, just not loading.
    Note the sign shop: iConomyChestShop - relies on chests near signs as well. Same ordeal as Lockette with a sign and a chest, and it too sometimes has issues finding the chest, especially the further away you are at a spawn.
  9. Offline


    Does anyone have any plugin that is altering the chucks that can load, granted my server isn't high stress like some if not all of yours are but there are plugins such as MM (Keep Minecarts Loaded) and a few Chunk pre-loader plugins that might be causing part of this issue, I could be talking out my ass, just an idea though
  10. Offline


    Hmm, not a good sign anyway.

    There was mention in the list of things fixed in the 1.6 update, of running out of memory corrupting the map, I wonder if it is related.

    This is possible too, yes. Possibly triggering if not causing directly.

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: May 8, 2016
  11. Offline


    oh noes! we have hatches now in Minecraft 1.6.4! Are you going to develop a newer version for the update?
  12. Offline


    I personally know I'm not using any plugin that alters chunk data, and yes my server is big, 100 player cap with 60+ players on at peak times.
  13. Offline


    Awesome mod!
    Me and my friends on the server used to love this mod, until a message came up saying:
    [SEVERE] Error occurred while enabling Lockette v1.3.8 (Is it up to date?): loader constraint violation: loader (instance of org/bukkit/plugin/java/PluginClassLoader) previously initiated loading for a different type with name "com/nijiko/permissions/PermissionHandler"
    java.lang.LinkageError: loader constraint violation: loader (instance of org/bukkit/plugin/java/PluginClassLoader) previously initiated loading for a different type with name "com/nijiko/permissions/PermissionHandler"
        at org.yi.acru.bukkit.PluginCore.setupPermissions(PluginCore.java:181)
        at org.yi.acru.bukkit.Lockette.Lockette.onEnable(Lockette.java:121)
        at org.bukkit.plugin.java.JavaPlugin.setEnabled(JavaPlugin.java:125)
        at org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(JavaPluginLoader.java:750)
        at org.bukkit.plugin.SimplePluginManager.enablePlugin(SimplePluginManager.java:253)
        at org.bukkit.craftbukkit.CraftServer.loadPlugin(CraftServer.java:131)
        at org.bukkit.craftbukkit.CraftServer.loadPlugins(CraftServer.java:109)
        at org.bukkit.craftbukkit.CraftServer.reload(CraftServer.java:336)
        at org.bukkit.command.SimpleCommandMap$ReloadCommand.execute(SimpleCommandMap.java:213)
        at org.bukkit.command.SimpleCommandMap.dispatch(SimpleCommandMap.java:97)
        at org.bukkit.craftbukkit.CraftServer.dispatchCommand(CraftServer.java:270)
        at net.minecraft.server.MinecraftServer.b(MinecraftServer.java:401)
        at net.minecraft.server.MinecraftServer.h(MinecraftServer.java:386)
        at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:292)
        at net.minecraft.server.ThreadServerApplication.run(SourceFile:394)
    Can anyone tell me how to fix it ant what's wrong? Thanks
  14. Offline


    Do you have more than one Permission plugins running?
    what's the output of /plugins?
  15. Offline


    ok. the first line on the sign is [Private], then the next line is my name. Now what D:
  16. Offline


    Now... you read the initial post completely, then actually try it out and if you still have unanswered question, then you come back and ask them.
  17. Offline


    What's an output of /plugins?
    And how can I have more than one permission plugin running?
    (sorry if I sound like a noob, but I'm only 11, forgive me)
  18. Offline


    Which plugins do you have installed? You can type /plugins in chat and it should show you the names of the plugins.
  19. Offline


    Enter your server and type /plugins then copy down the list it gives you and post it
    There are multiple permissions modules (permissions 2 and 3, group manager, essentials GM) and they conflict with one-another as they are all trying to do the same job
  20. Offline


    Hi, really nice plugin! It would be more awesome if you add for example commad [see] or [see-everyone] to make users see content of chest, but you can't store or take something (it could be used for shops). Also.. is it possible to lock levers or buttons? (remote controls of something important...). If someone else already posted this, I'm sorry.. Thanks.
  21. Offline


    The idea has been suggested and is good
    No it is not possible to lock controls, best bet there is to lock a door then have the controls some distance aay or round a corner from that door
    If the controls are right behind a door you can open the door and hit the controls while lockette realises you don't have access
  22. Offline


    Any chance of having more than one permissions group alerted when an Admin snoops?

    Edit: Also, I use Fencestack and don't see any problems. What problems are reported?
  23. Offline


    There is an exploit which will destroy protected chests
  24. Offline


    What version/flavor of the Permission plugin are you using?

    The error is coming from loading the Permissions you are using, not Lockette.
    The versions I have to test with work fine.

    I'll have to check out how hatches work, I haven't had a chance to actually play with the 1.6 update yet. :/

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: May 8, 2016
  25. Offline


    strange I tried to downgrade Permissions to, currently
    2011-05-26 18:34:07 [INFO] [Permissions] version [2.7.4] (Phoenix) loaded

    Maybe an idea for the future that you post which version of permissions you have tested against?
  26. Offline


    Do you think you can merge it with pwncraft so you can pick locks?
  27. Offline


    Your suggestion makes no sense. These two plugins have nothing in common that would justify a merge.
    What would a merge be good for? What if I need just the functionality of one Plugin?
    You can use one or the other or both.
  28. Offline


    It works now, something was wrong with the permissions plugin.

    Once again, Awesome mod! My server friends totally love this, thanks!
  29. Offline


    @Acru, you seemed to have missed my question. Any chance of having more than one permissions group alerted when an Admin snoops?
  30. Offline


    is there any way to convert all the protections from lwc to lockette like replacing the protection with the [private] sign and the name of the user.
  31. Offline


    Since LWC uses a database and Lockette uses "physical" objects then going round and doing it manually is the only way to do it, unless you want to go editing your world files but that seems like more work to me

Share This Page