[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


    out of curiosity, do you have a source I could look through so I can hook into this with my plugins?
  3. Offline


    Is it compatable with a 1.4 Server?
  4. Offline


    *cough* read previous posts *cough*
  5. Offline


    I'm running CB 617 and it looks like it's conflicting with groupmanager

    18:41:34 [INFO] Lockette version 1.3.3 is being enabled!  Yay!
    18:41:34 [INFO] Lockette: Detected craftbukkit build [617] ok.
    18:41:34 [SEVERE] tried to access class org.anjocaido.groupmanager.GroupManager$1 from class org.anjocaido.groupmanager.GroupManager loading Lockette v1.3.3 (Is it up to date?)
    java.lang.IllegalAccessError: tried to access class org.anjocaido.groupmanager.GroupManager$1 from class org.anjocaido.groupmanager.GroupManager
            at org.anjocaido.groupmanager.GroupManager.enableScheduler(GroupManager.java:106)
            at org.anjocaido.groupmanager.GroupManager.onEnable(GroupManager.java:83)
            at org.bukkit.plugin.java.JavaPlugin.setEnabled(JavaPlugin.java:118)
            at org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(JavaPluginLoader.java:514)
            at org.bukkit.plugin.SimplePluginManager.enablePlugin(SimplePluginManager.java:216)
            at com.nijikokun.bukkit.Permissions.Permissions.onEnable(Permissions.java:61)
            at org.bukkit.plugin.java.JavaPlugin.setEnabled(JavaPlugin.java:118)
            at org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(JavaPluginLoader.java:514)
            at org.bukkit.plugin.SimplePluginManager.enablePlugin(SimplePluginManager.java:216)
            at org.yi.acru.bukkit.Lockette.Lockette.setupPermissions(Lockette.java:277)
            at org.yi.acru.bukkit.Lockette.Lockette.onEnable(Lockette.java:129)
            at org.bukkit.plugin.java.JavaPlugin.setEnabled(JavaPlugin.java:118)
            at org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(JavaPluginLoader.java:514)
            at org.bukkit.plugin.SimplePluginManager.enablePlugin(SimplePluginManager.java:216)
            at org.bukkit.craftbukkit.CraftServer.loadPlugin(CraftServer.java:94)
            at org.bukkit.craftbukkit.CraftServer.loadPlugins(CraftServer.java:72)
            at net.minecraft.server.MinecraftServer.e(MinecraftServer.java:215)
            at net.minecraft.server.MinecraftServer.a(MinecraftServer.java:202)
            at net.minecraft.server.MinecraftServer.d(MinecraftServer.java:142)
            at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:257)
            at net.minecraft.server.ThreadServerApplication.run(SourceFile:375)
  6. Offline


    Hey, I love this plugin! Great job and keep it up.
  7. Offline


    Hey Acru, very nice mod, just the thing i was looking for. Using it for about 2 weeks now but there still seems to be a bug with the door protection. If I protect them with a sign, either above or attached to them, people seem still be able to open them. They are also built on solid terrain. You have any idea what could be the matter?
  8. Offline


    Bug: If you protect a door which is sitting on dirt/grass, using a hoe to till the dirt/grass destroys the door :3

    I'm just thinking of unorthodox ways to break your mod so you can fix it again :)
  9. Offline


    The iConomy feature with a fee, is REALLY important for our server, that would be a awesome addition soon!!!!!!
  10. Bug: If somebody almost destroys a door by holding down attack, the door opens. On 617. Only happens on wooden doors.
  11. Offline


    Been poking at code most of today, was on a rather promising track til I hit a bug in craftbukkit... @Grum again, lol.

    I'll get to replying to recent posts in a bit, gonna push a fix to git.

    Edit: I hope this fix gets in soon, then I can do something fancy~!!!
    (You'll see later, I plan to up the version to 1.4 for this... ;3)

    This isn't possible, sorry. I'm adding a permission on whether people can lock things or not at all, though.

    Is GroupManager compatible with build 617 yet? In any case, I'll put this on my to-do list to check. What version are you using btw?

    Thank you, I've been working hard today. :3

    I am aware of the problem with wooden doors and fixed it today, though there is still another day of work to do on the plugin before release.

    There are a number of ways to break a door if it is built on an unstable block. There is a warning in the doors section about this. :3 I'm not sure its possible to stop some things in CraftBukkit, like sand falling out from under the door, but once I deal with some more pressing issues I can come back to this. It might help if you can come up with a nice list, in the mean time? ;3

    In any case, if it comes to it people can break through the wall beside the door, if you don't have any additional cuboid protection or similar.

    I'm not sure if I have time to look into this for the update this weekend, but perhaps you can tell me how you would expect it to work? Would the cost be set in the config file, for instance? Would admins be exempt from the fee? What is a good default cost? What version of iConomy is stable?

    I tried this out and it seems to work on dirt but not on grass?

    Okay, think I sorted out all the security and build related issues.
    Now I can proceed to permissions and adding features tomorrow, after a nice sleep.

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


    Yes, the config file would be essential in changing the cost of sign protection. You could make it so the admin can set up the base or ongoing cost of protection. Players would either have to pay once or a set amount taken each day to keep protection active. this would motivate players to have money in their accounts if they want their belongings protected. You can also have an option in the config file that allows players to set Door Costs. As players enter a protected door, it charges them a set fee that the admin sets. Players only get blocked from entering if they do not have enough money to enter. This is good for people who want to make clubs or art museums etc which need an entry fee. Default cost can be set to like 50 base or 10 per day etc. I would use the latest iConomy 4.6.5 so it will work well with the new builds.

  13. Offline


    Ah lol, I tried it with dirt, assumed the same would happen with grass
  14. Offline


    I withdrew my previous pull request and opened an actually working one, lol;

    Back to Lockette again...

    Hmmm~ This may need to be refined a little.

    For starters, I don't keep track of locked containers/doors, so a per-day option is out. Possible times to charge a fee could be only on create, and on use. (And also on destroy.)

    In regards to the fee for using a door, would you really want all doors to have the same usage fee? Would the fee be paid to the owner by the user, or just be taken from the user? Also, doors currently have no hook to auto-close after use, which would be needed for this.

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


    i changed msg-admin-snoop: ""
    and reloaded it but still sends msg when i open a chest
  16. Offline


    In any case, I slipped in a fix for this exploit, just for you. :3

    In strings.yml? I checked quick and it still works in build 617.

    Check your strings.yml again or else provide more information. :3

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


    Is it possible for me to define how many chests a certain group can protect using permissions?
  18. Offline


    Hey, I run my server on version 612, which I believe is the recommended build, will there be a Lockette for version 612 in the future?
  19. Offline


    There appears to be a bug when protecting doors. If someone breaks a door and the door gets opened while they are breaking it, the door is recreated in its open state, people can then do the same thing to close it.

    I'm not concerned as the furnace and chest system seems rock solid so all of my stuff is still protected, but it's nice to keep people out :p
  20. Offline


    I think that the owner of the door should set the price of that door. Perhaps that is what is written on the sign itself. It should be taken from the player going through the door, and automatically deposited to the doors owner. The message that comes up would also alert the owner that someone has just entered his building. I am not sure if you would need to have the doors metal and add a pressure plate that might activate the event.
  21. Offline


    I encountered this earlier today, switch out your wooden door for an iron door = problem solved
  22. Offline


    Again no. This has been asked many times. :3

    See the main post.
    Build 612 may be recommended but it still has bugs, ones that cannot be worked around.
    Upgrade to build 617 at least.

    I am aware of the problem and putting out a rather large update tonight, that includes a fix for this. Just checking for stuff I missed now.

    Aaaand, here is Lockette 1.3.4.

    This was enough for one weekend, though it didn't seem to come out to much for users...
    Three new permissions and blocked known and unknown door exploits.

    And a lot of internal reworking for future happyness~ o3o

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



    This mod beats all other lock mods in my opinion, great work, good to see that you've fixed those few exploits.

    EDIT: I would really like to see the auto door close put in, out of the future ideas that sounds like it would be one of the best, furnace cluster too, but that's not a major problem, leaving doors open (or lag causing them to appear to close but stay open) is more of a problem.

  24. Offline


    If its such a requested feature why don't you implement limiting the amount of chests per group?
  25. Offline


    I noticed the new permission for users to create locks is "lockette.create.*".
    Is the "*" on there because there are sub-permissions? Such as "lockette.create.chest"
    and/or "lockette.create.door"? Just curious. That's usually why you use a ".*".
  26. Offline


    Ah, thanks. For auto door closing, I had some ideas how to make it more reliable, aside from a hard server crash while the door is open. Though I'm wondering if the time before closing should be global to the server or local to the door. Any thoughts on this?

    The reason for not including any per user or per group limit for locks is that this plugin doesn't use any sort of database to track chests. Without tracking, there is no way of knowing how many locked things exist when making a new one. As for why not adding a database, this plugin is optimized for servers where you may have thousands of chests or more in existence, and a database would slow things down the more locks there are. Without a database, all permission chests run in constant time. Basically, it is a tradeoff. :3

    Well spotted. The answer is no, there are currently no sub-permissions for different block types, but I wanted to have the option to add them later without breaking things so I am using a single hidden sub permission for now. :3
  27. Offline


    I am going to seem like a noob but i can't seem to figure out how to turn off the message when admins snoop in chests. it gets really annoying when people get suspected of cheating or stealing and i have to check chests
  28. Offline


    In config.yml, change "allow-admin-snoop" from "false" to "true.
    In strings.yml, change "msg-admin-snoop" to ''. That is two single quotes, nothing between.
    If you delete the message, that is, no value, it doesn't seem to work. Must be ''.
  29. Offline


    now it works after restart so /lockette reload doesn't work
  30. Offline


    In general, I believe its better to disable snooping in other people's chests, and if it is enabled, not to do it unless necessary~ As clash said though, you can disable the message by setting:
    msg-admin-snoop: ""​
    in strings.yml. (I use double quotes rather than single quotes though. :3)

    Does it say it reloaded when you use the command? (It should say "Reloading plugin configuration files" in the log too, and you need the permission lockette.admin.reload)

    Otherwise, I'll check the reload command again to see if something went wrong. Thanks.

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


    ya it gave me in chat and server.log that it reloaded but didn't change anything only after restarting server
    and np glad to help is awsome mod

Share This Page