[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


    My biggest request and I hope a good developer is taking this over to clean up the code. But also looking at better protection towards pistons. To prevent the use of them on the doors.
  3. Offline


    That's because it uses old hooks that were deprecated long ago in the bukkit code.
    In fact it uses both. (PlayerInteract() and PlayerItem())

    It even uses the old long constructor setup.
    Whilst i don't assume a lot has to be updated, it still isn't as bad as you make it out to be.

    That, or jd does a horrible job at decompiling it.
  4. Offline


    Im curious as to what a better implementation is.
    The current method is a syncRepeatingTask that runs every 10ms and checks a queue for any timed doors that need shutting.
    Versus creating a separate task for each (set of) door as a syncDelayedTask and let the scheduler handle it automatically.
    The 2nd method does make things a little tougher to cleanup open doors during a shutdown, Im sure something could be done by scanning through the waiting task list however.

  5. Offline


    That isn't the reason at all - JDGUI does a bad job at decompiling. There are undeclared variables and over-declared ones everywhere, to take an example.

    I would be interested in seeing the performance benefits of instead listening to on player interact and on redstone power and checking if the door should be closed then.
  6. Offline


    Brilliant, Chief! Will be watching to see progress. If you get a working copy, especially from scratch, fork it, please?

    Not a rush job, as I have it working just fine with 1060 and PermissionBukkit with superperms. Just want to add my encouragement!
  7. Offline


    Is the source available anywhere? Why do you guys have to decompile it? Will the developer not release the source? Why not have the community contribute by adding the project to github or bitbucket?
  8. Offline


    Well its not on github, and I cant access the root folder of where he hosts his download. Beyond that, the author is MIA so the source may as well be gone with him. Its not like decompiling java is the nightmare that any C variant is.
  9. Offline


    I have permissions (yeti) and none of my friends can open there chests? What permissions nodes do I need or do I need to edit the configuration file. Thanks!!!!
  10. Offline


    Its getting late here, so ill quickly say that I use, Lockette, play on otehr servers with Lockette and love the sign based system, unfortunately I have discovered a way to get into chests without leaving logs (ie) without pistons etc.
    The even sadder thing is that I can't recompile the fix I have into the code, due to the mess it and jad are. So in short I would like to be able to assist in a community recode of this project, maybe using the new Bukkit dev workflow. Making it the clearest, cleanest and neatests coded plugin, as well as the easiest and most efficient chest locker.

    CorumAnime likes this.
  11. md_5 that sounds awesome! All the best with it!

    I have a problem. I need to prevent lockette from protecting anything in one specific world (the PVP one).
    I can't find a way to do this, so at the very least let your plugin have an "Excluded worlds" list so that, in those worlds, its as if lock_md5 doesn't exist. if you know a way to make that happen now please tell me!
  12. Offline


    Ok, I've spent the last few days working on my own with it, recoding from scratch. I mean, I'm not getting very far with it. I think this could well be made into a community plugin. Hows about we start from what I've got a post it into a GitHub. Anyone wanting to contribute can :D

    Just ask me nicely ;)
  13. Offline



    Ive got to finish sign placement, piston protection, configuration loading, locale loading, add all the various permissions and admin overrides. Once im done with that, it should be done. May have forgotten something, but its pretty far along.

    If you worldedit the signs in, you should be able to test everything but the above.
  14. Offline


    Me Likey!
  15. Offline


    Oh, and grandfather in the old Lockette.* functions. cant break functionality can I now.
  16. Offline


    Looks good! Could do with some javadoc commenting once you are done though
  17. Offline


    Its always the obvious things that get missed. Ill add it to my list.
  18. Offline


    Well CorumAnime I haven't actually done anything yet. I was merely expressing my interest to help out in a recode. I see that daemitus has made great progress already. I have not coded anything major for Bukkit yet, but I would like to be able to help daemitus in his efforts. I guess daemitus if I can maybe have access to help out with some simple cleaning up of code (onsignchange events and such) but also just to help this project along. Although I have no facility to test it atm I would also like to point out that this version would also most likely suffer from the exploit I metioned above. In short I would like to become an assistant on this new plugin.

  19. Offline


    Im about halfway through redoing the onsignchange again. Should be functionally complete after this. Used the player.has(someperm) superperm method as something new. Thisll be fun fixing if it doesnt mix with essentials groupmanager and the other popular ones.

    Also, access is freely available on github, you can pull the source, or fork it easily enough. Send a pull request if you find something worth fixing. Once ive got a stable copy up I can add people to my own project for maintenance.
  20. Offline


    So who is taking over this and who is going create a dev page?
  21. Offline


    I'm doing a separate, complete rewrite because I had already started it before I saw @daemitus 's post.
    Inscrutable and Kane like this.
  22. Offline


    Thanks looking forward and let me know if you need in depth testing.
  23. Offline


    Adding to my answer to a previuos post, to prevent Lockette in a certain world, for now just remove the permissions.
    Also, sooo many rewrites, but for now I think I'll stick with daemitus' as it looks the farthest along.

  24. Offline


    Hm i love this i have one major problem i want them to be able to use this on chests in my bank but it is protected area so they carnt place signs to protect there chest Hm??
  25. Offline


    How in the world do I get Configuration to save nodes in order. Its all messy and random :\

    imp /lockette reload again?
    cleanup onCommand
    External functionality. Lockette._____ methods
    Lock Your Chest reminder, once per login.
    Fix listener priorities

    If anyone feels in the mood for a little bug finding, head over to
    I'm only using superperms atm.

    Open up the jar in your favorite zip program and look at the plugin.yml for more detailed info and what all is contained in each. If you have the broadcast perms, you get sent announces such as AdminBob snooped in joe's chest.

    9am, I think this marathon session is over.
  26. Id Like to report and exploit with Lockette, when using spoutcraft and effective arrows plugin.

    Lockette seems to protect against fire and breakage but fire arrows can burn thru a lockette lock and render the lockette plugin now useless. please update!
  27. Offline


    It seems to be due to the below in EffectiveArrows
    Because the arrow can land inside the same block as a sign, it doesnt do any checking and just sets it to a fireblock.
    Nothing I can really do.
  28. Offline


    I had started it but gave up after I saw @daemitus was writing it. I might make a kinda spin-off though.
  29. Offline


    Thus far, I haven't. I don't save config nodes (because it overwrites comments in the file as well) and instead download a fresh copy from github.
  30. Offline


    Oh my, I never thought of doing that.
  31. Offline


    I set up all of the nodes and NO ONE not even my admins can use chests. What do I do?????? Thanks!!!!

Share This Page