[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


    Added an alternate link via dropbox, for now.
  3. Offline


    I can now open my own locked metal doors with a left and right click. Usually metal doors only respond to redstone current. Bug or feature?

    Other mods installed: Essentials, Wormhole Xtreme, WorldEdit, iZone, HeroicDeath.
  4. Offline


    Feature, or rather it is necessary as redstone current activation is anonymous and disabled for protected doors.

    Edit: If it were not disabled, anyone could just add a button to open a protected door. :3
    (I am considering enabling redstone if the door has [Everyone] as a user, in a future version.)
  5. Offline


    w00t! Good stuff Acru
  6. Offline


    Yay, three diamonds~!
  7. Offline


    Using McMyAdmin, plugin is loaded successfully. I'm with servercraft, so forced to use their plugin upload but yes it's uploaded to plugins. No error messages, no response whatsoever ingame or in McMyAdmin panel. CB build 516

  8. Offline


    There was a case I had before with servercraft, where the plugins folder shown was for someone else's server on the servercraft cluster.

    Perhaps this has happened to you? If it does not say 'Lockette enabled!' in the McMyadmin console when starting the server, it is probably so, and you should send them a support ticket to get it fixed.
  9. Offline

    Mike L

    Is there any way to disable door locking and keep the rest of the features? I love this pluggin for the chest locks but I do not want locking doors on my server, Thank you.
  10. Offline


    Would an option in config.yml or a permissions node in Permissions be better?
    (Config would be a global enable/disable, and permission would be per-user.)

    Edit: Actually a config option would be easy so I'll add one now.
    Edit 2: Done. All good?
  11. Offline


    I personally use GroupManager (1.0a5)
  12. Offline

    Mike L

    Exactly what I was looking for! Thanks so much!
  13. Offline


    I see. I'm planning on supporting that one natively, perhaps, but does it work okay at the moment via the FakePermissions.jar?

    Ah, yer welcome :3
  14. Offline


    No issues to report. All is fine.
    I'd prefer more control as to who can protect an item, but that is not terribly important.
    So that people outside of the "members" group wouldn't be able to protect a chest/door without appropriate permissions. Just wishing aloud.

    Thank you for such a wonderful plugin.
  15. Offline


    This is planned in addition to possibly an admin permission for making protected things for other users, as some servers would find these useful together. It is not a high priority though, so probably next week.
  16. Offline


    Any way to make locked doors automatically close after a certain amount of time? So if someone forgets to close a door, it won't leave the room unprotected?
    mooztik likes this.
  17. Offline


    Nah, they're my plugins, i edit quite regularly. And as I said, it *does* say it's loaded. Ahh well. I was looking for an alternative to LWC since that doesn't work on my server either. Guess my users will just have to hide their chests.
  18. Offline


    I think i found out the problem. It seems that door locking works fine in my normal world but in any other worlds it lets u open the door with left click
  19. Offline


    I was considering this, but there is the issue that the plugin doesn't know which way the door opens, specifically, it just toggles the state. And if the server were to be restarted etc while a door was opened, it would forget to close it, too. Something to consider further anyway.

    Perhaps the simplest way would be for me to come connect to your server a bit and see? Leave the plugin installed, and you can send me info privately, if interested. I would like to find out what the issue is exactly.

    Seems to work fine with the mod Nether anyway, with CB 556 and 531, though you said you were using MultiVerse? The build version does matter too, you said you were using 531 but a redstone fix wasn't in til 537, and the ghosting bug before 552.

    Problems when changing worlds might be related to the ghosting bug though. Try updating and see if the problem persists?
  20. Offline


    Im using 556 and it doesnt work in a different world.
  21. Offline


    yea i have one bug with this plugin i read that redstone hacking the doors is disabled but ppl can still open the doors with redstone or buttons
  22. Offline


    Thanks anyway, I'm going to go with Essentials protection for now. Best of luck! Hopefully I'm able to use this in the future.
  23. Offline


    I'll try Multiverse and see if I can reproduce.

    You must be using a CB build older than 537? If so please upgrade.
  24. Offline


    Im having a problem, I added the permissions lines to let me (the admin) look into and break people private chests, however it wont let me. :/ Any ideas?

    group: Admins
    - 'general.give'
    - 'general.give.infinite'
    - 'lockette.admin.break'
    - 'lockette.admin.snoop'
  25. Offline


    a good idea. adding as a config option in the yml file, or directly writing on the signpost with an [autoclose:5] (closing after 5 seconds)

    another idea. a bit complex (i think).
    a log history. like [log] . to know who has used/opened selected elements.

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


    You need to set allow-admin-snoop to true in the config, as well. I put that in as snoop is spammy, and shouldn't usually be used.

    Although this could be done, it couldn't be done with 100% reliably. If the server is saved when the doors are open, and the server crashes/etc before the next save, the door would be left open until clicked again. There would need to be some sort of state information on a sign as well, so the door doesn't get confused and opens after 5 secs instead.

    I'll think more on it, but for now this won't be supported, instead relying on people closing their doors if they want an area secured.

    If I understand what you mean this is certainly possible, listing the last three non-owner users of the container, without duplicate entries. I don't know how useful compared to the time it would take to implement, however.

    Any other votes for this?
  27. Unfortunately, this plugin breaks above bukkit #560 - any chance of an update please ?

    22:03:03 [SEVERE] BLOCK_PLACED loading Lockette v1.3.1 (Is it up to date?)
    java.lang.NoSuchFieldError: BLOCK_PLACED
    at org.yi.acru.bukkit.Lockette.Lockette.onEnable(Lockette.java:137)
    at org.bukkit.plugin.java.JavaPlugin.setEnabled(JavaPlugin.java:118)
  28. Offline


    Oh dear, and I was about to release an update too. Let me see what they changed... :<

    Okay, all done! Kinda hacky but it all seems to work. Let me know if you run into issues?

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


    Great plugin Acru! All my players love this system in our survival world!
    One gave me a suggestion, and while I'm not sure if it would work but do you think you could add iConomy so that every time they lock a chest with a single sign that it costs them X amount of coin? Maybe even a limit of how many can be locked per user?
    Hopefully thats possible, but love the plugin :D
  30. Offline


    03:47:25 [SEVERE] Could not pass event PLAYER_COMMAND_PREPROCESS to Lockette
    while scanning for the next token
    found character @'@' that cannot start any token
     in "<reader>", line 9, column 20:msg-admin-release: @@@ has broken open a container  ...
            at org.yaml.snakeyaml.scanner.ScannerImpl.fetchMoreTokens(ScannerImpl.ja
            at org.yaml.snakeyaml.scanner.ScannerImpl.checkToken(ScannerImpl.java:18
            at org.yaml.snakeyaml.parser.ParserImpl$ParseBlockMappingValue.produce(P
            at org.yaml.snakeyaml.parser.ParserImpl.peekEvent(ParserImpl.java:163)
            at org.yaml.snakeyaml.parser.ParserImpl.checkEvent(ParserImpl.java:148)
            at org.yaml.snakeyaml.composer.Composer.composeNode(Composer.java:132)
            at org.yaml.snakeyaml.composer.Composer.composeMappingNode(Composer.java
            at org.yaml.snakeyaml.composer.Composer.composeNode(Composer.java:160)
            at org.yaml.snakeyaml.composer.Composer.composeDocument(Composer.java:12
            at org.yaml.snakeyaml.composer.Composer.getSingleNode(Composer.java:105)
            at org.yaml.snakeyaml.constructor.BaseConstructor.getSingleData(BaseCons
            at org.yaml.snakeyaml.Yaml.load(Yaml.java:264)
            at org.bukkit.util.config.Configuration.load(Configuration.java:73)
            at org.yi.acru.bukkit.Lockette.Lockette.loadProperties(Lockette.java:322)
    at org.yi.acru.bukkit.Lockette.LockettePlayerListener.onPlayerCommand(LockettePlayerListener.java:95)
            at org.yi.acru.bukkit.Lockette.LockettePlayerListener.onPlayerCommandPreprocess(LockettePlayerListener.java:38)
            at org.bukkit.plugin.java.JavaPluginLoader$5.execute(JavaPluginLoader.java:182)
            at org.bukkit.plugin.RegisteredListener.callEvent(RegisteredListener.java:59)
            at org.bukkit.plugin.SimplePluginManager.callEvent(SimplePluginManager.java:255)
            at net.minecraft.server.NetServerHandler.c(NetServerHandler.java:637)
            at net.minecraft.server.NetServerHandler.chat(NetServerHandler.java:608)
            at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:602)
            at net.minecraft.server.Packet3Chat.a(SourceFile:24)
            at net.minecraft.server.NetworkManager.a(SourceFile:230)
            at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:76)
            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)
    I know this error explains itself, but why can I not start my message with @? I dislike the "(Admin)" thing at the beginning. Kind of an OCD thing I guess lol.

    Also, whenever I remove a message for snooping/breaking protection it always puts the message back. This is rather annoying seeing as we have a vault of sorts and us admins routinely check the chests for any suspicious or illegal items. It's pretty much a nice spam fest for about 5 minutes >_>
    So could you please add an option to disable the admin snooping/breaking messages?

    Great mod though, I totally prefer it to LWC/others
  31. Offline


    Thanks for the feedback~ :3

    I've never used iConomy so I don't know much about it. A per-user limit for locked things is not possible, as the plugin does not keep track of them, but a fee might be easy to add, depending on how easy iConomy is to use.

    Do you think there would be much interest in such a feature? I'll put it on the list anyway.

Share This Page