[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


    So the sign will stay in front of the door?

    I personally think that if that is the you can write it, it should be fine. It will also be another thing for say a greifer or trespasser, if there is a sign plain as day there is no excuse. IMO from running a server.
  3. Offline


    Incidentally, I forgot to reply to this, I'll start putting the static jar here.
  4. Offline


    Placing the sign below the door would leave you with just one spot for the sign, eliminating the possibilities for [More Users] signs. Also, if you want to lock a room on the 2nd floor in a building, you would be forced to make thicker floors between the stories to be able to hide the sign underneath the door.

    I would very much like to see a more flexible solution such as being able to put the sign either hidden under the door, or onto the wall right next to, or above the door. This would also leave you with plenty spots for [More Users] so you can allow additional players of your choice to enter through the door.

    Walking through the sign itself would look kinda silly i think ;) Specially for those striving to make realistic constructions.

    I also have a suggestion for the chest protection part; how about being able to add [Donate] to the third line? It would work just as [Everyone], except users could only put ting into the chest. Only the owner/users would be able to take stuff out of it.

    Also having a sign that says


    is kinda contradicting ;) Changing the [Private] tag to [Owner], while leaving [Private] for the door lock sign would make more sense. But that is just cosmetics.

    BTW, love your plugin!

    Oh, just thought of another thing. Is it possible to make the sign on the chest invisible/transparent? Maybe through a third line option [Invisible]. That way you don't have to bother about hiding the sign in the wall, which also is not possible in all cases.
  5. Offline


    This is a point yes, unless you have a wall in the same place to hide it. I'm trying different things, at the expense of delaying the next version, heh. I have a couple interesting ideas I want to try, but in the end sign placement will be restricted on doors, to minimize global processing required. (Global as in every time a block is broken, etc.)

    Not possible, I'm afraid. At least, not possible without a whole bunch of new code. This suggestion is for something more in the realm of a shop plugin, one that uses false inventories.

    I've considered alternatives, but I'm afraid I'm stuck with the [Private] header now. You are free to use your own alternate header on your server, though, by editing the strings.yml configuration file! So you can use either [Private] or [Owner] where you like. (alternate-private-tag)

    This is not possible, as the minecraft client determines how things render, and the client is vanilla even if you are using CraftBukkit on the server side. The server would have to tell the client its not a sign, and well, this isn't something CB can do right now anyway.
  6. Offline


    I would say above the door for the main sign:
    other user
    other user

    If others are needed to be added, the signs could be placed on the sides of the door?
  7. Offline


  8. Offline


    Mkay, I'll leave a note there.

    Edit: He said it was accepted~
  9. Offline


    Doesn't work for me. I've placed the sign on all sides, nothing, I try both:


    and just [Private]

    nothing... the sign doesnt attach to the chest like the screen shts
  10. Offline


    In regards to doors, is it possible to make the sign disappear after placing it? For instance in the IOBookcase plugin u place a sign on the bookshelf to type what you want added to the bookshelf. After clicking done, the sign contents are transferred to the bookshelf, the sign disappears and is placed back into your inventory. Then allow the door to be destroyed only by the one who placed it.
  11. Offline


    You'll have to provide more details, and say what versions you are using, and perhaps a console log or info about messages. :3

    Currently I'm recommending craftbukkit build 552 or higher, due to an issue that crops up in earlier builds.

    What you describe is a plugin that uses a database to store the information, this plugin does not use a database.

    Once complete, you will be able to hide the sign in the floor however, attached to the block under the door.
    Full details will come with the update.
  12. Offline


    Sorry. Using the latest build of both this and c-bukkit. I place the sign down and type as I said and nothing happens. Is it supposed to attach onto the chest?
  13. Offline


    Still not enough information~ Yes it is supposed to attach to the chest, as shown in the pic.

    What does the console log say? (Does the plugin say it is loaded?)
    Any error messages ingame? (There should be something, if it doesn't attach.)
    Which CB build exactly? (Latest changes all the time.)

    You extracted the zip, and put the jar in the plugins folder, right?

    To everyone waiting for doors, I've run into a serious issue... I can't keep wooden doors from opening in bukkit.

    I've added a task on the tracker, vote for it if you want it:

    For now, I'm trying to do something with iron doors only.

    Update: Came up with a workaround that seems to do the trick, so nearly done.
    Update 2: Doors are finished! And they are working quite well, now I just need to do stuff for new permission compatibility... But I'll leave that til next version. :3

    Just letting you know, you can give 'er a try now~ :3

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


    The plugin works for me but I keep getting this error:
    2011-03-17 20:47:56 [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:118)
    at org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(JavaPluginLoader.java:451)
    at org.bukkit.plugin.SimplePluginManager.enablePlugin(SimplePluginManager.java:217)
    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)
    Any ideas? Also, I don't like permissions right now because it doesn't work for me. It broke and I can't update it.
  15. Offline


    That issue was fixed in version 1.2.2, and the current version is 1.3. :3

    I'm hoping for Permissions to become more reliable too. Its optional, anyway.
  16. Offline


    Okay well I have bukkit 531, will 1.2.2 work with that? Also, can I have the link for a dl please! I can't dl 1.3 because I am on bukkit 531...
  17. Offline


    They fixed a major issue in 552 so I'd recommend updating to CB 556:

    But if you can't, Lockette 1.3 will more or less work on builds as low as 323. If you still want 1.2.2, check the 'Older Version History' section.
  18. Offline


    Okay I will try thanks

    What was the major update that was in 552?

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


    There was a fix for the chunk ghosting bug, causing plugin programmers all kinds of problems, due to bukkit sending plugins out of date data. See http://leaky.bukkit.org/issues/553
  20. Offline


    In this you said you can apply the signs TO the doors, how do I do that? As i would rather not clutter the front of the doors lol

    Edit: I figured that out I though the sign in front of the door would stay on the post. But is it possible to have 3 signs attached to one door?
  21. Offline


    Is there a wat to disable item protection? I'd like just chest protection enabled on my server.
    Perhaps permission nodes? EG:

  22. Offline


    I wonder... while you're still at it and expanding the usage of it... might there be a possible solution to lock a lever?

    Etc putting a sign on the same block as the lever is placed on, making others unable to pull it, good for etc farms so curious people don't flip it and ruin tons of work.
  23. Offline


    Door lockage works great, if you lock a double door clicking one of them to open/close will open/close both doors. I'm not sure if this was intentional, but I like it.
  24. Offline


  25. Offline


    Depending on where you want to put the signs, the number of signs can vary. 13 placements are possible for a single door, though it would render the door useless if you used them all. Typically there are 3 placements not including on the door itself. (Two on the bottom block, to the left and right, and one on the top on any side.)

    I'll add nodes for this next minor version. Btw, what Permissions plugin do you use at the moment? I have not had a chance to do proper testing with the Phoenix ones yet.

    You could put the lever in a room with a locked door? :3
    Trying to lock the lever itself might be glitchy.

    This was intentional yes. ^.^

    Yer welcome~
  26. Offline


    Door locking is broken. It doesnt let u open it with right click but you can open it fine with left click
  27. Offline


    I can't reproduce this, and I handle both right clicks and left clicks. Perhaps it is another mod conflicting?
    I'll need more details.
  28. Offline


    Alright. Using craftbukkit 531. Plugins: MiningTNT, AntiBuild, Essentials, Fake Permissions, Group Manager, Heroic Death, iChat, Lottery, SimpleShop, mcMMO, WorldEdit, BlockHead, Minecart mania suite, Essentials Spawn, Minequery, MultiVerse, MyHome, SignColours, Spawnr, Sponge, WorldGuard, BigBrother, Lockette, iConomy, RegionMarket, AnjoSecurity, SkyPirates. Those are all of them. I didnt update the settings file for Lockette tho, only the jar file. Any suggestions
  29. Offline


    link aint working atm
  30. Offline


    That is quite the list!

    I tried CB 531 and it worked for me, though this may be the cause of your problem. Try restarting the server. If the doors work properly after restarting, your problem is due to the chunk ghosting bug and please update to build 552 or greater.

    If the doors still don't work after restarting, I don't suppose you could narrow it down by disabling a few plugins at a time?

    Settings should be updated automatically.

    Hmm, it looks like my web host is down at the moment, yeah.
    Give it half an hour or so and see if it comes back, else I'll have to find an alternate.

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


    link fix pls

Share This Page