[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


    Yea, at the time when I started Permission support, it was the one to go to, but now... I'm open to suggestions what would be the next thing to support. :3 It needs to have a function for getting user permissions, and one to see if a user is in a group. I'll look into those you mentioned though.
  3. Offline

    Andy Candyman

    using the op.txt just made my day
  4. Offline


    I love this mod!

    We have one small problem with it at the moment though.

    We seem to have hit some sort of "limit." (on a small server with about 8-10 people).

    Whenever someone attempts to protect a chest they get told: "No unclaimed container nearby to make private."

    If we delete another chest, they can create a new one, but then we get that error again. (I'm not sure on the exact number of protected chests, but I'd estimate maybe 100.+

    Edit: doing a /stop and then restarting my server fixed this. I had been doing a lot of updating .jar files and then doing /reload (which I know isnt the best way to do things) so somthing must have been munged up.
  5. Offline



    Hmm, this doesn't make sense to me, as the plugin doesn't track and has no way of knowing how many protected containers there are. That message is only thrown up after checking the 4 neighboring blocks for unclaimed containers. Try putting a chest in the middle of a new open area and protecting? Try restarting the server? Provide more info on craftbukkit version and other plugins used, that could be conflicting?
  6. Offline


    So my console gets spammed with this anytime someone places a chest. CB 446

    07:33:44 [INFO] A plugin cancelled the block start break event
    07:33:44 [INFO] A plugin cancelled the block start break event
    07:33:44 [INFO] A plugin cancelled the block start break event
    07:33:44 [INFO] A plugin cancelled the block start break event
    07:33:45 [INFO] A plugin cancelled the block start break event
    07:33:45 [INFO] A plugin cancelled the block start break event
    07:33:47 [INFO] A plugin cancelled the block start break event
    07:33:47 [INFO] A plugin cancelled the block start break event
    07:33:50 [INFO] A plugin cancelled the block start break event
    07:34:12 [INFO] A plugin cancelled the block start break event
  7. I'm quite a Fan of Lockette as it provides a simple Way to Protect Stuff :) and you don't have to use SQL Tables etc. to prevent Players from grieving each other.

    Today I updates to 1.2.1 and got the Same Problem as Torteth.
    Maybe Notch changed something on the Sign's?
    Because they seem to don't get attached to the Chests anymore. They stand were they have been placed and just get rotated.


    Looks strange :/ Beside that, that does only work on "old" Chests. On new one's they don't get attached and a Warning is given saying : No unclaimed [...]


    The Craftbukkit Version is git-Bukkit-0.0.0-468-ga3bf56c-b450jnks
    Lockette is the Only Plugin I use that actually change's something in Minecraft. The other ones I use a merely Chat modifications (Death Notification, MOTD) so I don't think that's a Problem of "they don't get along"

    No Error is written in the Log - as far as I can see. I Hope this Post was a little Help.

    Sincerely, JK


    After a restart everything seems to just work fine :/
    Tried it on an "old" Chest and placed a new Chest - everything worked :)
    I'm gonne spend some time playing and watch out if it happens again. Like the "Indestructible Block" Bug
  8. Offline


    I have someone on my server who has a name that doesn't fit on one line of a sign. Will I be able to let him use my chest by entering part of his name, or will it not work for him?
    I'm just curious to see.
  9. Offline


    Its very well possible this is related to the minecraft block indestructible bug that servers get after a while, as to attach the sign to a chest, it has to change the block from #63 to #68, and it may interfere with the detection of new chests, if there is some sort of synchronization issue.

    I don't think this was happening in CB 450, however? (I can't test every intermediate version, hee.)
    I'll watch for this though.
    --- merged: Feb 27, 2011 3:32 PM ---
    Use the first 15 characters of the name and it will work.
  10. Offline


    I tried 450 earlier yesterday and Lockette wouldn't even load, it would say it failed to load in the console when starting the server.
  11. Offline


    Thanks! Stopping and starting the server (CB440) fixed it. I just placed 64 new chests and they all protected just fine.

    Thanks for the prompt response!
  12. Offline


    457 seams to produce this error. I guess the latest Bukkit changed some stuff.

    19:38:41 [SEVERE] PLAYER_COMMAND loading Lockette v1.2.1 (Is it up to date?)
    java.lang.NoSuchFieldError: PLAYER_COMMAND
            at org.yi.acru.bukkit.Lockette.Lockette.onEnable(Lockette.java:111)
            at org.bukkit.plugin.java.JavaPlugin.setEnabled(JavaPlugin.java:117)
            at org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(JavaPluginLoader
            at org.bukkit.plugin.SimplePluginManager.enablePlugin(SimplePluginManage
            at org.bukkit.craftbukkit.CraftServer.loadPlugin(CraftServer.java:83)
            at org.bukkit.craftbukkit.CraftServer.loadPlugins(CraftServer.java:61)
            at net.minecraft.server.MinecraftServer.e(MinecraftServer.java:204)
            at net.minecraft.server.MinecraftServer.a(MinecraftServer.java:191)
            at net.minecraft.server.MinecraftServer.d(MinecraftServer.java:131)
            at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:246)
            at net.minecraft.server.ThreadServerApplication.run(SourceFile:366)
  13. Offline


    Doesnt work with 463. waiting for update. please.
  14. Offline


    I was wondering. I'm in bed now but has anyone actually tried it?? Someone said some plugins gave errors but worked flawless. I would assume it would just disable it though.
  15. Offline


    It seems they removed the PLAYER_COMMAND event in build 454, and they want you to use the onCommand method instead, but the onCommand splits the arguments string for you, but the wrong way for me...

    This is for handling of the /lockette commands.
    --- merged: Feb 28, 2011 7:35 AM ---

    New version released to fix the issue with CB 454+, and one other I noticed.
    --- merged: Feb 28, 2011 7:53 AM ---
    Oh, missed this before, it may be that another plugin is interfering somehow, or you are using an old version of the plugin?

    By the way, I found out that the '[INFO] A plugin cancelled the block start break event' is being issued by some debug code in CraftBukkit (See: https://github.com/Bukkit/CraftBukkit/commit/557f3d2e5d599e8f65f9e41d5246a7ef195960a0 ), but I can't do anything about that.

    You'll have to talk to the bukkit devs. :3
  16. Seems to be in a conflict with Stargate and I can't use both on my server :(
    Because when I try to place a sign saying [Private] the console gives a Stargate error and a [?] is written on the sign after I place it :>
  17. Offline


    The [?] is generated by my plugin when it can't find a lockable container. I assume you tried Lockette without stargate plugin enabled, to be sure it worked (and you are using properly) alone?

    I don't know why stargate would throw an error, but be sure you are placing the sign directly adjacent to a container. Oh, and restart the server, as it may be that MC 1.3 "Indestructible Block" bug here too.

    I grabbed the Stargate 0.17 and tried to lock a chest and also put the sign not next to a chest, and both worked as expected for me.
  18. Offline


    Great plugin.
    Really looking forward to door protection!
  19. Offline


    Fantastic plugin.

    Is there a reason you decided to only check for NESW signs and not above/below. I'm using Signtrader and would like to combine it with Lockette, but that beings to take up lots of space with signs. If the chest "ownership" could be below the chest, then it could be out-of-sight but still very functional.
  20. Offline


  21. Offline


    Check this post for details of why. :3

    It is possible, however, that I will add a way anyway if I go to add door protection.
  22. Offline


    Thanks for the reply Acru. I carefully read this thread and your responses about why you only allow signs so that they stick to chests.

    I believe that the feature that I (and at least one other) requested with chests protected by signs below may be implementable while still keeping to your speed paradigm. You currently only run your protection checks if the block being destroyed is a chest or a sign. Assume for a moment something allowed you to create "standing" signposts on top of a chest block. If you had a chest on top of a protection sign on top of a chest, the sign could protect both chests from destruction (checking up/down on the chest destroy event) and could protect itself(chest below protection sign = protected).

    This solution checks only 50% more blocks that your solution, and doesn't require checks against any new materials (so no poor performance from 50 miners). What do you think? If implementing it would take more time than you'd like, I could contribute to your code. I didn't see a source link though, so you may not be interested in sharing it.

    I think I foresee one problem, in that you end up with signs protecting multiple chests, which can result in people placing chests next to a sign to "grief"
  23. Offline


    Standing signs are attached to the block below, yes, and could be used to protect containers below the sign, though this is not implemented at the moment. (Is there any use for this alone? Most people just want to hide signs below.) It is too bad there is no such thing as hanging signs. :3

    For doors however, I will need to protect the block below the door.
    So for all types of blocks being broken, I would have to check if the block above is a door.
    As we already had to fetch the block, we could check if it is a container too with no notable additional load, and before checking for signs on that block and etc.

    I suppose you can expect this when doors are added.
  24. Offline


    is it possilbe to add a group limit chest protections? it will be a nice feature [​IMG]
  25. Offline


    I keep getting this "No unclaimed container nearby to make Private!"
  26. Offline


    As I've said before, it is not possible to put any limit on the number of protected chests, as there is no database of chests. Sorry~ (Is this what you ment?)

    This is either from putting the sign in the wrong place, or from the 'block reappearing' bug where the server gets confused about block states. (The latter is fixed by restarting the server.)
  27. Offline


    The text file has unix line endings and UTF-8 format (don't use basic notepad to edit), and it should look like this on a single line:
    msg-admin-snoop: ""

    I'm not sure what you mean by login message though?
  28. Is there a limit to the number of locked chests per user? It will not let me have more than one, it says "You already have a locked chest" or something to that effect. Can we make the limit on our server higher?
  29. Offline


    There is no such message in lockette, and no limit. (All lockette messages start with "Lockette:") Perhaps another plugin such as LWC is causing the message?
  30. Offline


    I don't seem to see a permission for allowing specific groups to create the signs? If it's already in there and I'm blind and can't read please ignore me, but if it's not there is it possible for you to create one? I want to give chest protection to my more dedicated players as a reward, not for everyone.
  31. Offline


    See my profile for installed mods...no conflicts.
    Installed. Works. Cheers Acru. +1

Share This Page