[SEC] Lockette - Simple chest and door lock, no databases! [Moved to BukkitDev]

Discussion in 'Inactive/Unsupported Plugins' started by Acru, Feb 14, 2011.

  1. Offline


    Lockette - The sign-based container and door lock for Bukkit! - by Acru Jovian

    ElgarL has been assigned as the current maintainer of this project, please forward any important issues to him as well. This post is abandoned, but proceed to BukkitDev for updates.

    Download it at BukkitDev! (Alternate) (JAR) (Source), also view the Change Log on BukkitDev.

    Supported external plugins:
    • Permissions - Permissions/Groups
    • GroupManager - Permissions/Groups
    • PermissionsBukkit - SuperPerms/Groups
    • PermissionsEx - SuperPerms/Groups
    • bPermissions- SuperPerms/Groups
    • Towny - Groups/Zones
    • SimpleClans - Groups
    • mcMMO - Groups (Disabled by default now, due to issues.)
    • Factions - Groups
    • LWC - Zones
    • Register - Economy
    Alternate languages included:
    Confirmed compatible plugins: ColorSign, SpeedSign.
    Conflicting plugins: ChestShop, Most sign editors!

    The active Lockette information page will commute to BukkitDev soon, but the forum thread is still the best place for discussion.


    The purpose of this plugin is to restrict access to the contents of chests, dispensers, furnaces, and doors without the use of a database to track containers.

    To use, simply place a signpost on the floor directly beside a chest or other container to be locked. Enter [Private] as the first line. Your own name will automatically be entered on line 2 as the chest owner. Optionally type in the full names of two other users allowed to access the chest's inventory on lines 3 and 4.

    When done correctly, the sign will automatically fix itself to the side the target chest, protecting it from unauthorized access! Only the chest's owner can then break the sign or chest. (Warning: Anyone with permission to use WorldEdit commands or similar can circumvent the protection by removing the sign.)


    Additionally, you can enter [Everyone] on lines 3 or 4 instead of a user name to allow everyone access to the contents of a private container, or [Operators] to allow ops access. If a Permissions plugin is available, you can use groups like [Moderator] or [Admins] or others as defined in the Permissions settings files.

    The owner of a container can add more users by placing additional signs beside the container with the heading [More Users], where lines 2-4 specify the names of the additional users. You can edit the users on previously placed signs by right clicking the sign, and using the command '/lockette <line number> <text>' to change it.

    Working with Doors:

    To protect a door, you can use the same method as protecting a container, the sign will attach to the door automatically. In addition, you can attach a [Private] wall sign to any side of the blocks just above or just below a door. For double doors only one side needs a sign. Door support is enabled by default in the config file.

    Once a door is protected it will only open for someone listed as a user, and will not respond to redstone power or switches unless [Everyone] is listed as a user. Iron doors which usually won't open from clicking will work just as wooden doors. In addition, double doors will open together automatically!

    You can also use [More Users] signs as with containers, with the caveat that the sign cannot be placed on the block above the door if the [Private] sign is not above the door as well! (This is done to prevent a security uncertainty issue.)

    Protected doors will be closed automatically if a timer is set. A timer can be set globally with a configuration option, or individually for each door by using the tag [Timer: #] on line 3 or 4 of the [Private] sign, where # is the number of seconds that the door should remain open. If the timer is set to 0, this means the door will never automatically close. If no timer is specified, protected doors will use a global timer set in the configuration file. If the server is shut down cleanly any open doors will be closed, but in the event of a server crash while a door is open, it may remain so. Note that the initial state of a door is assumed to be closed.

    Care must me taken to place protected doors on a stable block. Building a door on sand, gravel, leaves, TNT and et cetera are allowed by the plugin, but cannot be secured fully. :3 Additionally, it should be noted that most status messages still refer to locked blocks as containers, so for the purpose of simplicity, doors should be considered as a type of container.

    • No passwords or databases needed!
    • Permission checks run in constant time, no matter how many protected containers.
      • One owner and up to 11 additional users supported. (17 for double chests!)
      • Allows access to [Everyone] while still protecting the container from vandalism.
      • Allows group names in conjunction with many other plugins.
    • Special powers for ops or admins, configurable with permissions.
      • Reports when an admin does something naughty.
    • Protects single and double chests, dispensers, and furnaces.
      • Explosion and block-break protection for the protected container and sign.
        • Option to protect all containers from explosions.
    • Full support for doors, both wooden and iron!
      • Double doors are handled automatically, with no redstone.
      • Doors can be set to close automatically, via a timer setting.
      • Redstone hacking is disabled for protected doors.
    • Prevents creation of chests larger than 2 blocks.
    • Informative or helpful messages when interacting with containers.
      • The first time a chest is placed, a help message will be shown.
      • Types of messages shown are configurable in settings.
      • Additional language support.

    Advanced Setup (Permissions) (open)

    Advanced Setup:
    There are a few things you can now customize in the configuration files for the plugin, found in the plugins/Lockette folder. After running the plugin for the first time, two files will be created, config.yml and strings.yml. The first holds the following settings:
    • enable-permissions - Allows the use of permission nodes to specify who can do what. If this is disabled, groups will still be used but admin status is taken from the ops file. Defaults to false.
    • enable-messages-* - Enables or disables groups of messages listed in the strings.yml file. Not counting the broadcast ones.
    • broadcast-*-target - Sets the group or player that specific broadcast messages should be sent to. This can be set to "" for no one.
    • explosion-protection-all - Enabling this extends explosion protection to all containers on the server, not just [Private] ones. Default is disabled.
    • allow-admin-bypass - Allows admins to go though any protected door. Default is true.
    • allow-admin-snoop - Allows admins to peek into chests owned by other people. Default is false, and this setting is recommended! A broadcast message will be sent each time an admin snoops in a protected container where the admin doesn't have permission to. The message will be sent to a player or group as specified in another option. Admins can still break protection on chests if this is disabled, however.
    • enable-protection-doors - Enables support for private doors, defaults to true.
    • default-door-timer - Sets the door closing timer for all protected doors on the server, unless overridden by a specific sign. Defaults to 0, which disables the door closing timer.
    In the strings.yml file, you can set alternate language tags for [Private] and such, in ANSI format. If you need characters not in ANSI then you might try UTF-8 format, though it seems bugged tight now. The default alternate tags are in French, but server ops are free to translate the whole file into the language of their choice. If you do this, please share it back to me~ :3 If you want to disable only a specific message, you can set it to "", the empty string. Admins can use the command '/lockette reload' after editing the configuration files, to reload them.

    If a Permissions plugin is not available or the enable-permissions option is set to false, Lockette will use the ops file to determine who are admins. Admins can break the protection on any chest, and look inside protected chests (only if the related option is set), as well as reload the plugins configuration files. All non-ops will be able to create protected containers for themselves.

    If a Permissions plugin is available and the enable-permissions option is set to true, the following nodes will be used instead of the ops file and are included by default in the '*' node:
    • lockette.user.create.* - Permission required to create a protected container or door. Possible sub-nodes include chest, dispenser, furnace, and door. (The permission lockette.create.all is still supported, but obsolete.)
    • lockette.admin.create.* - Allows admins to create containers and doors for other users. Possible sub-nodes include chest, dispenser, furnace, and door. Leave line 2 blank for the default behavior or enter the name of your choice. Capitalization matters.
    • lockette.admin.break - Allows breaking protection on containers.
    • lockette.admin.bypass - Allows opening of any locked door.
    • lockette.admin.snoop - Allows peeking in protected containers. (The setting allow-admin-snoop must be true.)
    • lockette.admin.reload - Allows use of the reload command.

    Technical Information (open)

    Technical Information:

    This plugin has been tested and shown to be working for many builds of CraftBucket though a number of the more recent builds had a serious issue, so I'm suggesting a minimum build of 561 now. If you update past what is listed in the post's title and the plugin seems to break, it is probably not my fault. Post a note anyway and I'll see about fixing. I'll try and keep up with the new recommended build system, but for latest builds that break things, you should expect some time to pass before I take care of the issue, as this plugin is now mature. :3

    If there are multiple containers by the placed sign, the plugin will use the NESW rule to choose the first container that is not yet private. To elaborate, the plugin will check to the north of the sign first, and if no container or door is available to the north, it will continue checking clockwise around the sign.

    Due to the current implementation of the explosion event, this plugin will cancel all explosions that would damage the container or sign, rather than just remove the container and sign from the blocks to be damaged. Canceled explosions still knock signs off the walls. Canceled explosions leave signs looking blank, but this is just a graphic glitch, reconnect to fix.

    Bonus: This plugin will prevent chests bigger than 2 blocks from being created via glitches. (Again, this could be circumvented using WorldEdit commands, so take care who has access to such a plugin.)

    This plugin was inspired by the old hmod plugins Lock by Roman "kingseta" Pramberger and ChestCapsule by Fernando "Fergo".

    Hooking into Lockette (open)

    Hooking into Lockette:

    If you are a plugin author and want to connect to Lockette, you can use a public static function to get information about the protected status of a block.

    More info later, perhaps, but if you need the details now then go poke through the source~

    Future Possibilities:

    There are a number of things that have been suggested, and they tend to be added to the list below if I think they might be a good idea. However, some sort of locked container limit is requested often but this is not possible without a database to track the number of locked containers someone has. All things considered, this will not be supported. On the up side, without a database you can have literally millions of locked containers without any sort of lag, and there are permissions to restrict who can create locked chests. Perhaps only allow Moderators to create locked chests for other users, if you don't want to allow infinite locked chests.

    Aside what has already been implemented, the following may or may not appear in future versions:
    • Furnace/dispenser clusters, protected by a single sign.
    • [Log] sign to list recent users of a container or door.
    • iConomy fee for protecting containers/doors.
    • Worldguard connection.
    • [Protected] tag for viewing only.
    • Specific time range that doors can be opened.
    • DataLog plugin support.
    • More types of protected blocks, such as brewing stands.
    If you want any of the above features sooner than never, let me know! However, I currently see Lockette as functionally complete, for the most part, in that it already has all the functionality it needs. Future updates will mostly be to account for changes in Minecraft and Bukkit.

    Final Note:

    Please leave a reply if there are any bugs or suggestions, and if you like this plugin you can click the like button at the bottom of this post~ Thanks to those few that have donated! [​IMG]
  2. Offline


    This plugin work with bukkit 740 ?
  3. Offline


  4. Offline


    Yes, it works on 740 just fine.
    SirMustachio likes this.
  5. Offline


    Getting the same issue. Thankfully my players don't know about it just yet.
  6. Offline


    Why the authors of this plugins don't change this plugin to bukkit 740 ?
  7. Offline


    I had this plugin for awile now but suddenly it stopped working. I recently got essentails and worldedit + worldgaurd is it causing these problems?
  8. Offline


    2011-04-30 14:44:01 [SEVERE] Could not pass event SIGN_CHANGE to Lockette
    java.lang.ClassCastException: org.bukkit.craftbukkit.block.CraftBlockState cannot be cast to org.bukkit.block.Sign
        at org.yi.acru.bukkit.Lockette.LocketteBlockListener.onSignChange(LocketteBlockListener.java:1014)
        at org.bukkit.plugin.java.JavaPluginLoader$29.execute(JavaPluginLoader.java:376)
        at org.bukkit.plugin.RegisteredListener.callEvent(RegisteredListener.java:59)
        at org.bukkit.plugin.SimplePluginManager.callEvent(SimplePluginManager.java:257)
        at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:898)
        at net.minecraft.server.Packet130UpdateSign.a(SourceFile:41)
        at net.minecraft.server.NetworkManager.a(NetworkManager.java:195)
        at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:74)
        at net.minecraft.server.NetworkListenThread.a(SourceFile:100)
        at net.minecraft.server.MinecraftServer.h(MinecraftServer.java:370)
        at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:285)
        at net.minecraft.server.ThreadServerApplication.run(SourceFile:394)
    seeing a couple of these in my log, no idea what is causing it though
  9. Offline


    Can you fix Update 740 ?
  10. Offline


    Hi, there is an issue on load.
    CB 740, Permissions 2.7.2

    2011-05-01 00:19:14 [INFO] Lockette version 1.3.7 is being enabled!  Yay!  (Core version 1.0)
    2011-05-01 00:19:14 [INFO] Lockette: Detected craftbukkit build [740] ok.
    2011-05-01 00:19:14 [SEVERE] while scanning for the next token; found character @'@' that cannot start any token loading Lockette v1.3.7 (Is it up to date?)
    while scanning for the next token
    found character @'@' that cannot start any token
     in "<reader>", line 20, column 18:
        msg-admin-snoop: @@@ has snooped around in a cont ...
        at org.yaml.snakeyaml.scanner.ScannerImpl.fetchMoreTokens(ScannerImpl.java:360)
        at org.yaml.snakeyaml.scanner.ScannerImpl.checkToken(ScannerImpl.java:183)
        at org.yaml.snakeyaml.parser.ParserImpl$ParseBlockMappingValue.produce(ParserImpl.java:592)
        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:230)
        at org.yaml.snakeyaml.composer.Composer.composeNode(Composer.java:160)
        at org.yaml.snakeyaml.composer.Composer.composeDocument(Composer.java:122)
        at org.yaml.snakeyaml.composer.Composer.getSingleNode(Composer.java:105)
        at org.yaml.snakeyaml.constructor.BaseConstructor.getSingleData(BaseConstructor.java:124)
        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:346)
        at org.yi.acru.bukkit.Lockette.Lockette.onEnable(Lockette.java:108)
        at org.bukkit.plugin.java.JavaPlugin.setEnabled(JavaPlugin.java:127)
        at org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(JavaPluginLoader.java:632)
        at org.bukkit.plugin.SimplePluginManager.enablePlugin(SimplePluginManager.java:218)
        at org.bukkit.craftbukkit.CraftServer.loadPlugin(CraftServer.java:116)
        at org.bukkit.craftbukkit.CraftServer.loadPlugins(CraftServer.java:94)
        at net.minecraft.server.MinecraftServer.e(MinecraftServer.java:217)
        at net.minecraft.server.MinecraftServer.a(MinecraftServer.java:204)
        at net.minecraft.server.MinecraftServer.init(MinecraftServer.java:144)
        at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:259)
        at net.minecraft.server.ThreadServerApplication.run(SourceFile:394)
    I went to the strings.yml file and deleted the @@@ on the msg-admin-snoop line and the plugin worked. The @@@ did NOT have to be deleted from the msg-admin-release line. Very odd.
  11. Offline


  12. Offline


    My server users aren't currently able to lock their chests.

    • OP's can lock chests
    • players used to be able to lock chests before latest release of Lockette
    • I am pretty darn sure I have permissions set up correctly, and it worked before
    • chests that players locked before the update are still locked and work fine
    anyone else having this problem? any guesses on how I can fix this? or is this a bug with Lockette?

    Any known conflict with the commandsign mod?

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


    @Acru is it possible to make it so you can limit the amount of chests per permissions group, so one group can lock X amount of chests, and someone in another group and lock Y amount of chests?
  14. Offline


    News idea : Why not to color the sign ? Red if the sign isn't correct. Blue when it is correct. Like Essentials.

    Thanks in advance.
  15. Offline


    I have to second what ipodnerd said also on my server normal Default users with Permissions are not allowed to create Private signs and says that you do not have the correct permissions although they have been set in the Permissions config file.

    Would like to see this fixed as I love lockette for its ease of use and simplicity!
  16. Offline


    Ah, thank you :3

    Portal stick would have to support lockette protection, as I can't stop what other plugins do.

    As it says in the main post, this is not possible without a database to track them.
    There are permissions to restrict who can create locked chests, however.

    As elemental said, you drop the Lockette.jar in the plugins folder and restart the server.

    It will work with no setup, if you are having trouble make sure you have version 1.3.7 and delete the Lockette folder inside the plugins folder, while the server is not running.

    You can optionally edit the config later.

    This is actually intentional, Lockette prevents placing a sign on a protection sign.
    The sign editing plugin in question, if allowed to do this, would circumvent Lockette's protection.
    As for side effects, I have not tested this personally. Issues aside from not being able to edit the Lockette sign?

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


    Oh, right. That actually makes perfect sense, now I think about it. The player who reported it didn't go into too much detail, and I only saw the 'not editing with a right click' stuff, so I wouldn't worry about it. I've told my players to submit proper issue reports if they come across any problems like that in future.
  18. Offline


    I'll take your word on this for now. :3

    It sounds like a protection conflict to me, can you tell worldguard not to protect doors?
    Does this occur with wooden doors, metal doors, or both? (Try metal doors, might work better.)

    I am told by the author that he fixed it on his end? I have not verified myself.
  19. Offline


    Not had a chance to check this myself, but I've been told it's been sorted out as well. I'll go test it right now, actually.

    Yep, fixed! Thanks for responding though, fluffwah. :3
  20. Offline


    It was only released the other day, and I've been otherwise occupied, though I'm taking care of things here now. :3
    No Lockette update required, as far as I can tell.

    Stopped working how? Is it throwing a permissions error?
    Because of EssentialsGroupManager plugin? You can disable permissions in the config.yml.

    That is an odd one... What version of Lockette are you using?
    Perhaps it is some sort of plugin conflict, but I don't see how it could be happening unless there is a new bug in craftbukkit.
    Unless something is changing the type of blocks asynchronously...
    More info would be useful, such as what other plugins you are using!

    The @ character cannot start a string in a yaml file, put the string within quotes.

    You'll want to change a couple things in the config.yml file too, for snooping. (Enable and set broadcast target.)

    You can disable permissions in the config.yml file, and it will work fine.
    If you want to use with permissions, check that you are giving permission for lockette.user.create.*
    With the .user and the .*, and that you are using version 1.3.7 of Lockette.

    None that I am aware of.

    Negative, reasons stated in the main post, under 'Future'. :3

    What do you mean by correct and incorrect, in the context of Lockette? :3

    The easiest way to fix is to disable the use of permissions in Lockette's config.yml file.
    Otherwise I would have to see your permissions file to sort you out.


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


    There is a glitch with worldguard, if you protect a region, and protect a wooden door inside the region (doesn't apply to iron doors) and add somebody to the door sign but not to the worldguard region when they open the door it will open, but the auto-close feature will not work until you break the door. Is a bit annoying when you want to let somebody into a region but not let them actually edit anything inside (and on a survival world where you cannot spawn items iron is harder to come by). Other than that tiny glitch the plugin is awesome!!!
  22. Offline


    It sounds like a protection conflict to me, can you tell worldguard not to protect doors?
    Does this occur with wooden doors, metal doors, or both? (Try metal doors, might work better.)
    [/quote]just tested with wooden doors and i think i figured out how to fix it, something to do with entity interact protection being on.
  23. Offline


    I have tried to disable Permissions in the config.yml but it doesn't seem to do anything as it still says you do not have permission.

    When I removed Permissions it worked fine, I don't know why it still needs permissions when in the config file it states not to use Permissions.
  24. Offline


    I mean when the sign is placed correctly, color the first line in blue/green. And if there is an error in the syntax like with autoclosing doors, color the first line in red. Eg. "Timmer" instead of "Timer". To color when the sign is fine will be very cool, when it is wrong is just optional. Some of my users ask me is there sign is correctly placed and I want them to see it right on the sign.

    Excuse me for my bad English.
  25. Offline


    How do you make it so only 'Ops' can protect chests?
  26. Offline


    Thank you for this plugin, its brilliant! :)
  27. Offline


    I have permissions and i get a ? on top every time i make a sign.
  28. Offline


    using permissions.
  29. Offline


    Can sweet try what icome did as stated above, and see if this resolves the issue?
    (Aka, turn entity interact protection off, in worldguard.)

    Did you save the file before reloading the server, or using the /lockette reload command?
    In any case Lockette still links to the other plugins for the group features, even if use of permissions is turned off.

    Okay, it is on the future possibilities list, for later. I'll keep your comments in mind.

    If you want to specify in more detail who can do what, you'll want to use permissions nodes.
    Anyone who doesn't have the lockette.user.create.* node won't be able to protect a chest.


    If it is also saying you do not have permission, you either need to turn off the use of permissions in the config.yml, or give yourself the lockette.user.create.* permission in your permission plugin.

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


    Many thanks :).
  31. Offline


    I miss a broadcast-bypass-target setting. Admins opening secured doors are always causing a broadcast, or have i overlooked something?
    knownerror likes this.

Share This Page