[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


    This plugin and the Stargate plugin (http://forums.bukkit.org/threads/tp...t-port-a-portal-plugin-b53jnks-b439jnks.3927/) don't seem to like each other.

    When someone puts a sign on a chest I get
    18:03:57 [SEVERE] Could not pass event SIGN_CHANGE to Stargate
        at net.TheDgtl.Stargate.SignPost.getParent(SignPost.java:27)
        at net.TheDgtl.Stargate.Portal.createPortal(Portal.java:617)
        at net.TheDgtl.Stargate.Stargate$bListener.onSignChange(Stargate.java:335)
        at org.bukkit.plugin.java.JavaPluginLoader$26.execute(JavaPluginLoader.java:252)
        at org.bukkit.plugin.RegisteredListener.callEvent(RegisteredListener.java:59)
        at org.bukkit.plugin.SimplePluginManager.callEvent(SimplePluginManager.java:225)
        at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:812)
        at net.minecraft.server.Packet130UpdateSign.a(SourceFile:39)
        at net.minecraft.server.NetworkManager.a(SourceFile:230)
        at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:75)
        at net.minecraft.server.NetworkListenThread.a(SourceFile:100)
        at net.minecraft.server.MinecraftServer.h(MinecraftServer.java:357)
        at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:272)
        at net.minecraft.server.ThreadServerApplication.run(SourceFile:366)
    in the console, Lockette says that <player> has claimed a container, and the sign appears with [?] on it. Anyone can open the chest afterward.

    All the previously protected chests are still protected.

    CB build 493
    MC 1.3
  3. Offline


    WARNING: ColorSign breaks Lockette chest protection.

    Please fix!
  4. Offline


    This is on the to-do list above. Watch for it in a future version.
    A question though, do you use Permissions or a different group mod?

    Yer welcome~ :3

    Yes, builds of CB since the MC 1.3 update have issues, hopefully they will be sorted out in later builds.

    Does restarting the server make the error go away? If so its the same as the above issue.

    I am aware of the issue with sign editor plugins, and I'm afraid there isn't anything I can do to stop it within my plugin. Sign editors don't ask for permission to change sign text, or send an event, they just do it.

    You can either do without the editing plugin, or ask the ColorSign people to disallow editing of signs that start with something in square brackets, for compatibility with Lockette.
  5. Offline


    Could you make this work with doors aswell? would be really awesome if you could
  6. Offline


    It is on the to-do list, yes. I'll have to add this soon so people don't keep suggesting. XD
  7. Not really wanting to read 7+ pages of comments i just wanted wanted to state the fact that the signs only go up the 14 letters and Minecraft allows 15 letter names... just wanted to know if this is being handled or not well thats all i wanted to say so bye.
  8. Offline


    @Acru Any updates on the sign shop chest system! :)

    I think that was fixed the same way bukkit does say wildcards without needing to add it. so the /ban Kan should ban Kane if he is online. Well the same way with the chest as far as I know.
  9. Offline


    Another bug: [Removed to protect the vulnerable]
  10. Offline


    This is a fantastic plugin, and surely one of my favourite ones.
    Simple, functional and clean.
    I honestly can't wait for new versions. Keep it up!
  11. Offline


    I use permissions by NathenWolf
  12. Offline


    Couple times I have run into a chest that refuses to be locked. When placing a sign next to the chest with nothing else around it I get the red error that says no unowned container nearby. However sometimes all I get is a sign in front of the chest with a [?] on it. While on the Server Console it is showing that I have claimed a container. Any ideas what may be blocking it?
  13. Offline


    Having the same problem as well. -.-
  14. Offline


    Yep, claiming is broken on build ~493. Dunno about already claimed chests, though.
  15. Offline


    Pretty tired of bitching.
  16. Offline


    This plugin doesn't work all the time for me either, but you should chill out, or take your attitude elsewhere.

    AFAIK the problem is with Bukkit, and not this plugin. Just be patient.
  17. Offline


    I was getting this same problem for a while on my server a couple days ago (with 493) but I haven't come across it recently :/, strange.
  18. Offline


    it says that : lockette [is it up to date] it worked for 20 min ago , but i restarted th server and it sad that. what can i do? help?

  19. Offline


    works great thank you [​IMG]
  20. Offline


  21. Offline


    I had that problem too on 493, but a quick /reload fixed it. Not sure what the problem was.
  22. Offline


    Perfect plugin for my small VPS server. No database = no resource hogging.
    Keep this plugin simple, dont clutter it up like others.

    Thanks for the plugin
  23. Offline


    Hello, since the #493 I have this error.

    I have 120 players on my server and all the chest are now unprotected :S

    Can someone help me ?


    EDIT :
    I upgraded my java and it's now working.
  24. Offline


    Yea, that fixed it. Thanks :D
  25. Offline


    Any news?
  26. Offline


    I hope this plugin did not die :(
  27. Offline


    Acru's a bit busy, but should be back soon. That said, a lot of people have Lockette working just fine. Two others who initially had issues reported that:

    1. Upgrading java fixed it
    2. Typing /reload fixed it

    Make sure your Java is up to date, and try reloading the server.
  28. Offline


    Busy indeed, it has been a busy week for me, but hopefully I can catch up this weekend~

    There seems to have been a number of recommended build updates to try and cover the recent problems in Bukkit itself, but hopefully they have it sorted out now. First, to see to the thread...
    Signs can have up to 15 characters, names longer than this are truncated to 15 and are handled as such.

    No progress, sorry, that one is on hold for lack of time.

    Hmm, I'll have to fix this.
    Also @Source011, @OFKNV, @AgentKid, @Kaseki, @fuzetsu490, @g00tch,

    This is a problem with in many version of bukkit after the MC 1.3 update. It seems to be caused by the server being in two minds about the current state of a block, eg. a chest is there in the chunk but Bukkit is telling plugins that there is no chest, causing the fallback to [?].

    The simplest way to fix this is restarting the server, but I'm aware that the Bukkit team has been working on the issue, though I'm not sure if they fixed it in the more recent builds. If you encounter this problem in recommended build 522/527/531 or greater still, let me know as its hard to make the problem appear during testing.
    I don't think so, it uses the lua language for plugins and it is a totally different architecture, as it is a minecraft server from scratch. I'd have to learn all about the interface to know if its even possible to make something similar or not, and also learn lua. :3
    You are welcome, and thanks for the positive feedback. :3
    ZachBora likes this.
  29. Offline


    Works wonders, thanks
  30. Offline


    Love it. Thanks.

    Did I miss something or is there a way for an admin to sign a chest as being public, ie. you can put a chest somewhere then make sure no-one locks it? yes I missed something :) Thanks
    Still love the plug-in ... but one thing strikes me as odd ... that signs are marked


    Couldn't they just be marked [EVERYONE] and still be protected from damage?
  31. Offline


    The tag [Everyone] here is being used as a user group that includes all players, like you could use [Admins] if you are using Permissions user groups, and could potentially be cleared or edited by the owner using '/lockette 3 <newtext>'.

    It could be done the other way too, yes, but it doesn't. Is this okay? :3

Share This Page