[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


    Doh. Forgot to make it backwards compatible. Give me a minute.
  3. Offline


    I would love to see integration with Towny and other land plugins, for the option to automatically unlock protected chests if an area falls into ruin, the owner doesn't pay rent, etc. On one of the servers I play on, there are failed towns everywhere that have returned to wilderness that anyone can claim, but old lockette chests remain strewn about that no one can access without admin assistance.

    Would that be a Lockette task, the land plugin's task, 3rd party plugin job, or ???

  4. Offline


    Towny just recently made a system where you can listen to towny events. Most likely, youd have to listen to the land unclaim or town disband and go block by block, plot by plot searching for valid signs. It wouldnt be a lockette thing though.
  5. Offline


    Just let us know when the plugins are up on bukkitdev/here. I need a backwards-compatible solution. We have lots of chests claimed from lots of users.
  6. Offline


    The plugin is backwards compatible with acru's Lockette. Since I changed the package from his however, it vomits errors because ChestShop is still looking for org.yi.acru.lockette.Lockette rather than com.daemitus.lockette.Lockette. Im working on the bukkitdev post now. For other things that conflict, throw me a bone and Ill contact the other devs.
  7. Offline


    Does ChestShop still work? I don't have the resources to also run a test server.
  8. Offline


    I compiled a version of chestshop that imports mine instead of the original. As soon as I have the bukkitdev post up, I can post the links globally and push requests to the other authors.
  9. Offline


    Hello daemitus,

    Ive been testing your plugin so far nice work however with the simpleclan system would you be able to change it from [Clanname] to [Clantag] the reason for this is the names dont allways fit on the signs
    BOB = Band of Brothers(Too Long)

    Ive checked and you can not create two clans with the same clantag.

    Again thanks
  10. Looks like its conflicting with "Stargate" if i have Stargate and Lockette running together i cant use my stargates anymore, also i cant create new stargates... i know its inactive, but maybe you could take a look at it.

  11. Offline


    (1) Its not quite Inactive, there's a new build happening. Look up!
    (2) Stargate 0.64 and above are compatible with Lockette. Earlier versions conflicted with it somewhat.
    (3) Both Lockette 1.38 and the new dev build are fully compatible with Stargate v.0.66
    (at least under Bukkit RB#1060 and using PermissionsEx)

    Greetings again, daemitus! I have road tested your latest Lockette build (1.0) alongside the patched ChestShop and Cenotaph builds you provided. I also put in Stargate 0.66 and PermissionsEx 1.13 to manage the lot on a test server.
    (1) ChestShop and Cenotaph seemed to work properly as far as I could tell. No problems.
    (2) Stargate 0.66 is indeed compatible with this mix, it worked with delightful speed.
    (3) Lockette keeps telling me that I dont have permission to alter the sign every time I click on a ChestShop sign or a Stargate Sign. It does not interfere. just spams a warning.
    (4) When set to shut doors automatically, if a door is closed before the timer is up, it opens-and-closes the door.
    This also applies to trap-doors (hatches). By the way, nice job on getting hatch protection to work!
    (5) SERIOUS BUG: De-opped and without permissions to do so, I found I could dig out the blocks that Lockette signs were resting on, and make the door and sign fall (destroying it). Signs I did not own.
    The block the Lockette is resting does not appear to be (effectively) protected.
    The server threw the following error:
    2011-09-01 01:12:23 [SEVERE] Could not pass event BLOCK_BREAK to Lockette
    java.lang.ClassCastException: org.bukkit.craftbukkit.block.CraftBlockState cannot be cast to org.bukkit.block.Sign
        at com.daemitus.lockette.events.BlockListener.onBlockBreak(BlockListener.java:66)
        at org.bukkit.plugin.java.JavaPluginLoader$37.execute(JavaPluginLoader.java:497)
        at org.bukkit.plugin.RegisteredListener.callEvent(RegisteredListener.java:58)
        at org.bukkit.plugin.SimplePluginManager.callEvent(SimplePluginManager.java:338)
        at net.minecraft.server.ItemInWorldManager.c(ItemInWorldManager.java:157)
        at net.minecraft.server.ItemInWorldManager.a(ItemInWorldManager.java:121)
        at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:481)
        at net.minecraft.server.Packet14BlockDig.a(SourceFile:42)
        at net.minecraft.server.NetworkManager.b(NetworkManager.java:226)
        at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:89)
        at net.minecraft.server.NetworkListenThread.a(SourceFile:105)
        at net.minecraft.server.MinecraftServer.h(MinecraftServer.java:454)
        at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:363)
        at net.minecraft.server.ThreadServerApplication.run(SourceFile:422)
    So, I guess a bit more patching is in store. Brilliant work so far, though. :D

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
  12. Offline


    Changed so you can have the [ClanName] or [ClanTag] whichever someone wants to throw on a sign.

    That fix should be pushed to github I think. I didnt check if the block was a sign before casting it to a sign.

    Ive got a simple fix for that.

    All the updates are going to have to wait for tonight, seeing as I need to hash out something with my help. Theyre all minor fixes however, so nothing bad is going on.
  13. Offline


    Yea i thought about limiting the names but i feel having [clantag] would have a much better feel overall matching the chat prefix and spout extras, precious stones/permisson groups. However the choice is yours. Just let me know

    Again nice work.
  14. Offline


    When i put a sign saying [Private], other people can still open my door. And i don't want other people to open it.
    Can someone please help!!!!!!!! :(
  15. Offline


    Everything is pushed to github, SimpleClans bridge for [ClanName] and [ClanTag] is in, sound effects options for iron doors, and timed doors, removed excess sound effects so youll only hear one door toggle instead of 4, 1 for each block.

    If you could give some more info, maybe your config, where the sign was, anything.

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
  16. Offline

    Nathan C

    Please don't let this plugin die!
  17. Offline


    maybe after i'm done with my project i will continue this, if no one wanna take over this project
  18. Offline


  19. Offline

    Cosmic Break

    this plugin has a major exploit on servers using craftbook.


    This has been fixed, MAKE SURE YOU UPDATE YOUR PLUGINS!
  20. Offline


    mind explaining?
  21. Offline

    Cosmic Break

    I'll PM ya, its semi private
  22. Offline


    Apparently OLD versions of craftbook had an exploit where you could toggle a gate and it wouldnt check the blocks inbetween, popping your signs off. UPDATE YOUR PLUGINS.

    Cosmic and I tried to recreate the bug from the forum post on some hack website, couldnt get it to work with the most recent build.
  23. Offline


    New Lockette version works a treat, No more block destruction or spammy messages. Doors still do quick open-shut at the end of the timer if closed beforehand, but thats a minor quibble. Congrats, be seeing you on BukkitDev!
  24. Offline


    All, once @daemitus has the community admins' official blessing with a live project on BukkitDev, I'm going to begin work on Cenotaph 1.7, which will include a change to his Lockette versions.
    Inscrutable likes this.
  25. Offline

    mbaxter ʇıʞʞnq ɐ sɐɥ ı

  26. Offline


    Ive gotten the go ahead on that, however they did add the caveat that if acru shows up and disapproves, bad things may happen.

    Id love to have his permission if he had logged into the site since the beginning of july.

    Worst case, I change the name and press on calling it a fork.
  27. Offline

    mbaxter ʇıʞʞnq ɐ sɐɥ ı

    @daemitus sounds good to me. Just was making sure you're not one of the "it's open source, this is my right to use its name" types. Glad someone's picking it up, saves me time from my promise earlier in the topic to keep it up to date :p
  28. Offline



    If you goto devbukkit to get files, make sure you use the link on the front page instead of the Files area. Everything that I post needs mod approval before it shows up. Alternatively, use github.

    Still need to make a new thread here. Ugh
  29. Offline


    What's the
  30. Offline


    Because I reused the same name, if some other addon, say Cenotaph or ChestShop tries to force a Plugin type into a Lockette type, it will cause an error. As it is looking for org.yi.acru.Lockette but finds com.daemitus.Lockette.

    Basically, if you install this new version and get an error, roll back to the original and tell me which other plugin is breaking. Ill make a new copy and post it with the others on the devbukkit
    Ive already got 2 up there from Inscrutable?'s post about errors.

    Your signs ingame will still be fine, nothing has changed with that.
  31. Offline


    Awesome. You are my best friend, thanks again for doing this.

Share This Page