[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


    That is true, for decompiling, plus you loose out on all my nice comments. :3

    The only issue is that it is going to be a bit tricky to merge, as it is not a direct fork of my original source.

    I am upset with myself mostly, for putting the project aside and ignoring it for too long~ ^.^;

    Hee, for now, yeah~
  3. Offline


    Well its good to have you back.
  4. Offline


    An admin will mark the thread active again, once I see to the outstanding issues and verify compatibility with the most recent recommended build.
  5. Offline


    sounds good
    really love your plugin also i know this isnt really the right person to talk to but is permissions going inactive
  6. Offline


    Hum, I thought you were going to work with me on a merge though?

    Thank you for this, by the way.

    The time I put into making the plugin, I did so with no expectation of any remuneration, but it is nice to be appreciated in this way. :3

    Though, I did feel a pang of guilt at the time, what with not being around to update.

    I'm afraid that a fork has been made, and @daemitus wishes to continue updating his fork, Deadbolt.

    I had another talk with him just now, requesting that he give proper credit to myself and my work, and he agreed so I will not be taking issue with this.

    What this means for Lockette I am not yet sure, but I wish to find someone else willing to help maintain the long run, preferably someone from the Bukkit team.

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


    I know it has been forked (I am part of the project), I just put that there to appease southpaw and other devs. If you have been given recognition then I guess I need proper credit for my efforts as well :)

    I was going to help start up Lockette again, but you were seen as MIA and Daemitus gave me the oppurtunity to work with him instead. A partnership I don't mind at all :)
  8. Offline


    What, my snarky comments arent enough for you? :(
  9. Offline


    Where will the documentation/links/api/etc be? :) Looking forward to adding my sign chest shop to support this or made compatible else i'd have to use my default protection :x
  10. Offline


    K thx for ur support!
  11. Offline


    Please keep Deadbolt posts to the Deadbolt thread!
    Well theres a bit of javadoc floating around but for now your entire api is pretty much included in com.daemitus.deadbolt.util

    It contains mostly the same as Lockette. I guess the bits your looking for are isProtected() and getOwner() or whatever they are called (cant be bothered checking) they are what Lockette included and are mapped to the relevant Deadbolt functions via LocketteSim.jar

  12. Lockette = better in my opinion, but someone needs to update it :(
    Deadbolt looks pretty good :)
  13. Offline


    The first update in a while is scheduled to be released later today.
  14. Offline


    I was troubleshooting an issue with another server op earlier. Get the dev build of the group manager and see if you can make sense of the exception plugincore is firing.
  15. Offline


    Do you have a listing of the actual exception? PluginCore's main purpose is for communicating with other plugins, like Groupmanager, so there might be a change in the api, or something in GM crashing on a permission check?
  16. Offline


    22:26:24 [SEVERE] Could not pass event SIGN_CHANGE to Lockette java.lang.IncompatibleClassChangeError:
    Expecting non-static method  org.anjocaido.groupmanager.GroupManager.getWorldsHolder()Lorg/anjocaido/groupmanager/dataholder/worlds/WorldsHolder;
    at  org.yi.acru.bukkit.PluginCore.hasPermission(PluginCore.java:266)
    at  org.yi.acru.bukkit.Lockette.LocketteBlockListener.onSignChange(LocketteBlockListener.java:812)
    at  org.bukkit.plugin.java.JavaPluginLoader$33.execute(JavaPluginLoader.java:469)
    at  org.bukkit.plugin.RegisteredListener.callEvent(RegisteredListener.java:58)
    at  org.bukkit.plugin.SimplePluginManager.callEvent(SimplePluginManager.java:338)
     at  net.minecraft.server.NetServerHandler.a(NetServerHandler.java:994)
     at net.minecraft.server.Packet130UpdateSign.a(SourceFile:41)
    at  net.minecraft.server.NetworkManager.b(NetworkManager.java:226)
     at  net.minecraft.server.NetServerHandler.a(NetServerHandler.java:89)
      at  org.getspout.spout.SpoutNetServerHandler.a(SpoutNetServerHandler.java:478)
    at net.minecraft.server.NetworkListenThread.a(SourceFile:105)
    at  net.minecraft.server.MinecraftServer.h(MinecraftServer.java:454)
    at  net.minecraft.server.MinecraftServer.run(MinecraftServer.java:363)
    at  net.minecraft.server.ThreadServerApplication.run(SourceFile:422)
    It was a dev build during a transition to supporting super perms, I wouldnt go overboard hunting it down.

    -edit. reading a little closer, it looks like an issue with group manager moreso than lockette.
  17. Looking forward to that update Acru, thanks alot for coming back :)
    Much appreciated :D
    mason1370 likes this.
  18. Offline


    Could you point me to the file that caused this? I want to check what else is different, and I can't find it.
  19. Offline


    hey is there an sort of way to set it up so that you can only use lockette on world 1 but then only admins can use it on world 2?
    we have a survival world on world 1 but we want a PVP on world 2 (which is not very good with locked chests)
  20. Offline


    Yes, using multi-world permissions.
    Only give the lockette.user.create.* permission in the world 1 permissions file.
  21. Offline


  22. Offline


  23. Offline


    I just grabbed the file and I'm having a look at it now.

    Edit: I seem to have solved it, compatible with versions before and after the change.

    The offending change in the API:

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


    do u need anyone to test it out??
  25. Offline


    Hello, this plugin used to be the best of chest protection plugins, everyone knows how to use it unlike lwc.
    Please update to bukkit 1060!!
    When do you think you will get the update done?
  26. Offline


    How do I make it where it doesn't announce to everyone when I break someones sign?
  27. Offline


    Sorry, it should have been done by now, but I keep thinking of neat things to add! I'm currently considering how efficient it would be to tie trapdoors together, like I currently do for double doors, but something like 8+ trapdoors at once. Perhaps I'll leave it for later though.

    In the configuration file, set the message to something other than [Everyone].
  28. Offline


    Give me an example of what my Config file should look like please?
  29. Offline


    It should be strait forward, if you look, heh.

    In plugins/Lockette/config.yml;
    broadcast-break-target: '[Everyone]'
    Is the config for who to send an administrative protection break message.

    Change, [Everyone] to a different group like [Operators] or a specific user name, or [Noone].

    And to anyone who reads this, I was testing security with sticky pistons and trap doors, and found one can pull the other by default... lol

    Of course, I'll block this too in the update, for protected trapdoors. :3

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


    Sounds good. I'm actually chanting at the bit for this update. Been checking every day since the 'final big update' was promised way back when. Really hoping it'll include support for PermissionsBukkit, I'm eager to ditch Permissions 3 and this is the last plugin we use that doesn't support it even with the Superperm Bridge.

Share This Page