[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


    LWC has a database that tracks every last block that it protects in any way. If you run a server with thousands (or tens of thousands, on very large servers) of chests and protected areas and passworded doors and shared chests and so on and so on....every single time anyone opens one of those things, LWC has to check its database.

    Because of that, it doesn't scale well.

    Lockette has no such limitations.

    It looks like @Acru was last active roughly 5 weeks ago. I'll keep tabs on it and give him some time, and if someone else doesn't get to first (as several others have already volunteered), I'll take up Lockette. My main plugin depends on it, and last I checked, it's in use on over 4,000 servers.
    Justin The Cynical likes this.
  3. Offline


    i literally have tens of thousands of chests locked with this plugin on my server. and the bugs that are cropping up are getting worse. fear in the streets, people panicking. will my stuff stay locked? i look down at them and tell them...

    i just dont know.
    RROD likes this.
  4. Offline


    Better now then what it use to though ;) But yeah it gets bad when you have over 10,000 on hmod over a couple weeks we had over 10,000 lol. Every time people open a chest it lag the server for like 3 secs.
  5. Offline


    They are cached now, I have about 20,000 LWC protections at any given time, and I use /lwc admin expire -remove
    to physically remove chests and there inventories after two weeks of in activity.
  6. Offline


    Well that is good. There is also the displayed sign on the chest seeing who owns what with access and I love the door function also.
    RROD likes this.
  7. Offline


    Lol, to each there own. LWC does double doors as well, has drop transfer to chests, magnet mode, redstone deactivation for doors, protects signs themselves as well as any other blocks you configure it to protect, and has a built in iConomy connector so you can charge. It also has configurable protection limits.

    So basically everything that Lockette does, Plus all of the stuff he was planning on adding, plus some other stuff. All without ugly signs stuck all over everything.:p Ok Im done being a fanboy now.
  8. Offline


    Keep track and if you or you see someone else fork this and keep it going let me know with a poke.
    It's seems like since it went into inactive, everyone all the sudden including myself wants to take it on.
    ewized and Kane like this.
  9. Offline


    Better yet Id love to see a re coding of it. Start fresh use the same system but do some code cleanup. If it is messy like the one developer said.
  10. Offline


    Developer please keep updating this plugin, very useful!
  11. Offline


    I've had trouble with Lockette signs "blanking" on my server and the entire contents of the chests that were blanked are gone. :( Anyone else see this happening? Not sure if it's due to loading a backup, after a server crash or what. Without a database the items are permanently lost!
  12. Offline


    I chose Lockette BECAUSE it has signs which are easy and quick to read.
  13. Offline


    Inactive?!?! Sorry if I am late on saying this, and I have read a bit of what you guys are saying.
    Here's my opinion, Someone PLEASE revive this or start a new plugin just like this from scratch.
    As many of you have stated, this Is an essential plugin for large servers and is very very useful. I would absolutely hate to see this die out. Not to mention that I am wondering how long until I can get a new version as I just ran into a bugand now there seems to be no hope!
    If anyone revives this plugin, please let the rest of us know ASAP. Thanks.
  14. Offline


    I might be able to do something. I mean, LWC is good, but we still use lockette on my Favorite server. The sign wipe bug is the main issue with this plugin ATM. What good is protecting chests with signs if they keep wiping? It just doesn't work well enough anymore. Perhaps something can be done. I'm going to do a bit more research, in the meantime continue playing ;)

    EDIT: Well nobody can really do anything till I get that source code! It's annoying when people don't post it up. There's not even a GitHub for it.
  15. Offline


    The sign wipe bug is fixed in build 1060...just get it!
  16. Offline


    Oh? Why didn't I know that =/
    Anyway, there's still no way I could update this without the source code. I know of decompliers but it not reliable.
  17. Offline


    i had the locketter source,just deleted it a couple of hours ago...:| fail
  18. Offline


    Err, do you know where I can find it?
  19. Offline


    I decompiled it just fine. However as I said before - the code is kinda messy. SO much random crap everywhere that could be condensed with some very simple techniques. Really if you were taking it on seriously you would want to rewrite a lot of it. The config and permission systems are a NIGHTMARE.
  20. Offline


    I'll have a look at taking on this 'clutter'. I sounds like I won't get very far, lol.
    EDIT: Opened it up in JD, and... OMG

    I'm going to have a hard time on my hands. :S
  21. Offline


    First of all that PluginCore crap needs to go :\ I really don't get the purpose of it at all. Then the Permissions system needs reworking. Could implement my permissions system: https://github.com/oliverw92/HawkEye/blob/master/src/uk/co/oliwali/HawkEye/util/Permission.java

    I could always put it up on my GitHub and add anyone who wants to help fix it up onto it?

    Ok just tried decompiling it.. it's an absolute mess. It doesn't decompile properly. Errors EVERYWHERE.

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


    Yeh, I know it's awful. Anyways I've decided to start it all from scratch, litterally. It will contain all the same crap - but updated to work with Bukkit's new built in permissions; and PermissionsBukkit. Oh and PluginCore is obliterated. ;)
    Justin The Cynical and Chromana like this.
  23. Offline


    I advise using a permissions manager like the one i linked from my HawkEye plugin. It makes it VERY easy to add/remove new permissions systems as they come in etc.
  24. Offline


    player.hasPermission("xxx.permission") will do fine. It was made to be a built in system and I don't intend to use any other system. I'm probably not going to be adding any more commands than what is already there anyway.
  25. Offline


    :\ There's no harm in giving people options
  26. Offline


    Unfortunately, there is. Not trying to ding you any way - I'm certain that your intentions are good. While in a perfect world, there wouldn't be any issue, competing standards within our community are harmful by dividing everyone's very limited resources. As a developer, supporting two systems that do the same thing is harder than one. Three is harder than one and two put together....and so on. And, as a server manager, you're forced to pick one and hope that the plugins you like support your preference.

    Now, if we can only get the economies on board...
  27. Offline


    Did you look at the class I linked? Adding support for a permission system takes like 5 lines of code tops.
  28. Offline


    It decompiled with JDGUI fine for me last night.

    Then again, I didnt try to recompile it afterwards.
  29. Offline


    Then try and recompile, you'll get errors.
  30. Offline


    What will be the best way to follow your progress for this? Should I just keep an eye on this thread?

    Edit: Also, one thing to take note of which is a bug in the current version of Lockette:
    You can destroy a locked door by having a piston push into it.
  31. Offline


    Try putting it in an IDE

Share This Page