[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


    If there is a bug anywhere it's Bukkit, Lockette and Permissions 2 haven't been updated lately so there can be no conflict there
  3. Offline


    I use permissions 1.5, will that be causing the problems? I use it cause its easy to operate
  4. Offline


    Permissions 1.5? Well your support just went out the window mate, update to permissions 2.7.4 and I'll start helping again
  5. Offline


    Hey there,
    I appear to have a glitch on Lockette 1.3.8 where putting signs above a door with [Private] return an error about a conflict with an existing door even when no other doors are in sight. However, placing a sign on the floor next to a door works.
    Just signs above doors that appear to be not working, which I find pretty unusual. :p

    Thanks for the great plugin (=
  6. Offline


    So i'm not 100% sure if its Lockette or IConomyChestShop, but when you break a sign, the sign gives you an infinite amount of signs. Its quite annoying, but i have to do more testing to pin down what exactly it is. I have narrowed it down to a couple plugins that deal with signs though.
  7. Offline


    On CB820 (818 and 819 do not work well with multiworld) door protection will not work if the sign is placed above the door (says conflict with existing protected door), attaching it directly to the door does work though. Are there any builds past 820 that work well with multiworld and work completely with door protection on lockette?
  8. Offline


    I have been told that a change in Minecart Mania is causing this, but that Afforess is looking into fixing.
    See: http://forums.bukkit.org/threads/mech-minecart-mania-1-2-700-818.388/page-277#post-354545
    Edit: I left him a note about why it is happening too. He is doing something naughty~

    Well it is not Lockette alone anyway~
  9. Hi,

    Work very well on my server and a must to have it !

    Just a question ... Did you plan to add protection for traps ? cause it is like doors, we need protected traps.

    Hope so. ;-)
  10. Offline


    If you read the previous page, you would see a reply to that exact question...
  11. Arg ... sorry, i forgot it ! Thx for futur update.
  12. @Acru
    What is the status on protecting/locking hatches?
  13. Offline


    Thanks for the awesome mod! This is just what I needed.
  14. Offline


    when i try placing a [private] over a door it tells me that there was a conflict with an already existing door and a [?] appears on the firs sign please help
  15. Offline


    It's conflicting with the latest minecart mania somehow, I and a few others have the same problem. You can fix it for now by putting your name on the second line underneath [Private].
  16. Offline


  17. Offline


    im not using inecart mania
  18. Offline


    So... the groups permissions for lockette dont seem to work with the permissions 3.1.4

    Anyone else noticed?
  19. Offline


    No change yet, I haven't had the time.
    On the plus side, there will be a new feature as soon as my accepted pull makes it into a recommended build!
    (See: https://github.com/Bukkit/CraftBukkit/pull/331 )

    The protection conflict should only happen if you try to make two protected doors too close together.
    If this is not the case, and its not the issue with MinecartMania, what other plugins are you using?
    If MM isn't changed soon, and if another plugin might be causing this too, I might have to write up a workaround...

    I haven't even touched on the compatibility with 3.x yet.
    Can you tell me in more detail what is working and what is not?
  20. Offline


    Try restarting the server, or putting your name on the second line when placing the sign, that can sometimes make it work (although the latter is when MM is making it bug out)
  21. Offline


    Thank you for that lol I have updated permissions and works well now, I really am great-full for your support, all the best!
  22. I think it just got added, altho not recommended build, but cant be too picky, can we? :p
  23. I have a problem. When i make a sign on a door i can bypass it by using cuboid. Example:

    i have set admin bypass to false and that works but when i use worldedit on the door i can remove it.
    Is this a bug? or is it supposed to happen?
  24. Offline


    How does lockette compare to LWC in performance impact on a server?
  25. Offline


    Thank you! that apparently worked :D
  26. Offline


    WorldEdit is capable of overriding Lockette as it's only designed to stop players accessing chests or passing by doors, other plugins will interfere
    The more protection LWC provided the bigger footprint it has because the database gets bigger and bigger
    Lockette on the other hand will never see a increased performance drain no matter how many protected chests and doors you make
  27. Offline


    So essentially, lockette is optimal?
  28. Offline


    LWC is your best bet if you want greater control as you can manipulate the database and use features that require a database, but for bigger servers Lockette is a better performance option for the above reasons and it's more user friendly as you don't need to mess around with commands

    At the end of the day the only thing I'd install LWC for is if I wanted to add protection to my Tombstones as the Tombstone plugin only supports LWC but the choice is yours
  29. Offline


    Unless WorldEdit adds support for Lockette protection specifically, there is nothing I can do to prevent it.

    From my own view, I would say Lockette is better as it was designed to be infinitely scalable. In Lockette, protection checks run in constant time no matter how many users and locked items that exist in the world, whereas LWC would take more processing for each locked item that exists and probably longer for each user too.

    Incidentally, @Southpaw018 tells me that a Tombstone fork that supports Lockette is nearly done~
  30. Offline


    ^ This is full of WIN, now I can abandon LWC completely
  31. Offline


    Door signs have stopped working for apparently no reason. The only new plugin I recently added was LogBlock.

    When I place a sign above a door it says that nothing loackable is nearby. Old door signs which used to work no longer do anything.

    Chests still work perfectly fine.

    Lokette 1.3.8, CB 818, Permissions 3.1.4 (although it has been working with Permissions 3 perfectly fine, for me)

    Edit: I didn't just upgrade Lockette, I've had this version for a while.

    Edit2: It seems to have magically fixed itself, without a server restart. How odd!

Share This Page