[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


    Is there a 1.7.3 version of this mod that I can use? as 1.8 doesn't work on my computer.
  3. Offline


    I've added lockette.* to Mods but they still cant access other peoples chests. Im using PermissionsEx.
    I know it says "Also, PermissionsEx 1.15.1 (dev) has an issue with actually giving permissions."
    But my friend uses ex and he has no problem with it :/
  4. Offline


    Dear Acru,

    I absolutely love your Lockette plugin, and I have been using it for my Bukkit 1337 server for the past month or so. I have a major issue though. My copy of Lockette 1.4.4 doesn't seem to recognize my PermissionsBukkit 1.2, a SuperPerms-based permissions plugin, which should be compatible. Right?

    In Lockette's config file, I do have "enable-permissions", "allow-admin-bypass", and "allow-admin-break" values set to true. I also have the proper nodes set in my permissions config file. Unfortunately, the Lockette plugin does not allow me (admin) to peek into others' chests. After opping my character, the snoop feature works. It would appear that Lockette only follows the basic op/non-op system, which is not desired. I have a designated group of players I do not want creating locked containers or doors.

    Do you have any feedback for me? Thanks in advance!
  5. Offline


    I also haven't been able to get the permissions for admin bypassing (snoop and door bypass) on either PermissionsBukkit or PermissionsEx.

    I'm using version 1.4.4 on bukkit 1337.
    McJellyGooby likes this.
  6. Offline


    Hey are you planning an update for Bukkit 1337 or any later CraftBukkit version than 1317? It would be great to know if you are going to continue developing the plugin! I love it btw!
  7. Offline


    need some help I keep getting this error

    20:27:53 [SEVERE] Could not pass event BLOCK_PLACE to Lockette
    java.lang.NoClassDefFoundError: com/palmergames/bukkit/towny/Towny
    at org.yi.acru.bukkit.PluginCoreLink.getTowny(PluginCoreLink.java:47)
    at org.yi.acru.bukkit.PluginCore.canBuild(PluginCore.java:399)
    at org.yi.acru.bukkit.Lockette.LocketteBlockListener.onBlockPlace(Locket
    at org.bukkit.plugin.java.JavaPluginLoader$32.execute(JavaPluginLoader.j
    at org.bukkit.plugin.RegisteredListener.callEvent(RegisteredListener.jav
    at org.bukkit.plugin.SimplePluginManager.callEvent(SimplePluginManager.j
    at org.bukkit.craftbukkit.event.CraftEventFactory.callBlockPlaceEvent(Cr
    at org.bukkit.craftbukkit.event.CraftEventFactory.callBlockPlaceEvent(Cr
    at net.minecraft.server.ItemSign.a(ItemSign.java:60)
    at net.minecraft.server.ItemStack.placeItem(ItemStack.java:62)
    at net.minecraft.server.ItemInWorldManager.interact(ItemInWorldManager.j
    at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:592)
    at net.minecraft.server.Packet15Place.a(SourceFile:57)
    at net.minecraft.server.NetworkManager.b(NetworkManager.java:226)
    at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:92)
    at net.minecraft.server.NetworkListenThread.a(SourceFile:108)
    at net.minecraft.server.MinecraftServer.h(MinecraftServer.java:471)
    at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:374)
    at net.minecraft.server.ThreadServerApplication.run(SourceFile:417)

    any help on this would be great
  8. Offline


    @McJellyGooby @ClearTranquil you do not need to be op'd for the admin features to work. I'm running PermissionsBukkit and here's how my permissions are setup:
                lockette.admin.break: true
                lockette.admin.bypass: true
                superpermbridge.lockette.admin.create.*: true
                lockette.admin.snoop: true
    the superpermbridge node is because SuperPerms doesn't recognize the .* . You could specify each item type and avoid using SuperPermBridge
  9. Offline


    Hmmm... I really like this plugin more than LWC, but i would like to limit chests, and you said you were not going to do that.... I like lokette much more that LWC.
  10. Offline


    Hey, I'm having an issue with /lockette fix command, it keeps saying no owned door found. Even though I'm looking straight at it, I've tried both doors and the sign above them. All say 'No owned door found'.

    The sign is set to [Everybody]. Any ideas?
  11. Offline


    i have a little bug:

    If I have double chest, with the 2 signs, one with the [private] and one with the [more users], if I select the [more users] one and try to /lockette 2 player, it will change the [private] sign, and not the [more users] sign.

    using 1.4.8 version.

    Here are the pics

    Editing the second one:

    And it edits the first one:

  12. Offline


    @Greylocke, I'll give that series of superpermbridge nodes a shot and see if it improves. I know that I don't need to be OP for admin.bypass and snoop, but until the nodes are correct, OP is my only choice to have these functions. I'll let you know how it works!
  13. Offline


    Does this plugin work with the current 1.0 dev build?
  14. Offline


    Is this version compatible with Minecraft 1.0.0 (new release) and CraftBukkit > 1464 (for Minecraft 1.0.0) ??
    (So can I ugrade my server to CraftBukkit 1464 without any problem with this plugin ?)
  15. Offline


  16. Offline


    @Cartman34 Yes! Try it and let me know. ;) I'm not going to risk it yet. :)
  17. It's working fine for me, 1.0 dev build and bperms.
    Cartman34 likes this.
  18. Offline


  19. Offline


    @Acru I think iConomy support would be the same as having a limit, but better. If you added that as an option, it would help out econ servers a lot :)
  20. Offline


    i tested it on #1487
    i can place a sign on chest but i cant edit the sign to add more players. some walk-around or hint?

  21. Offline


    After I download it then what do I do? I'm sorry. But I'm not sure what to do...
  22. Offline


    If you're trying to install Lockette on your server, then just drop it in the plugins folder. The next time your server is started, Lockette will create a config file for you in the /plugins/Lockette folder. Edit the config settings if you need to.

    To use it, either make yourself Op or setup permissions. The permissions nodes are at the top of this forum.

    Pretty simple!
  23. Offline


    Just a heads up on Lockette behaviour using recent CB builds for MC1.0.0:
    Lockette Door behaviour is messed up for me using dev build CB#1493 (misaligned double doors, split doors). It was working OK in dev CB#1488. No errors seen in the console, and I tried with and without PermissionsEx 1.16 and got the same result. Maybe not your problem, I just figured you might want to know. :D
  24. Offline


    Posted on DevBukkit as well, but any chance you can make this work for brewing stands too?
  25. Offline


    To make this worse @Inscrutable @Acru seems to gone MIA for a few days :(
  26. Offline


    Are you going to make a version for 1.0.0?
  27. Offline


    Yeah he will if he comes back he is just been MIA since Monday maybe holidays or something. Not sure if someone be willing temp fix it!
  28. Offline


    wow, relax peoples. There isn't even an RB for 1.0 yet.
  29. Offline


    True, there can be a lot of new stuff that can be add.

    I was thinking the developer can add not a database but a LOG of created or destroyed signs ^^, that way would be easier to know HOW much signs exists at the world and WHO owns em
  30. I disagree. That kind of functionality is part of the various logging plugins already available.

    One of the things I like about lockette is the lack of extra functions such as the suggestion above. Keeping it lean and fast is the best approach in my opinion.
  31. Offline


    I like Lockette because you actually need a Sign for it and all people can see that sign with the owner there, if you see LWC is command dependant so it makes delays about checking a chest :/

    Yes, is nice is SO simple, but still like ChestShop is that simple it haves a logging system.

    Anyway, is this pluggin OpenSource? so I can check and edit it for my server at the way I would like it, seeing that most people here doesn't like special additions to the simple lockette system :p

Share This Page